/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/bzr/dirstate.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2019-10-13 17:31:55 UTC
  • mfrom: (7397.4.9 remove-unused)
  • Revision ID: breezy.the.bot@gmail.com-20191013173155-yoiokny4mknxb3um
Remove Tree.has_id.

Merged from https://code.launchpad.net/~jelmer/brz/remove-unused/+merge/373320

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
20
20
lines by NL. The field delimiters are ommitted in the grammar, line delimiters
21
21
are not - this is done for clarity of reading. All string data is in utf8.
22
22
 
23
 
MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
24
 
NL = "\n";
25
 
NULL = "\0";
26
 
WHOLE_NUMBER = {digit}, digit;
27
 
BOOLEAN = "y" | "n";
28
 
REVISION_ID = a non-empty utf8 string;
29
 
 
30
 
dirstate format = header line, full checksum, row count, parent details,
31
 
 ghost_details, entries;
32
 
header line = "#bazaar dirstate flat format 3", NL;
33
 
full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
34
 
row count = "num_entries: ", WHOLE_NUMBER, NL;
35
 
parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
36
 
ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
37
 
entries = {entry};
38
 
entry = entry_key, current_entry_details, {parent_entry_details};
39
 
entry_key = dirname,  basename, fileid;
40
 
current_entry_details = common_entry_details, working_entry_details;
41
 
parent_entry_details = common_entry_details, history_entry_details;
42
 
common_entry_details = MINIKIND, fingerprint, size, executable
43
 
working_entry_details = packed_stat
44
 
history_entry_details = REVISION_ID;
45
 
executable = BOOLEAN;
46
 
size = WHOLE_NUMBER;
47
 
fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
48
 
 
49
 
Given this definition, the following is useful to know:
50
 
entry (aka row) - all the data for a given key.
51
 
entry[0]: The key (dirname, basename, fileid)
52
 
entry[0][0]: dirname
53
 
entry[0][1]: basename
54
 
entry[0][2]: fileid
55
 
entry[1]: The tree(s) data for this path and id combination.
56
 
entry[1][0]: The current tree
57
 
entry[1][1]: The second tree
58
 
 
59
 
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate:
60
 
entry[1][0][0]: minikind
61
 
entry[1][0][1]: fingerprint
62
 
entry[1][0][2]: size
63
 
entry[1][0][3]: executable
64
 
entry[1][0][4]: packed_stat
65
 
OR (for non tree-0)
66
 
entry[1][1][4]: revision_id
 
23
::
 
24
 
 
25
    MINIKIND = "f" | "d" | "l" | "a" | "r" | "t";
 
26
    NL = "\\n";
 
27
    NULL = "\\0";
 
28
    WHOLE_NUMBER = {digit}, digit;
 
29
    BOOLEAN = "y" | "n";
 
30
    REVISION_ID = a non-empty utf8 string;
 
31
 
 
32
    dirstate format = header line, full checksum, row count, parent details,
 
33
     ghost_details, entries;
 
34
    header line = "#bazaar dirstate flat format 3", NL;
 
35
    full checksum = "crc32: ", ["-"], WHOLE_NUMBER, NL;
 
36
    row count = "num_entries: ", WHOLE_NUMBER, NL;
 
37
    parent_details = WHOLE NUMBER, {REVISION_ID}* NL;
 
38
    ghost_details = WHOLE NUMBER, {REVISION_ID}*, NL;
 
39
    entries = {entry};
 
40
    entry = entry_key, current_entry_details, {parent_entry_details};
 
41
    entry_key = dirname,  basename, fileid;
 
42
    current_entry_details = common_entry_details, working_entry_details;
 
43
    parent_entry_details = common_entry_details, history_entry_details;
 
44
    common_entry_details = MINIKIND, fingerprint, size, executable
 
45
    working_entry_details = packed_stat
 
46
    history_entry_details = REVISION_ID;
 
47
    executable = BOOLEAN;
 
48
    size = WHOLE_NUMBER;
 
49
    fingerprint = a nonempty utf8 sequence with meaning defined by minikind.
 
50
 
 
51
Given this definition, the following is useful to know::
 
52
 
 
53
    entry (aka row) - all the data for a given key.
 
54
    entry[0]: The key (dirname, basename, fileid)
 
55
    entry[0][0]: dirname
 
56
    entry[0][1]: basename
 
57
    entry[0][2]: fileid
 
58
    entry[1]: The tree(s) data for this path and id combination.
 
59
    entry[1][0]: The current tree
 
60
    entry[1][1]: The second tree
 
61
 
 
62
For an entry for a tree, we have (using tree 0 - current tree) to demonstrate::
 
63
 
 
64
    entry[1][0][0]: minikind
 
65
    entry[1][0][1]: fingerprint
 
66
    entry[1][0][2]: size
 
67
    entry[1][0][3]: executable
 
68
    entry[1][0][4]: packed_stat
 
69
 
 
70
OR (for non tree-0)::
 
71
 
 
72
    entry[1][1][4]: revision_id
67
73
 
68
74
There may be multiple rows at the root, one per id present in the root, so the
69
 
in memory root row is now:
70
 
self._dirblocks[0] -> ('', [entry ...]),
71
 
and the entries in there are
72
 
entries[0][0]: ''
73
 
entries[0][1]: ''
74
 
entries[0][2]: file_id
75
 
entries[1][0]: The tree data for the current tree for this fileid at /
76
 
etc.
77
 
 
78
 
Kinds:
79
 
'r' is a relocated entry: This path is not present in this tree with this id,
80
 
    but the id can be found at another location. The fingerprint is used to
81
 
    point to the target location.
82
 
'a' is an absent entry: In that tree the id is not present at this path.
83
 
'd' is a directory entry: This path in this tree is a directory with the
84
 
    current file id. There is no fingerprint for directories.
85
 
'f' is a file entry: As for directory, but it's a file. The fingerprint is the
86
 
    sha1 value of the file's canonical form, i.e. after any read filters have
87
 
    been applied to the convenience form stored in the working tree.
88
 
'l' is a symlink entry: As for directory, but a symlink. The fingerprint is the
89
 
    link target.
90
 
't' is a reference to a nested subtree; the fingerprint is the referenced
91
 
    revision.
 
75
in memory root row is now::
 
76
 
 
77
    self._dirblocks[0] -> ('', [entry ...]),
 
78
 
 
79
and the entries in there are::
 
80
 
 
81
    entries[0][0]: b''
 
82
    entries[0][1]: b''
 
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
   b'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
   b'a' is an absent entry: In that tree the id is not present at this path.
 
93
   b'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
   b'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
   b'l' is a symlink entry: As for directory, but a symlink. The fingerprint is
 
100
        the link target.
 
101
   b'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
 
     root_entrie = (direntry for root, [parent_direntries_for_root]),
 
169
     root_entries = (direntry for root, [parent_direntries_for_root]),
154
170
     dirblocks = [
155
171
     ('', ['data for achild', 'data for bchild', 'data for cchild'])
156
172
     ('dir', ['achild', 'cchild', 'echild'])
167
183
    - What's the risk of error here? Once we have the base format being processed
168
184
      we should have a net win regardless of optimality. So we are going to
169
185
      go with what seems reasonable.
 
186
 
170
187
open questions:
171
188
 
172
189
Maybe we should do a test profile of the core structure - 10K simulated
201
218
 
202
219
"""
203
220
 
 
221
from __future__ import absolute_import
 
222
 
204
223
import bisect
205
 
import binascii
206
224
import errno
207
225
import operator
208
226
import os
209
227
from stat import S_IEXEC
210
228
import stat
211
 
import struct
212
229
import sys
213
230
import time
214
231
import zlib
215
232
 
216
 
from bzrlib import (
 
233
from . import (
 
234
    inventory,
 
235
    )
 
236
from .. import (
217
237
    cache_utf8,
 
238
    cleanup,
 
239
    config,
218
240
    debug,
219
241
    errors,
220
 
    inventory,
221
242
    lock,
222
243
    osutils,
 
244
    static_tuple,
223
245
    trace,
224
 
    )
 
246
    urlutils,
 
247
    )
 
248
from ..sixish import (
 
249
    range,
 
250
    text_type,
 
251
    viewitems,
 
252
    viewvalues,
 
253
    )
 
254
from ..tree import TreeChange
225
255
 
226
256
 
227
257
# This is the Windows equivalent of ENOTDIR
231
261
ERROR_DIRECTORY = 267
232
262
 
233
263
 
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)
 
264
class DirstateCorrupt(errors.BzrError):
 
265
 
 
266
    _fmt = "The dirstate file (%(state)s) appears to be corrupt: %(msg)s"
 
267
 
 
268
    def __init__(self, state, msg):
 
269
        errors.BzrError.__init__(self)
 
270
        self.state = state
 
271
        self.msg = msg
265
272
 
266
273
 
267
274
class SHA1Provider(object):
277
284
 
278
285
    def stat_and_sha1(self, abspath):
279
286
        """Return the stat and sha1 of a file given its absolute path.
280
 
        
 
287
 
281
288
        :param abspath:  May be a filesystem encoded absolute path
282
289
             or a unicode path.
283
290
 
296
303
 
297
304
    def stat_and_sha1(self, abspath):
298
305
        """Return the stat and sha1 of a file given its absolute path."""
299
 
        file_obj = file(abspath, 'rb')
300
 
        try:
 
306
        with open(abspath, 'rb') as file_obj:
301
307
            statvalue = os.fstat(file_obj.fileno())
302
308
            sha1 = osutils.sha_file(file_obj)
303
 
        finally:
304
 
            file_obj.close()
305
309
        return statvalue, sha1
306
310
 
307
311
 
322
326
    """
323
327
 
324
328
    _kind_to_minikind = {
325
 
            'absent': 'a',
326
 
            'file': 'f',
327
 
            'directory': 'd',
328
 
            'relocated': 'r',
329
 
            'symlink': 'l',
330
 
            'tree-reference': 't',
 
329
        'absent': b'a',
 
330
        'file': b'f',
 
331
        'directory': b'd',
 
332
        'relocated': b'r',
 
333
        'symlink': b'l',
 
334
        'tree-reference': b't',
331
335
        }
332
336
    _minikind_to_kind = {
333
 
            'a': 'absent',
334
 
            'f': 'file',
335
 
            'd': 'directory',
336
 
            'l':'symlink',
337
 
            'r': 'relocated',
338
 
            't': 'tree-reference',
 
337
        b'a': 'absent',
 
338
        b'f': 'file',
 
339
        b'd': 'directory',
 
340
        b'l': 'symlink',
 
341
        b'r': 'relocated',
 
342
        b't': 'tree-reference',
339
343
        }
340
344
    _stat_to_minikind = {
341
 
        stat.S_IFDIR:'d',
342
 
        stat.S_IFREG:'f',
343
 
        stat.S_IFLNK:'l',
 
345
        stat.S_IFDIR: b'd',
 
346
        stat.S_IFREG: b'f',
 
347
        stat.S_IFLNK: b'l',
344
348
    }
345
 
    _to_yesno = {True:'y', False: 'n'} # TODO profile the performance gain
346
 
     # of using int conversion rather than a dict here. AND BLAME ANDREW IF
347
 
     # it is faster.
 
349
    _to_yesno = {True: b'y', False: b'n'}  # TODO profile the performance gain
 
350
    # of using int conversion rather than a dict here. AND BLAME ANDREW IF
 
351
    # it is faster.
348
352
 
349
353
    # TODO: jam 20070221 Figure out what to do if we have a record that exceeds
350
354
    #       the BISECT_PAGE_SIZE. For now, we just have to make it large enough
354
358
    NOT_IN_MEMORY = 0
355
359
    IN_MEMORY_UNMODIFIED = 1
356
360
    IN_MEMORY_MODIFIED = 2
 
361
    IN_MEMORY_HASH_MODIFIED = 3  # Only hash-cache updates
357
362
 
358
363
    # A pack_stat (the x's) that is just noise and will never match the output
359
364
    # of base64 encode.
360
 
    NULLSTAT = 'x' * 32
361
 
    NULL_PARENT_DETAILS = ('a', '', 0, False, '')
362
 
 
363
 
    HEADER_FORMAT_2 = '#bazaar dirstate flat format 2\n'
364
 
    HEADER_FORMAT_3 = '#bazaar dirstate flat format 3\n'
365
 
 
366
 
    def __init__(self, path, sha1_provider):
 
365
    NULLSTAT = b'x' * 32
 
366
    NULL_PARENT_DETAILS = static_tuple.StaticTuple(b'a', b'', 0, False, b'')
 
367
 
 
368
    HEADER_FORMAT_2 = b'#bazaar dirstate flat format 2\n'
 
369
    HEADER_FORMAT_3 = b'#bazaar dirstate flat format 3\n'
 
370
 
 
371
    def __init__(self, path, sha1_provider, worth_saving_limit=0,
 
372
                 use_filesystem_for_exec=True):
367
373
        """Create a  DirState object.
368
374
 
369
375
        :param path: The path at which the dirstate file on disk should live.
370
376
        :param sha1_provider: an object meeting the SHA1Provider interface.
 
377
        :param worth_saving_limit: when the exact number of hash changed
 
378
            entries is known, only bother saving the dirstate if more than
 
379
            this count of entries have changed.
 
380
            -1 means never save hash changes, 0 means always save hash changes.
 
381
        :param use_filesystem_for_exec: Whether to trust the filesystem
 
382
            for executable bit information
371
383
        """
372
384
        # _header_state and _dirblock_state represent the current state
373
385
        # of the dirstate metadata and the per-row data respectiely.
410
422
        # during commit.
411
423
        self._last_block_index = None
412
424
        self._last_entry_index = None
 
425
        # The set of known hash changes
 
426
        self._known_hash_changes = set()
 
427
        # How many hash changed entries can we have without saving
 
428
        self._worth_saving_limit = worth_saving_limit
 
429
        self._config_stack = config.LocationStack(urlutils.local_path_to_url(
 
430
            path))
 
431
        self._use_filesystem_for_exec = use_filesystem_for_exec
413
432
 
414
433
    def __repr__(self):
415
434
        return "%s(%r)" % \
416
435
            (self.__class__.__name__, self._filename)
417
436
 
 
437
    def _mark_modified(self, hash_changed_entries=None, header_modified=False):
 
438
        """Mark this dirstate as modified.
 
439
 
 
440
        :param hash_changed_entries: if non-None, mark just these entries as
 
441
            having their hash modified.
 
442
        :param header_modified: mark the header modified as well, not just the
 
443
            dirblocks.
 
444
        """
 
445
        #trace.mutter_callsite(3, "modified hash entries: %s", hash_changed_entries)
 
446
        if hash_changed_entries:
 
447
            self._known_hash_changes.update(
 
448
                [e[0] for e in hash_changed_entries])
 
449
            if self._dirblock_state in (DirState.NOT_IN_MEMORY,
 
450
                                        DirState.IN_MEMORY_UNMODIFIED):
 
451
                # If the dirstate is already marked a IN_MEMORY_MODIFIED, then
 
452
                # that takes precedence.
 
453
                self._dirblock_state = DirState.IN_MEMORY_HASH_MODIFIED
 
454
        else:
 
455
            # TODO: Since we now have a IN_MEMORY_HASH_MODIFIED state, we
 
456
            #       should fail noisily if someone tries to set
 
457
            #       IN_MEMORY_MODIFIED but we don't have a write-lock!
 
458
            # We don't know exactly what changed so disable smart saving
 
459
            self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
460
        if header_modified:
 
461
            self._header_state = DirState.IN_MEMORY_MODIFIED
 
462
 
 
463
    def _mark_unmodified(self):
 
464
        """Mark this dirstate as unmodified."""
 
465
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
 
466
        self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
 
467
        self._known_hash_changes = set()
 
468
 
418
469
    def add(self, path, file_id, kind, stat, fingerprint):
419
470
        """Add a path to be tracked.
420
471
 
421
 
        :param path: The path within the dirstate - '' is the root, 'foo' is the
 
472
        :param path: The path within the dirstate - b'' is the root, 'foo' is the
422
473
            path foo within the root, 'foo/bar' is the path bar within foo
423
474
            within the root.
424
475
        :param file_id: The file id of the path being added.
429
480
            after any read filters have been applied),
430
481
            or the target of a symlink,
431
482
            or the referenced revision id for tree-references,
432
 
            or '' for directories.
 
483
            or b'' for directories.
433
484
        """
434
485
        # adding a file:
435
486
        # find the block its in.
436
487
        # find the location in the block.
437
488
        # check its not there
438
489
        # add it.
439
 
        #------- copied from inventory.ensure_normalized_name - keep synced.
 
490
        # ------- copied from inventory.ensure_normalized_name - keep synced.
440
491
        # --- normalized_filename wants a unicode basename only, so get one.
441
492
        dirname, basename = osutils.split(path)
442
493
        # we dont import normalized_filename directly because we want to be
457
508
        utf8path = (dirname + '/' + basename).strip('/').encode('utf8')
458
509
        dirname, basename = osutils.split(utf8path)
459
510
        # uses __class__ for speed; the check is needed for safety
460
 
        if file_id.__class__ is not str:
 
511
        if file_id.__class__ is not bytes:
461
512
            raise AssertionError(
462
513
                "must be a utf8 file_id not %s" % (type(file_id), ))
463
514
        # Make sure the file_id does not exist in this tree
464
515
        rename_from = None
465
 
        file_id_entry = self._get_entry(0, fileid_utf8=file_id, include_deleted=True)
 
516
        file_id_entry = self._get_entry(
 
517
            0, fileid_utf8=file_id, include_deleted=True)
466
518
        if file_id_entry != (None, None):
467
 
            if file_id_entry[1][0][0] == 'a':
 
519
            if file_id_entry[1][0][0] == b'a':
468
520
                if file_id_entry[0] != (dirname, basename, file_id):
469
521
                    # set the old name's current operation to rename
470
522
                    self.update_minimal(file_id_entry[0],
471
 
                        'r',
472
 
                        path_utf8='',
473
 
                        packed_stat='',
474
 
                        fingerprint=utf8path
475
 
                    )
 
523
                                        b'r',
 
524
                                        path_utf8=b'',
 
525
                                        packed_stat=b'',
 
526
                                        fingerprint=utf8path
 
527
                                        )
476
528
                    rename_from = file_id_entry[0][0:2]
477
529
            else:
478
 
                path = osutils.pathjoin(file_id_entry[0][0], file_id_entry[0][1])
 
530
                path = osutils.pathjoin(
 
531
                    file_id_entry[0][0], file_id_entry[0][1])
479
532
                kind = DirState._minikind_to_kind[file_id_entry[1][0][0]]
480
533
                info = '%s:%s' % (kind, path)
481
534
                raise errors.DuplicateFileId(file_id, info)
482
 
        first_key = (dirname, basename, '')
 
535
        first_key = (dirname, basename, b'')
483
536
        block_index, present = self._find_block_index_from_key(first_key)
484
537
        if present:
485
538
            # check the path is not in the tree
486
539
            block = self._dirblocks[block_index][1]
487
540
            entry_index, _ = self._find_entry_index(first_key, block)
488
541
            while (entry_index < len(block) and
489
 
                block[entry_index][0][0:2] == first_key[0:2]):
490
 
                if block[entry_index][1][0][0] not in 'ar':
 
542
                   block[entry_index][0][0:2] == first_key[0:2]):
 
543
                if block[entry_index][1][0][0] not in (b'a', b'r'):
491
544
                    # this path is in the dirstate in the current tree.
492
 
                    raise Exception, "adding already added path!"
 
545
                    raise Exception("adding already added path!")
493
546
                entry_index += 1
494
547
        else:
495
548
            # The block where we want to put the file is not present. But it
513
566
        minikind = DirState._kind_to_minikind[kind]
514
567
        if rename_from is not None:
515
568
            if rename_from[0]:
516
 
                old_path_utf8 = '%s/%s' % rename_from
 
569
                old_path_utf8 = b'%s/%s' % rename_from
517
570
            else:
518
571
                old_path_utf8 = rename_from[1]
519
 
            parent_info[0] = ('r', old_path_utf8, 0, False, '')
 
572
            parent_info[0] = (b'r', old_path_utf8, 0, False, b'')
520
573
        if kind == 'file':
521
574
            entry_data = entry_key, [
522
575
                (minikind, fingerprint, size, False, packed_stat),
523
576
                ] + parent_info
524
577
        elif kind == 'directory':
525
578
            entry_data = entry_key, [
526
 
                (minikind, '', 0, False, packed_stat),
 
579
                (minikind, b'', 0, False, packed_stat),
527
580
                ] + parent_info
528
581
        elif kind == 'symlink':
529
582
            entry_data = entry_key, [
539
592
        if not present:
540
593
            block.insert(entry_index, entry_data)
541
594
        else:
542
 
            if block[entry_index][1][0][0] != 'a':
543
 
                raise AssertionError(" %r(%r) already added" % (basename, file_id))
 
595
            if block[entry_index][1][0][0] != b'a':
 
596
                raise AssertionError(" %r(%r) already added" %
 
597
                                     (basename, file_id))
544
598
            block[entry_index][1][0] = entry_data[1][0]
545
599
 
546
600
        if kind == 'directory':
547
 
           # insert a new dirblock
548
 
           self._ensure_block(block_index, entry_index, utf8path)
549
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
601
            # insert a new dirblock
 
602
            self._ensure_block(block_index, entry_index, utf8path)
 
603
        self._mark_modified()
550
604
        if self._id_index:
551
 
            self._id_index.setdefault(entry_key[2], set()).add(entry_key)
 
605
            self._add_to_id_index(self._id_index, entry_key)
552
606
 
553
607
    def _bisect(self, paths):
554
608
        """Bisect through the disk structure for specific rows.
566
620
        # there, this function is only meant to handle when we want to read
567
621
        # part of the disk.
568
622
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
569
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
623
            raise AssertionError("bad dirblock state %r" %
 
624
                                 self._dirblock_state)
570
625
 
571
626
        # The disk representation is generally info + '\0\n\0' at the end. But
572
627
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
575
630
        file_size = os.fstat(state_file.fileno()).st_size
576
631
        # We end up with 2 extra fields, we should have a trailing '\n' to
577
632
        # ensure that we read the whole record, and we should have a precursur
578
 
        # '' which ensures that we start after the previous '\n'
 
633
        # b'' which ensures that we start after the previous '\n'
579
634
        entry_field_count = self._fields_per_entry() + 1
580
635
 
581
636
        low = self._end_of_header
582
 
        high = file_size - 1 # Ignore the final '\0'
 
637
        high = file_size - 1  # Ignore the final '\0'
583
638
        # Map from (dir, name) => entry
584
639
        found = {}
585
640
 
586
641
        # Avoid infinite seeking
587
 
        max_count = 30*len(paths)
 
642
        max_count = 30 * len(paths)
588
643
        count = 0
589
644
        # pending is a list of places to look.
590
645
        # each entry is a tuple of low, high, dir_names
609
664
            if count > max_count:
610
665
                raise errors.BzrError('Too many seeks, most likely a bug.')
611
666
 
612
 
            mid = max(low, (low+high-page_size)/2)
 
667
            mid = max(low, (low + high - page_size) // 2)
613
668
 
614
669
            state_file.seek(mid)
615
670
            # limit the read size, so we don't end up reading data that we have
616
671
            # already read.
617
 
            read_size = min(page_size, (high-mid)+1)
 
672
            read_size = min(page_size, (high - mid) + 1)
618
673
            block = state_file.read(read_size)
619
674
 
620
675
            start = mid
621
 
            entries = block.split('\n')
 
676
            entries = block.split(b'\n')
622
677
 
623
678
            if len(entries) < 2:
624
679
                # We didn't find a '\n', so we cannot have found any records.
632
687
            # Check the first and last entries, in case they are partial, or if
633
688
            # we don't care about the rest of this page
634
689
            first_entry_num = 0
635
 
            first_fields = entries[0].split('\0')
 
690
            first_fields = entries[0].split(b'\0')
636
691
            if len(first_fields) < entry_field_count:
637
692
                # We didn't get the complete first entry
638
693
                # so move start, and grab the next, which
639
694
                # should be a full entry
640
 
                start += len(entries[0])+1
641
 
                first_fields = entries[1].split('\0')
 
695
                start += len(entries[0]) + 1
 
696
                first_fields = entries[1].split(b'\0')
642
697
                first_entry_num = 1
643
698
 
644
699
            if len(first_fields) <= 2:
652
707
                # after this first record.
653
708
                after = start
654
709
                if first_fields[1]:
655
 
                    first_path = first_fields[1] + '/' + first_fields[2]
 
710
                    first_path = first_fields[1] + b'/' + first_fields[2]
656
711
                else:
657
712
                    first_path = first_fields[2]
658
713
                first_loc = _bisect_path_left(cur_files, first_path)
667
722
                # We have files after the first entry
668
723
 
669
724
                # Parse the last entry
670
 
                last_entry_num = len(entries)-1
671
 
                last_fields = entries[last_entry_num].split('\0')
 
725
                last_entry_num = len(entries) - 1
 
726
                last_fields = entries[last_entry_num].split(b'\0')
672
727
                if len(last_fields) < entry_field_count:
673
728
                    # The very last hunk was not complete,
674
729
                    # read the previous hunk
675
730
                    after = mid + len(block) - len(entries[-1])
676
731
                    last_entry_num -= 1
677
 
                    last_fields = entries[last_entry_num].split('\0')
 
732
                    last_fields = entries[last_entry_num].split(b'\0')
678
733
                else:
679
734
                    after = mid + len(block)
680
735
 
681
736
                if last_fields[1]:
682
 
                    last_path = last_fields[1] + '/' + last_fields[2]
 
737
                    last_path = last_fields[1] + b'/' + last_fields[2]
683
738
                else:
684
739
                    last_path = last_fields[2]
685
740
                last_loc = _bisect_path_right(post, last_path)
700
755
                        post.insert(0, last_path)
701
756
 
702
757
                    # Find out what paths we have
703
 
                    paths = {first_path:[first_fields]}
 
758
                    paths = {first_path: [first_fields]}
704
759
                    # last_path might == first_path so we need to be
705
760
                    # careful if we should append rather than overwrite
706
761
                    if last_entry_num != first_entry_num:
707
762
                        paths.setdefault(last_path, []).append(last_fields)
708
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
763
                    for num in range(first_entry_num + 1, last_entry_num):
709
764
                        # TODO: jam 20070223 We are already splitting here, so
710
765
                        #       shouldn't we just split the whole thing rather
711
766
                        #       than doing the split again in add_one_record?
712
 
                        fields = entries[num].split('\0')
 
767
                        fields = entries[num].split(b'\0')
713
768
                        if fields[1]:
714
 
                            path = fields[1] + '/' + fields[2]
 
769
                            path = fields[1] + b'/' + fields[2]
715
770
                        else:
716
771
                            path = fields[2]
717
772
                        paths.setdefault(path, []).append(fields)
732
787
            if post:
733
788
                pending.append((after, high, post))
734
789
            if pre:
735
 
                pending.append((low, start-1, pre))
 
790
                pending.append((low, start - 1, pre))
736
791
 
737
792
        # Consider that we may want to return the directory entries in sorted
738
793
        # order. For now, we just return them in whatever order we found them,
759
814
        # there, this function is only meant to handle when we want to read
760
815
        # part of the disk.
761
816
        if self._dirblock_state != DirState.NOT_IN_MEMORY:
762
 
            raise AssertionError("bad dirblock state %r" % self._dirblock_state)
 
817
            raise AssertionError("bad dirblock state %r" %
 
818
                                 self._dirblock_state)
763
819
        # The disk representation is generally info + '\0\n\0' at the end. But
764
820
        # for bisecting, it is easier to treat this as '\0' + info + '\0\n'
765
821
        # Because it means we can sync on the '\n'
767
823
        file_size = os.fstat(state_file.fileno()).st_size
768
824
        # We end up with 2 extra fields, we should have a trailing '\n' to
769
825
        # ensure that we read the whole record, and we should have a precursur
770
 
        # '' which ensures that we start after the previous '\n'
 
826
        # b'' which ensures that we start after the previous '\n'
771
827
        entry_field_count = self._fields_per_entry() + 1
772
828
 
773
829
        low = self._end_of_header
774
 
        high = file_size - 1 # Ignore the final '\0'
 
830
        high = file_size - 1  # Ignore the final '\0'
775
831
        # Map from dir => entry
776
832
        found = {}
777
833
 
778
834
        # Avoid infinite seeking
779
 
        max_count = 30*len(dir_list)
 
835
        max_count = 30 * len(dir_list)
780
836
        count = 0
781
837
        # pending is a list of places to look.
782
838
        # each entry is a tuple of low, high, dir_names
801
857
            if count > max_count:
802
858
                raise errors.BzrError('Too many seeks, most likely a bug.')
803
859
 
804
 
            mid = max(low, (low+high-page_size)/2)
 
860
            mid = max(low, (low + high - page_size) // 2)
805
861
 
806
862
            state_file.seek(mid)
807
863
            # limit the read size, so we don't end up reading data that we have
808
864
            # already read.
809
 
            read_size = min(page_size, (high-mid)+1)
 
865
            read_size = min(page_size, (high - mid) + 1)
810
866
            block = state_file.read(read_size)
811
867
 
812
868
            start = mid
813
 
            entries = block.split('\n')
 
869
            entries = block.split(b'\n')
814
870
 
815
871
            if len(entries) < 2:
816
872
                # We didn't find a '\n', so we cannot have found any records.
824
880
            # Check the first and last entries, in case they are partial, or if
825
881
            # we don't care about the rest of this page
826
882
            first_entry_num = 0
827
 
            first_fields = entries[0].split('\0')
 
883
            first_fields = entries[0].split(b'\0')
828
884
            if len(first_fields) < entry_field_count:
829
885
                # We didn't get the complete first entry
830
886
                # so move start, and grab the next, which
831
887
                # should be a full entry
832
 
                start += len(entries[0])+1
833
 
                first_fields = entries[1].split('\0')
 
888
                start += len(entries[0]) + 1
 
889
                first_fields = entries[1].split(b'\0')
834
890
                first_entry_num = 1
835
891
 
836
892
            if len(first_fields) <= 1:
856
912
                # We have records to look at after the first entry
857
913
 
858
914
                # Parse the last entry
859
 
                last_entry_num = len(entries)-1
860
 
                last_fields = entries[last_entry_num].split('\0')
 
915
                last_entry_num = len(entries) - 1
 
916
                last_fields = entries[last_entry_num].split(b'\0')
861
917
                if len(last_fields) < entry_field_count:
862
918
                    # The very last hunk was not complete,
863
919
                    # read the previous hunk
864
920
                    after = mid + len(block) - len(entries[-1])
865
921
                    last_entry_num -= 1
866
 
                    last_fields = entries[last_entry_num].split('\0')
 
922
                    last_fields = entries[last_entry_num].split(b'\0')
867
923
                else:
868
924
                    after = mid + len(block)
869
925
 
886
942
                        post.insert(0, last_dir)
887
943
 
888
944
                    # Find out what paths we have
889
 
                    paths = {first_dir:[first_fields]}
 
945
                    paths = {first_dir: [first_fields]}
890
946
                    # last_dir might == first_dir so we need to be
891
947
                    # careful if we should append rather than overwrite
892
948
                    if last_entry_num != first_entry_num:
893
949
                        paths.setdefault(last_dir, []).append(last_fields)
894
 
                    for num in xrange(first_entry_num+1, last_entry_num):
 
950
                    for num in range(first_entry_num + 1, last_entry_num):
895
951
                        # TODO: jam 20070223 We are already splitting here, so
896
952
                        #       shouldn't we just split the whole thing rather
897
953
                        #       than doing the split again in add_one_record?
898
 
                        fields = entries[num].split('\0')
 
954
                        fields = entries[num].split(b'\0')
899
955
                        paths.setdefault(fields[1], []).append(fields)
900
956
 
901
957
                    for cur_dir in middle_files:
914
970
            if post:
915
971
                pending.append((after, high, post))
916
972
            if pre:
917
 
                pending.append((low, start-1, pre))
 
973
                pending.append((low, start - 1, pre))
918
974
 
919
975
        return found
920
976
 
926
982
        directories. (and renames?)
927
983
 
928
984
        :param paths: A sorted list of (dir, name) pairs
929
 
             eg: [('', 'a'), ('', 'f'), ('a/b', 'c')]
 
985
             eg: [('', b'a'), ('', b'f'), ('a/b', b'c')]
930
986
        :return: A dictionary mapping (dir, name, file_id) => [tree_info]
931
987
        """
932
988
        # Map from (dir, name, file_id) => [tree_info]
943
999
            # Directories that need to be read
944
1000
            pending_dirs = set()
945
1001
            paths_to_search = set()
946
 
            for entry_list in newly_found.itervalues():
 
1002
            for entry_list in viewvalues(newly_found):
947
1003
                for dir_name_id, trees_info in entry_list:
948
1004
                    found[dir_name_id] = trees_info
949
1005
                    found_dir_names.add(dir_name_id[:2])
950
1006
                    is_dir = False
951
1007
                    for tree_info in trees_info:
952
1008
                        minikind = tree_info[0]
953
 
                        if minikind == 'd':
 
1009
                        if minikind == b'd':
954
1010
                            if is_dir:
955
1011
                                # We already processed this one as a directory,
956
1012
                                # we don't need to do the extra work again.
960
1016
                            is_dir = True
961
1017
                            if path not in processed_dirs:
962
1018
                                pending_dirs.add(path)
963
 
                        elif minikind == 'r':
 
1019
                        elif minikind == b'r':
964
1020
                            # Rename, we need to directly search the target
965
1021
                            # which is contained in the fingerprint column
966
1022
                            dir_name = osutils.split(tree_info[1])
993
1049
            return
994
1050
        # only require all dirblocks if we are doing a full-pass removal.
995
1051
        self._read_dirblocks_if_needed()
996
 
        dead_patterns = set([('a', 'r'), ('a', 'a'), ('r', 'r'), ('r', 'a')])
 
1052
        dead_patterns = {(b'a', b'r'), (b'a', b'a'),
 
1053
                         (b'r', b'r'), (b'r', b'a')}
 
1054
 
997
1055
        def iter_entries_removable():
998
1056
            for block in self._dirblocks:
999
1057
                deleted_positions = []
1018
1076
 
1019
1077
        self._ghosts = []
1020
1078
        self._parents = [parents[0]]
1021
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1022
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1079
        self._mark_modified(header_modified=True)
1023
1080
 
1024
1081
    def _empty_parent_info(self):
1025
1082
        return [DirState.NULL_PARENT_DETAILS] * (len(self._parents) -
1026
 
                                                    len(self._ghosts))
 
1083
                                                 len(self._ghosts))
1027
1084
 
1028
1085
    def _ensure_block(self, parent_block_index, parent_row_index, dirname):
1029
1086
        """Ensure a block for dirname exists.
1045
1102
        :param dirname: The utf8 dirname to ensure there is a block for.
1046
1103
        :return: The index for the block.
1047
1104
        """
1048
 
        if dirname == '' and parent_row_index == 0 and parent_block_index == 0:
 
1105
        if dirname == b'' and parent_row_index == 0 and parent_block_index == 0:
1049
1106
            # This is the signature of the root row, and the
1050
1107
            # contents-of-root row is always index 1
1051
1108
            return 1
1052
1109
        # the basename of the directory must be the end of its full name.
1053
1110
        if not (parent_block_index == -1 and
1054
 
            parent_block_index == -1 and dirname == ''):
 
1111
                parent_block_index == -1 and dirname == b''):
1055
1112
            if not dirname.endswith(
1056
1113
                    self._dirblocks[parent_block_index][1][parent_row_index][0][1]):
1057
1114
                raise AssertionError("bad dirname %r" % dirname)
1058
 
        block_index, present = self._find_block_index_from_key((dirname, '', ''))
 
1115
        block_index, present = self._find_block_index_from_key(
 
1116
            (dirname, b'', b''))
1059
1117
        if not present:
1060
 
            ## In future, when doing partial parsing, this should load and
 
1118
            # In future, when doing partial parsing, this should load and
1061
1119
            # populate the entire block.
1062
1120
            self._dirblocks.insert(block_index, (dirname, []))
1063
1121
        return block_index
1072
1130
            to prevent unneeded overhead when callers have a sorted list already.
1073
1131
        :return: Nothing.
1074
1132
        """
1075
 
        if new_entries[0][0][0:2] != ('', ''):
 
1133
        if new_entries[0][0][0:2] != (b'', b''):
1076
1134
            raise AssertionError(
1077
1135
                "Missing root row %r" % (new_entries[0][0],))
1078
1136
        # The two blocks here are deliberate: the root block and the
1079
1137
        # contents-of-root block.
1080
 
        self._dirblocks = [('', []), ('', [])]
 
1138
        self._dirblocks = [(b'', []), (b'', [])]
1081
1139
        current_block = self._dirblocks[0][1]
1082
 
        current_dirname = ''
1083
 
        root_key = ('', '')
 
1140
        current_dirname = b''
 
1141
        root_key = (b'', b'')
1084
1142
        append_entry = current_block.append
1085
1143
        for entry in new_entries:
1086
1144
            if entry[0][0] != current_dirname:
1102
1160
        # The above loop leaves the "root block" entries mixed with the
1103
1161
        # "contents-of-root block". But we don't want an if check on
1104
1162
        # all entries, so instead we just fix it up here.
1105
 
        if self._dirblocks[1] != ('', []):
 
1163
        if self._dirblocks[1] != (b'', []):
1106
1164
            raise ValueError("bad dirblock start %r" % (self._dirblocks[1],))
1107
1165
        root_block = []
1108
1166
        contents_of_root_block = []
1109
1167
        for entry in self._dirblocks[0][1]:
1110
 
            if not entry[0][1]: # This is a root entry
 
1168
            if not entry[0][1]:  # This is a root entry
1111
1169
                root_block.append(entry)
1112
1170
            else:
1113
1171
                contents_of_root_block.append(entry)
1114
 
        self._dirblocks[0] = ('', root_block)
1115
 
        self._dirblocks[1] = ('', contents_of_root_block)
 
1172
        self._dirblocks[0] = (b'', root_block)
 
1173
        self._dirblocks[1] = (b'', contents_of_root_block)
1116
1174
 
1117
1175
    def _entries_for_path(self, path):
1118
1176
        """Return a list with all the entries that match path for all ids."""
1119
1177
        dirname, basename = os.path.split(path)
1120
 
        key = (dirname, basename, '')
 
1178
        key = (dirname, basename, b'')
1121
1179
        block_index, present = self._find_block_index_from_key(key)
1122
1180
        if not present:
1123
1181
            # the block which should contain path is absent.
1127
1185
        entry_index, _ = self._find_entry_index(key, block)
1128
1186
        # we may need to look at multiple entries at this path: walk while the specific_files match.
1129
1187
        while (entry_index < len(block) and
1130
 
            block[entry_index][0][0:2] == key[0:2]):
 
1188
               block[entry_index][0][0:2] == key[0:2]):
1131
1189
            result.append(block[entry_index])
1132
1190
            entry_index += 1
1133
1191
        return result
1146
1204
            # minikind
1147
1205
            entire_entry[tree_offset + 0] = tree_data[0]
1148
1206
            # size
1149
 
            entire_entry[tree_offset + 2] = str(tree_data[2])
 
1207
            entire_entry[tree_offset + 2] = b'%d' % tree_data[2]
1150
1208
            # executable
1151
1209
            entire_entry[tree_offset + 3] = DirState._to_yesno[tree_data[3]]
1152
 
        return '\0'.join(entire_entry)
 
1210
        return b'\0'.join(entire_entry)
1153
1211
 
1154
1212
    def _fields_per_entry(self):
1155
1213
        """How many null separated fields should be in each entry row.
1156
1214
 
1157
 
        Each line now has an extra '\n' field which is not used
 
1215
        Each line now has an extra '\\n' field which is not used
1158
1216
        so we just skip over it
1159
 
        entry size:
 
1217
 
 
1218
        entry size::
1160
1219
            3 fields for the key
1161
1220
            + number of fields per tree_data (5) * tree count
1162
1221
            + newline
1191
1250
 
1192
1251
        :return: The block index, True if the block for the key is present.
1193
1252
        """
1194
 
        if key[0:2] == ('', ''):
 
1253
        if key[0:2] == (b'', b''):
1195
1254
            return 0, True
1196
1255
        try:
1197
1256
            if (self._last_block_index is not None and
1198
 
                self._dirblocks[self._last_block_index][0] == key[0]):
 
1257
                    self._dirblocks[self._last_block_index][0] == key[0]):
1199
1258
                return self._last_block_index, True
1200
1259
        except IndexError:
1201
1260
            pass
1203
1262
                                      cache=self._split_path_cache)
1204
1263
        # _right returns one-past-where-key is so we have to subtract
1205
1264
        # one to use it. we use _right here because there are two
1206
 
        # '' blocks - the root, and the contents of root
 
1265
        # b'' blocks - the root, and the contents of root
1207
1266
        # we always have a minimum of 2 in self._dirblocks: root and
1208
 
        # root-contents, and for '', we get 2 back, so this is
 
1267
        # root-contents, and for b'', we get 2 back, so this is
1209
1268
        # simple and correct:
1210
1269
        present = (block_index < len(self._dirblocks) and
1211
 
            self._dirblocks[block_index][0] == key[0])
 
1270
                   self._dirblocks[block_index][0] == key[0])
1212
1271
        self._last_block_index = block_index
1213
1272
        # Reset the entry index cache to the beginning of the block.
1214
1273
        self._last_entry_index = -1
1227
1286
                # A hit is when the key is after the last slot, and before or
1228
1287
                # equal to the next slot.
1229
1288
                if ((entry_index > 0 and block[entry_index - 1][0] < key) and
1230
 
                    key <= block[entry_index][0]):
 
1289
                        key <= block[entry_index][0]):
1231
1290
                    self._last_entry_index = entry_index
1232
1291
                    present = (block[entry_index][0] == key)
1233
1292
                    return entry_index, present
1235
1294
            pass
1236
1295
        entry_index = bisect.bisect_left(block, (key, []))
1237
1296
        present = (entry_index < len_block and
1238
 
            block[entry_index][0] == key)
 
1297
                   block[entry_index][0] == key)
1239
1298
        self._last_entry_index = entry_index
1240
1299
        return entry_index, present
1241
1300
 
1251
1310
            (it was locked by DirState.initialize)
1252
1311
        """
1253
1312
        result = DirState.initialize(dir_state_filename,
1254
 
            sha1_provider=sha1_provider)
 
1313
                                     sha1_provider=sha1_provider)
1255
1314
        try:
1256
 
            tree.lock_read()
1257
 
            try:
 
1315
            with cleanup.ExitStack() as exit_stack:
 
1316
                exit_stack.enter_context(tree.lock_read())
1258
1317
                parent_ids = tree.get_parent_ids()
1259
1318
                num_parents = len(parent_ids)
1260
1319
                parent_trees = []
1261
1320
                for parent_id in parent_ids:
1262
 
                    parent_tree = tree.branch.repository.revision_tree(parent_id)
 
1321
                    parent_tree = tree.branch.repository.revision_tree(
 
1322
                        parent_id)
1263
1323
                    parent_trees.append((parent_id, parent_tree))
1264
 
                    parent_tree.lock_read()
 
1324
                    exit_stack.enter_context(parent_tree.lock_read())
1265
1325
                result.set_parent_trees(parent_trees, [])
1266
 
                result.set_state_from_inventory(tree.inventory)
1267
 
            finally:
1268
 
                for revid, parent_tree in parent_trees:
1269
 
                    parent_tree.unlock()
1270
 
                tree.unlock()
 
1326
                result.set_state_from_inventory(tree.root_inventory)
1271
1327
        except:
1272
1328
            # The caller won't have a chance to unlock this, so make sure we
1273
1329
            # cleanup ourselves
1275
1331
            raise
1276
1332
        return result
1277
1333
 
 
1334
    def _check_delta_is_valid(self, delta):
 
1335
        delta = list(inventory._check_delta_unique_ids(
 
1336
                     inventory._check_delta_unique_old_paths(
 
1337
                         inventory._check_delta_unique_new_paths(
 
1338
                             inventory._check_delta_ids_match_entry(
 
1339
                                 inventory._check_delta_ids_are_valid(
 
1340
                                     inventory._check_delta_new_path_entry_both_or_None(delta)))))))
 
1341
 
 
1342
        def delta_key(d):
 
1343
            (old_path, new_path, file_id, new_entry) = d
 
1344
            if old_path is None:
 
1345
                old_path = ''
 
1346
            if new_path is None:
 
1347
                new_path = ''
 
1348
            return (old_path, new_path, file_id, new_entry)
 
1349
        delta.sort(key=delta_key, reverse=True)
 
1350
        return delta
 
1351
 
1278
1352
    def update_by_delta(self, delta):
1279
1353
        """Apply an inventory delta to the dirstate for tree 0
1280
1354
 
1298
1372
        new_ids = set()
1299
1373
        # This loop transforms the delta to single atomic operations that can
1300
1374
        # 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):
 
1375
        delta = self._check_delta_is_valid(delta)
 
1376
        for old_path, new_path, file_id, inv_entry in delta:
 
1377
            if not isinstance(file_id, bytes):
 
1378
                raise AssertionError(
 
1379
                    "must be a utf8 file_id not %s" % (type(file_id), ))
1308
1380
            if (file_id in insertions) or (file_id in removals):
1309
 
                raise errors.InconsistentDelta(old_path or new_path, file_id,
1310
 
                    "repeated file_id")
 
1381
                self._raise_invalid(old_path or new_path, file_id,
 
1382
                                    "repeated file_id")
1311
1383
            if old_path is not None:
1312
1384
                old_path = old_path.encode('utf-8')
1313
1385
                removals[file_id] = old_path
1315
1387
                new_ids.add(file_id)
1316
1388
            if new_path is not None:
1317
1389
                if inv_entry is None:
1318
 
                    raise errors.InconsistentDelta(new_path, file_id,
1319
 
                        "new_path with no entry")
 
1390
                    self._raise_invalid(new_path, file_id,
 
1391
                                        "new_path with no entry")
1320
1392
                new_path = new_path.encode('utf-8')
1321
1393
                dirname_utf8, basename = osutils.split(new_path)
1322
1394
                if basename:
1323
1395
                    parents.add((dirname_utf8, inv_entry.parent_id))
1324
1396
                key = (dirname_utf8, basename, file_id)
1325
1397
                minikind = DirState._kind_to_minikind[inv_entry.kind]
1326
 
                if minikind == 't':
1327
 
                    fingerprint = inv_entry.reference_revision or ''
 
1398
                if minikind == b't':
 
1399
                    fingerprint = inv_entry.reference_revision or b''
1328
1400
                else:
1329
 
                    fingerprint = ''
 
1401
                    fingerprint = b''
1330
1402
                insertions[file_id] = (key, minikind, inv_entry.executable,
1331
1403
                                       fingerprint, new_path)
1332
1404
            # Transform moves into delete+add pairs
1351
1423
                                               fingerprint, new_child_path)
1352
1424
        self._check_delta_ids_absent(new_ids, delta, 0)
1353
1425
        try:
1354
 
            self._apply_removals(removals.iteritems())
1355
 
            self._apply_insertions(insertions.values())
 
1426
            self._apply_removals(viewitems(removals))
 
1427
            self._apply_insertions(viewvalues(insertions))
1356
1428
            # Validate parents
1357
1429
            self._after_delta_check_parents(parents, 0)
1358
 
        except errors.BzrError, e:
 
1430
        except errors.BzrError as e:
1359
1431
            self._changes_aborted = True
1360
1432
            if 'integrity error' not in str(e):
1361
1433
                raise
1362
1434
            # _get_entry raises BzrError when a request is inconsistent; we
1363
 
            # want such errors to be shown as InconsistentDelta - and that 
 
1435
            # want such errors to be shown as InconsistentDelta - and that
1364
1436
            # fits the behaviour we trigger.
1365
 
            raise errors.InconsistentDeltaDelta(delta, "error from _get_entry.")
 
1437
            raise errors.InconsistentDeltaDelta(delta,
 
1438
                                                "error from _get_entry. %s" % (e,))
1366
1439
 
1367
1440
    def _apply_removals(self, removals):
1368
1441
        for file_id, path in sorted(removals, reverse=True,
1369
 
            key=operator.itemgetter(1)):
 
1442
                                    key=operator.itemgetter(1)):
1370
1443
            dirname, basename = osutils.split(path)
1371
1444
            block_i, entry_i, d_present, f_present = \
1372
1445
                self._get_block_entry_index(dirname, basename, 0)
1373
1446
            try:
1374
1447
                entry = self._dirblocks[block_i][1][entry_i]
1375
1448
            except IndexError:
1376
 
                self._changes_aborted = True
1377
 
                raise errors.InconsistentDelta(path, file_id,
1378
 
                    "Wrong path for old path.")
1379
 
            if not f_present or entry[1][0][0] in 'ar':
1380
 
                self._changes_aborted = True
1381
 
                raise errors.InconsistentDelta(path, file_id,
1382
 
                    "Wrong path for old path.")
 
1449
                self._raise_invalid(path, file_id,
 
1450
                                    "Wrong path for old path.")
 
1451
            if not f_present or entry[1][0][0] in (b'a', b'r'):
 
1452
                self._raise_invalid(path, file_id,
 
1453
                                    "Wrong path for old path.")
1383
1454
            if file_id != entry[0][2]:
1384
 
                self._changes_aborted = True
1385
 
                raise errors.InconsistentDelta(path, file_id,
1386
 
                    "Attempt to remove path has wrong id - found %r."
1387
 
                    % entry[0][2])
 
1455
                self._raise_invalid(path, file_id,
 
1456
                                    "Attempt to remove path has wrong id - found %r."
 
1457
                                    % entry[0][2])
1388
1458
            self._make_absent(entry)
1389
1459
            # See if we have a malformed delta: deleting a directory must not
1390
1460
            # leave crud behind. This increases the number of bisects needed
1392
1462
            # is rare enough it shouldn't be an issue (famous last words?) RBC
1393
1463
            # 20080730.
1394
1464
            block_i, entry_i, d_present, f_present = \
1395
 
                self._get_block_entry_index(path, '', 0)
 
1465
                self._get_block_entry_index(path, b'', 0)
1396
1466
            if d_present:
1397
1467
                # The dir block is still present in the dirstate; this could
1398
1468
                # be due to it being in a parent tree, or a corrupt delta.
1399
1469
                for child_entry in self._dirblocks[block_i][1]:
1400
 
                    if child_entry[1][0][0] not in ('r', 'a'):
1401
 
                        self._changes_aborted = True
1402
 
                        raise errors.InconsistentDelta(path, entry[0][2],
1403
 
                            "The file id was deleted but its children were "
1404
 
                            "not deleted.")
 
1470
                    if child_entry[1][0][0] not in (b'r', b'a'):
 
1471
                        self._raise_invalid(path, entry[0][2],
 
1472
                                            "The file id was deleted but its children were "
 
1473
                                            "not deleted.")
1405
1474
 
1406
1475
    def _apply_insertions(self, adds):
1407
1476
        try:
1409
1478
                self.update_minimal(key, minikind, executable, fingerprint,
1410
1479
                                    path_utf8=path_utf8)
1411
1480
        except errors.NotVersionedError:
1412
 
            self._changes_aborted = True
1413
 
            raise errors.InconsistentDelta(path_utf8.decode('utf8'), key[2],
1414
 
                "Missing parent")
 
1481
            self._raise_invalid(path_utf8.decode('utf8'), key[2],
 
1482
                                "Missing parent")
1415
1483
 
1416
1484
    def update_basis_by_delta(self, delta, new_revid):
1417
1485
        """Update the parents of this tree after a commit.
1424
1492
        Note that an exception during the operation of this method will leave
1425
1493
        the dirstate in a corrupt state where it should not be saved.
1426
1494
 
1427
 
        Finally, we expect all changes to be synchronising the basis tree with
1428
 
        the working tree.
1429
 
 
1430
1495
        :param new_revid: The new revision id for the trees parent.
1431
1496
        :param delta: An inventory delta (see apply_inventory_delta) describing
1432
1497
            the changes from the current left most parent revision to new_revid.
1444
1509
 
1445
1510
        self._parents[0] = new_revid
1446
1511
 
1447
 
        delta = sorted(delta, reverse=True)
 
1512
        delta = self._check_delta_is_valid(delta)
1448
1513
        adds = []
1449
1514
        changes = []
1450
1515
        deletes = []
1470
1535
        # ids.
1471
1536
        new_ids = set()
1472
1537
        for old_path, new_path, file_id, inv_entry in delta:
 
1538
            if file_id.__class__ is not bytes:
 
1539
                raise AssertionError(
 
1540
                    "must be a utf8 file_id not %s" % (type(file_id), ))
1473
1541
            if inv_entry is not None and file_id != inv_entry.file_id:
1474
 
                raise errors.InconsistentDelta(new_path, file_id,
1475
 
                    "mismatched entry file_id %r" % inv_entry)
1476
 
            if new_path is not None:
 
1542
                self._raise_invalid(new_path, file_id,
 
1543
                                    "mismatched entry file_id %r" % inv_entry)
 
1544
            if new_path is None:
 
1545
                new_path_utf8 = None
 
1546
            else:
1477
1547
                if inv_entry is None:
1478
 
                    raise errors.InconsistentDelta(new_path, file_id,
1479
 
                        "new_path with no entry")
 
1548
                    self._raise_invalid(new_path, file_id,
 
1549
                                        "new_path with no entry")
1480
1550
                new_path_utf8 = encode(new_path)
1481
1551
                # note the parent for validation
1482
1552
                dirname_utf8, basename_utf8 = osutils.split(new_path_utf8)
1483
1553
                if basename_utf8:
1484
1554
                    parents.add((dirname_utf8, inv_entry.parent_id))
1485
1555
            if old_path is None:
1486
 
                adds.append((None, encode(new_path), file_id,
1487
 
                    inv_to_entry(inv_entry), True))
 
1556
                old_path_utf8 = None
 
1557
            else:
 
1558
                old_path_utf8 = encode(old_path)
 
1559
            if old_path is None:
 
1560
                adds.append((None, new_path_utf8, file_id,
 
1561
                             inv_to_entry(inv_entry), True))
1488
1562
                new_ids.add(file_id)
1489
1563
            elif new_path is None:
1490
 
                deletes.append((encode(old_path), None, file_id, None, True))
1491
 
            elif (old_path, new_path) != root_only:
 
1564
                deletes.append((old_path_utf8, None, file_id, None, True))
 
1565
            elif (old_path, new_path) == root_only:
 
1566
                # change things in-place
 
1567
                # Note: the case of a parent directory changing its file_id
 
1568
                #       tends to break optimizations here, because officially
 
1569
                #       the file has actually been moved, it just happens to
 
1570
                #       end up at the same path. If we can figure out how to
 
1571
                #       handle that case, we can avoid a lot of add+delete
 
1572
                #       pairs for objects that stay put.
 
1573
                # elif old_path == new_path:
 
1574
                changes.append((old_path_utf8, new_path_utf8, file_id,
 
1575
                                inv_to_entry(inv_entry)))
 
1576
            else:
1492
1577
                # Renames:
1493
1578
                # Because renames must preserve their children we must have
1494
1579
                # processed all relocations and removes before hand. The sort
1497
1582
                # pair will result in the deleted item being reinserted, or
1498
1583
                # renamed items being reinserted twice - and possibly at the
1499
1584
                # wrong place. Splitting into a delete/add pair also simplifies
1500
 
                # the handling of entries with ('f', ...), ('r' ...) because
1501
 
                # the target of the 'r' is old_path here, and we add that to
 
1585
                # the handling of entries with (b'f', ...), (b'r' ...) because
 
1586
                # the target of the b'r' is old_path here, and we add that to
1502
1587
                # deletes, meaning that the add handler does not need to check
1503
 
                # for 'r' items on every pass.
 
1588
                # for b'r' items on every pass.
1504
1589
                self._update_basis_apply_deletes(deletes)
1505
1590
                deletes = []
1506
1591
                # Split into an add/delete pair recursively.
1507
 
                adds.append((None, new_path_utf8, file_id,
1508
 
                    inv_to_entry(inv_entry), False))
 
1592
                adds.append((old_path_utf8, new_path_utf8, file_id,
 
1593
                             inv_to_entry(inv_entry), False))
1509
1594
                # Expunge deletes that we've seen so that deleted/renamed
1510
1595
                # children of a rename directory are handled correctly.
1511
 
                new_deletes = reversed(list(self._iter_child_entries(1,
1512
 
                    encode(old_path))))
 
1596
                new_deletes = reversed(list(
 
1597
                    self._iter_child_entries(1, old_path_utf8)))
1513
1598
                # Remove the current contents of the tree at orig_path, and
1514
1599
                # reinsert at the correct new path.
1515
1600
                for entry in new_deletes:
1516
 
                    if entry[0][0]:
1517
 
                        source_path = entry[0][0] + '/' + entry[0][1]
 
1601
                    child_dirname, child_basename, child_file_id = entry[0]
 
1602
                    if child_dirname:
 
1603
                        source_path = child_dirname + b'/' + child_basename
1518
1604
                    else:
1519
 
                        source_path = entry[0][1]
 
1605
                        source_path = child_basename
1520
1606
                    if new_path_utf8:
1521
 
                        target_path = new_path_utf8 + source_path[len(old_path):]
 
1607
                        target_path = \
 
1608
                            new_path_utf8 + source_path[len(old_path_utf8):]
1522
1609
                    else:
1523
 
                        if old_path == '':
 
1610
                        if old_path_utf8 == b'':
1524
1611
                            raise AssertionError("cannot rename directory to"
1525
 
                                " itself")
1526
 
                        target_path = source_path[len(old_path) + 1:]
1527
 
                    adds.append((None, target_path, entry[0][2], entry[1][1], False))
 
1612
                                                 " itself")
 
1613
                        target_path = source_path[len(old_path_utf8) + 1:]
 
1614
                    adds.append(
 
1615
                        (None, target_path, entry[0][2], entry[1][1], False))
1528
1616
                    deletes.append(
1529
1617
                        (source_path, target_path, entry[0][2], None, False))
1530
1618
                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)))
 
1619
                    (old_path_utf8, new_path_utf8, file_id, None, False))
 
1620
 
1537
1621
        self._check_delta_ids_absent(new_ids, delta, 1)
1538
1622
        try:
1539
1623
            # Finish expunging deletes/first half of renames.
1544
1628
            self._update_basis_apply_changes(changes)
1545
1629
            # Validate parents
1546
1630
            self._after_delta_check_parents(parents, 1)
1547
 
        except errors.BzrError, e:
 
1631
        except errors.BzrError as e:
1548
1632
            self._changes_aborted = True
1549
1633
            if 'integrity error' not in str(e):
1550
1634
                raise
1551
1635
            # _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.")
 
1636
            # want such errors to be shown as InconsistentDelta - and that
 
1637
            # fits the behaviour we trigger.
 
1638
            raise errors.InconsistentDeltaDelta(delta,
 
1639
                                                "error from _get_entry. %s" % (e,))
1557
1640
 
1558
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
1559
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
 
1641
        self._mark_modified(header_modified=True)
1560
1642
        self._id_index = None
1561
1643
        return
1562
1644
 
1566
1648
            return
1567
1649
        id_index = self._get_id_index()
1568
1650
        for file_id in new_ids:
1569
 
            for key in id_index.get(file_id, []):
 
1651
            for key in id_index.get(file_id, ()):
1570
1652
                block_i, entry_i, d_present, f_present = \
1571
1653
                    self._get_block_entry_index(key[0], key[1], tree_index)
1572
1654
                if not f_present:
1576
1658
                if entry[0][2] != file_id:
1577
1659
                    # Different file_id, so not what we want.
1578
1660
                    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,
1583
 
                    "This file_id is new in the delta but already present in "
1584
 
                    "the target")
 
1661
                self._raise_invalid((b"%s/%s" % key[0:2]).decode('utf8'), file_id,
 
1662
                                    "This file_id is new in the delta but already present in "
 
1663
                                    "the target")
 
1664
 
 
1665
    def _raise_invalid(self, path, file_id, reason):
 
1666
        self._changes_aborted = True
 
1667
        raise errors.InconsistentDelta(path, file_id, reason)
1585
1668
 
1586
1669
    def _update_basis_apply_adds(self, adds):
1587
1670
        """Apply a sequence of adds to tree 1 during update_basis_by_delta.
1596
1679
        """
1597
1680
        # Adds are accumulated partly from renames, so can be in any input
1598
1681
        # order - sort it.
1599
 
        adds.sort()
 
1682
        # TODO: we may want to sort in dirblocks order. That way each entry
 
1683
        #       will end up in the same directory, allowing the _get_entry
 
1684
        #       fast-path for looking up 2 items in the same dir work.
 
1685
        adds.sort(key=lambda x: x[1])
1600
1686
        # adds is now in lexographic order, which places all parents before
1601
1687
        # their children, so we can process it linearly.
1602
 
        absent = 'ar'
 
1688
        st = static_tuple.StaticTuple
1603
1689
        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
 
1690
            dirname, basename = osutils.split(new_path)
 
1691
            entry_key = st(dirname, basename, file_id)
 
1692
            block_index, present = self._find_block_index_from_key(entry_key)
 
1693
            if not present:
 
1694
                # The block where we want to put the file is not present.
 
1695
                # However, it might have just been an empty directory. Look for
 
1696
                # the parent in the basis-so-far before throwing an error.
 
1697
                parent_dir, parent_base = osutils.split(dirname)
 
1698
                parent_block_idx, parent_entry_idx, _, parent_present = \
 
1699
                    self._get_block_entry_index(parent_dir, parent_base, 1)
 
1700
                if not parent_present:
 
1701
                    self._raise_invalid(new_path, file_id,
 
1702
                                        "Unable to find block for this record."
 
1703
                                        " Was the parent added?")
 
1704
                self._ensure_block(parent_block_idx, parent_entry_idx, dirname)
 
1705
 
 
1706
            block = self._dirblocks[block_index][1]
 
1707
            entry_index, present = self._find_entry_index(entry_key, block)
 
1708
            if real_add:
 
1709
                if old_path is not None:
 
1710
                    self._raise_invalid(new_path, file_id,
 
1711
                                        'considered a real add but still had old_path at %s'
 
1712
                                        % (old_path,))
 
1713
            if present:
 
1714
                entry = block[entry_index]
 
1715
                basis_kind = entry[1][1][0]
 
1716
                if basis_kind == b'a':
 
1717
                    entry[1][1] = new_details
 
1718
                elif basis_kind == b'r':
 
1719
                    raise NotImplementedError()
 
1720
                else:
 
1721
                    self._raise_invalid(new_path, file_id,
 
1722
                                        "An entry was marked as a new add"
 
1723
                                        " but the basis target already existed")
 
1724
            else:
 
1725
                # The exact key was not found in the block. However, we need to
 
1726
                # check if there is a key next to us that would have matched.
 
1727
                # We only need to check 2 locations, because there are only 2
 
1728
                # trees present.
 
1729
                for maybe_index in range(entry_index - 1, entry_index + 1):
 
1730
                    if maybe_index < 0 or maybe_index >= len(block):
 
1731
                        continue
 
1732
                    maybe_entry = block[maybe_index]
 
1733
                    if maybe_entry[0][:2] != (dirname, basename):
 
1734
                        # Just a random neighbor
 
1735
                        continue
 
1736
                    if maybe_entry[0][2] == file_id:
 
1737
                        raise AssertionError(
 
1738
                            '_find_entry_index didnt find a key match'
 
1739
                            ' but walking the data did, for %s'
 
1740
                            % (entry_key,))
 
1741
                    basis_kind = maybe_entry[1][1][0]
 
1742
                    if basis_kind not in (b'a', b'r'):
 
1743
                        self._raise_invalid(new_path, file_id,
 
1744
                                            "we have an add record for path, but the path"
 
1745
                                            " is already present with another file_id %s"
 
1746
                                            % (maybe_entry[0][2],))
 
1747
 
 
1748
                entry = (entry_key, [DirState.NULL_PARENT_DETAILS,
 
1749
                                     new_details])
 
1750
                block.insert(entry_index, entry)
 
1751
 
 
1752
            active_kind = entry[1][0][0]
 
1753
            if active_kind == b'a':
 
1754
                # The active record shows up as absent, this could be genuine,
 
1755
                # or it could be present at some other location. We need to
 
1756
                # verify.
 
1757
                id_index = self._get_id_index()
 
1758
                # The id_index may not be perfectly accurate for tree1, because
 
1759
                # we haven't been keeping it updated. However, it should be
 
1760
                # fine for tree0, and that gives us enough info for what we
 
1761
                # need
 
1762
                keys = id_index.get(file_id, ())
 
1763
                for key in keys:
 
1764
                    block_i, entry_i, d_present, f_present = \
 
1765
                        self._get_block_entry_index(key[0], key[1], 0)
 
1766
                    if not f_present:
 
1767
                        continue
 
1768
                    active_entry = self._dirblocks[block_i][1][entry_i]
 
1769
                    if (active_entry[0][2] != file_id):
 
1770
                        # Some other file is at this path, we don't need to
 
1771
                        # link it.
 
1772
                        continue
 
1773
                    real_active_kind = active_entry[1][0][0]
 
1774
                    if real_active_kind in (b'a', b'r'):
 
1775
                        # We found a record, which was not *this* record,
 
1776
                        # which matches the file_id, but is not actually
 
1777
                        # present. Something seems *really* wrong.
 
1778
                        self._raise_invalid(new_path, file_id,
 
1779
                                            "We found a tree0 entry that doesnt make sense")
 
1780
                    # Now, we've found a tree0 entry which matches the file_id
 
1781
                    # but is at a different location. So update them to be
 
1782
                    # rename records.
 
1783
                    active_dir, active_name = active_entry[0][:2]
 
1784
                    if active_dir:
 
1785
                        active_path = active_dir + b'/' + active_name
 
1786
                    else:
 
1787
                        active_path = active_name
 
1788
                    active_entry[1][1] = st(b'r', new_path, 0, False, b'')
 
1789
                    entry[1][0] = st(b'r', active_path, 0, False, b'')
 
1790
            elif active_kind == b'r':
 
1791
                raise NotImplementedError()
 
1792
 
 
1793
            new_kind = new_details[0]
 
1794
            if new_kind == b'd':
 
1795
                self._ensure_block(block_index, entry_index, new_path)
1619
1796
 
1620
1797
    def _update_basis_apply_changes(self, changes):
1621
1798
        """Apply a sequence of changes to tree 1 during update_basis_by_delta.
1623
1800
        :param adds: A sequence of changes. Each change is a tuple:
1624
1801
            (path_utf8, path_utf8, file_id, (entry_details))
1625
1802
        """
1626
 
        absent = 'ar'
1627
1803
        for old_path, new_path, file_id, new_details in changes:
1628
1804
            # 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')
 
1805
            entry = self._get_entry(1, file_id, new_path)
 
1806
            if entry[0] is None or entry[1][1][0] in (b'a', b'r'):
 
1807
                self._raise_invalid(new_path, file_id,
 
1808
                                    'changed entry considered not present')
1639
1809
            entry[1][1] = new_details
1640
1810
 
1641
1811
    def _update_basis_apply_deletes(self, deletes):
1653
1823
        null = DirState.NULL_PARENT_DETAILS
1654
1824
        for old_path, new_path, file_id, _, real_delete in deletes:
1655
1825
            if real_delete != (new_path is None):
1656
 
                self._changes_aborted = True
1657
 
                raise AssertionError("bad delete delta")
 
1826
                self._raise_invalid(old_path, file_id, "bad delete delta")
1658
1827
            # the entry for this file_id must be in tree 1.
1659
1828
            dirname, basename = osutils.split(old_path)
1660
1829
            block_index, entry_index, dir_present, file_present = \
1661
1830
                self._get_block_entry_index(dirname, basename, 1)
1662
1831
            if not file_present:
1663
 
                self._changes_aborted = True
1664
 
                raise errors.InconsistentDelta(old_path, file_id,
1665
 
                    'basis tree does not contain removed entry')
 
1832
                self._raise_invalid(old_path, file_id,
 
1833
                                    'basis tree does not contain removed entry')
1666
1834
            entry = self._dirblocks[block_index][1][entry_index]
 
1835
            # The state of the entry in the 'active' WT
 
1836
            active_kind = entry[1][0][0]
1667
1837
            if entry[0][2] != file_id:
1668
 
                self._changes_aborted = True
1669
 
                raise errors.InconsistentDelta(old_path, file_id,
1670
 
                    '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.')
 
1838
                self._raise_invalid(old_path, file_id,
 
1839
                                    'mismatched file_id in tree 1')
 
1840
            dir_block = ()
 
1841
            old_kind = entry[1][1][0]
 
1842
            if active_kind in b'ar':
 
1843
                # The active tree doesn't have this file_id.
 
1844
                # The basis tree is changing this record. If this is a
 
1845
                # rename, then we don't want the record here at all
 
1846
                # anymore. If it is just an in-place change, we want the
 
1847
                # record here, but we'll add it if we need to. So we just
 
1848
                # delete it
 
1849
                if active_kind == b'r':
 
1850
                    active_path = entry[1][0][1]
 
1851
                    active_entry = self._get_entry(0, file_id, active_path)
 
1852
                    if active_entry[1][1][0] != b'r':
 
1853
                        self._raise_invalid(old_path, file_id,
 
1854
                                            "Dirstate did not have matching rename entries")
 
1855
                    elif active_entry[1][0][0] in b'ar':
 
1856
                        self._raise_invalid(old_path, file_id,
 
1857
                                            "Dirstate had a rename pointing at an inactive"
 
1858
                                            " tree0")
 
1859
                    active_entry[1][1] = null
1677
1860
                del self._dirblocks[block_index][1][entry_index]
 
1861
                if old_kind == b'd':
 
1862
                    # This was a directory, and the active tree says it
 
1863
                    # doesn't exist, and now the basis tree says it doesn't
 
1864
                    # exist. Remove its dirblock if present
 
1865
                    (dir_block_index,
 
1866
                     present) = self._find_block_index_from_key(
 
1867
                        (old_path, b'', b''))
 
1868
                    if present:
 
1869
                        dir_block = self._dirblocks[dir_block_index][1]
 
1870
                        if not dir_block:
 
1871
                            # This entry is empty, go ahead and just remove it
 
1872
                            del self._dirblocks[dir_block_index]
1678
1873
            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
 
1874
                # There is still an active record, so just mark this
 
1875
                # removed.
 
1876
                entry[1][1] = null
 
1877
                block_i, entry_i, d_present, f_present = \
 
1878
                    self._get_block_entry_index(old_path, b'', 1)
 
1879
                if d_present:
 
1880
                    dir_block = self._dirblocks[block_i][1]
 
1881
            for child_entry in dir_block:
 
1882
                child_basis_kind = child_entry[1][1][0]
 
1883
                if child_basis_kind not in b'ar':
 
1884
                    self._raise_invalid(old_path, file_id,
 
1885
                                        "The file id was deleted but its children were "
 
1886
                                        "not deleted.")
1694
1887
 
1695
1888
    def _after_delta_check_parents(self, parents, index):
1696
1889
        """Check that parents required by the delta are all intact.
1697
 
        
 
1890
 
1698
1891
        :param parents: An iterable of (path_utf8, file_id) tuples which are
1699
1892
            required to be present in tree 'index' at path_utf8 with id file_id
1700
1893
            and be a directory.
1705
1898
            # has the right file id.
1706
1899
            entry = self._get_entry(index, file_id, dirname_utf8)
1707
1900
            if entry[1] is None:
1708
 
                self._changes_aborted = True
1709
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1710
 
                    file_id, "This parent is not present.")
 
1901
                self._raise_invalid(dirname_utf8.decode('utf8'),
 
1902
                                    file_id, "This parent is not present.")
1711
1903
            # Parents of things must be directories
1712
 
            if entry[1][index][0] != 'd':
1713
 
                self._changes_aborted = True
1714
 
                raise errors.InconsistentDelta(dirname_utf8.decode('utf8'),
1715
 
                    file_id, "This parent is not a directory.")
 
1904
            if entry[1][index][0] != b'd':
 
1905
                self._raise_invalid(dirname_utf8.decode('utf8'),
 
1906
                                    file_id, "This parent is not a directory.")
1716
1907
 
1717
1908
    def _observed_sha1(self, entry, sha1, stat_value,
1718
 
        _stat_to_minikind=_stat_to_minikind, _pack_stat=pack_stat):
 
1909
                       _stat_to_minikind=_stat_to_minikind):
1719
1910
        """Note the sha1 of a file.
1720
1911
 
1721
1912
        :param entry: The entry the sha1 is for.
1723
1914
        :param stat_value: The os.lstat for the file.
1724
1915
        """
1725
1916
        try:
1726
 
            minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
1917
            minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
1727
1918
        except KeyError:
1728
1919
            # Unhandled kind
1729
1920
            return None
1730
 
        packed_stat = _pack_stat(stat_value)
1731
 
        if minikind == 'f':
 
1921
        if minikind == b'f':
1732
1922
            if self._cutoff_time is None:
1733
1923
                self._sha_cutoff_time()
1734
1924
            if (stat_value.st_mtime < self._cutoff_time
1735
 
                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
 
1925
                    and stat_value.st_ctime < self._cutoff_time):
 
1926
                entry[1][0] = (b'f', sha1, stat_value.st_size, entry[1][0][3],
 
1927
                               pack_stat(stat_value))
 
1928
                self._mark_modified([entry])
1739
1929
 
1740
1930
    def _sha_cutoff_time(self):
1741
1931
        """Return cutoff time.
1762
1952
 
1763
1953
    def _is_executable(self, mode, old_executable):
1764
1954
        """Is this file executable?"""
1765
 
        return bool(S_IEXEC & mode)
1766
 
 
1767
 
    def _is_executable_win32(self, mode, old_executable):
1768
 
        """On win32 the executable bit is stored in the dirstate."""
1769
 
        return old_executable
1770
 
 
1771
 
    if sys.platform == 'win32':
1772
 
        _is_executable = _is_executable_win32
 
1955
        if self._use_filesystem_for_exec:
 
1956
            return bool(S_IEXEC & mode)
 
1957
        else:
 
1958
            return old_executable
1773
1959
 
1774
1960
    def _read_link(self, abspath, old_link):
1775
1961
        """Read the target of a symlink"""
1778
1964
        #       higher level, because there either won't be anything on disk,
1779
1965
        #       or the thing on disk will be a file.
1780
1966
        fs_encoding = osutils._fs_enc
1781
 
        if isinstance(abspath, unicode):
 
1967
        if isinstance(abspath, text_type):
1782
1968
            # abspath is defined as the path to pass to lstat. readlink is
1783
1969
            # buggy in python < 2.6 (it doesn't encode unicode path into FS
1784
1970
            # encoding), so we need to encode ourselves knowing that unicode
1785
1971
            # paths are produced by UnicodeDirReader on purpose.
1786
1972
            abspath = abspath.encode(fs_encoding)
1787
1973
        target = os.readlink(abspath)
1788
 
        if fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1974
        if fs_encoding not in ('utf-8', 'ascii'):
1789
1975
            # Change encoding if needed
1790
1976
            target = target.decode(fs_encoding).encode('UTF-8')
1791
1977
        return target
1798
1984
    def get_lines(self):
1799
1985
        """Serialise the entire dirstate to a sequence of lines."""
1800
1986
        if (self._header_state == DirState.IN_MEMORY_UNMODIFIED and
1801
 
            self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
1802
 
            # read whats on disk.
 
1987
                self._dirblock_state == DirState.IN_MEMORY_UNMODIFIED):
 
1988
            # read what's on disk.
1803
1989
            self._state_file.seek(0)
1804
1990
            return self._state_file.readlines()
1805
1991
        lines = []
1806
1992
        lines.append(self._get_parents_line(self.get_parent_ids()))
1807
1993
        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()))
 
1994
        lines.extend(self._iter_entry_lines())
1810
1995
        return self._get_output_lines(lines)
1811
1996
 
1812
1997
    def _get_ghosts_line(self, ghost_ids):
1813
1998
        """Create a line for the state file for ghost information."""
1814
 
        return '\0'.join([str(len(ghost_ids))] + ghost_ids)
 
1999
        return b'\0'.join([b'%d' % len(ghost_ids)] + ghost_ids)
1815
2000
 
1816
2001
    def _get_parents_line(self, parent_ids):
1817
2002
        """Create a line for the state file for parents information."""
1818
 
        return '\0'.join([str(len(parent_ids))] + parent_ids)
 
2003
        return b'\0'.join([b'%d' % len(parent_ids)] + parent_ids)
 
2004
 
 
2005
    def _iter_entry_lines(self):
 
2006
        """Create lines for entries."""
 
2007
        return map(self._entry_to_line, self._iter_entries())
1819
2008
 
1820
2009
    def _get_fields_to_entry(self):
1821
2010
        """Get a function which converts entry fields into a entry record.
1831
2020
            def fields_to_entry_0_parents(fields, _int=int):
1832
2021
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1833
2022
                return (path_name_file_id_key, [
1834
 
                    ( # Current tree
 
2023
                    (  # Current tree
1835
2024
                        fields[3],                # minikind
1836
2025
                        fields[4],                # fingerprint
1837
2026
                        _int(fields[5]),          # size
1838
 
                        fields[6] == 'y',         # executable
 
2027
                        fields[6] == b'y',         # executable
1839
2028
                        fields[7],                # packed_stat or revision_id
1840
2029
                    )])
1841
2030
            return fields_to_entry_0_parents
1843
2032
            def fields_to_entry_1_parent(fields, _int=int):
1844
2033
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1845
2034
                return (path_name_file_id_key, [
1846
 
                    ( # Current tree
 
2035
                    (  # Current tree
1847
2036
                        fields[3],                # minikind
1848
2037
                        fields[4],                # fingerprint
1849
2038
                        _int(fields[5]),          # size
1850
 
                        fields[6] == 'y',         # executable
 
2039
                        fields[6] == b'y',         # executable
1851
2040
                        fields[7],                # packed_stat or revision_id
1852
2041
                    ),
1853
 
                    ( # Parent 1
 
2042
                    (  # Parent 1
1854
2043
                        fields[8],                # minikind
1855
2044
                        fields[9],                # fingerprint
1856
2045
                        _int(fields[10]),         # size
1857
 
                        fields[11] == 'y',        # executable
 
2046
                        fields[11] == b'y',        # executable
1858
2047
                        fields[12],               # packed_stat or revision_id
1859
2048
                    ),
1860
2049
                    ])
1863
2052
            def fields_to_entry_2_parents(fields, _int=int):
1864
2053
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1865
2054
                return (path_name_file_id_key, [
1866
 
                    ( # Current tree
 
2055
                    (  # Current tree
1867
2056
                        fields[3],                # minikind
1868
2057
                        fields[4],                # fingerprint
1869
2058
                        _int(fields[5]),          # size
1870
 
                        fields[6] == 'y',         # executable
 
2059
                        fields[6] == b'y',         # executable
1871
2060
                        fields[7],                # packed_stat or revision_id
1872
2061
                    ),
1873
 
                    ( # Parent 1
 
2062
                    (  # Parent 1
1874
2063
                        fields[8],                # minikind
1875
2064
                        fields[9],                # fingerprint
1876
2065
                        _int(fields[10]),         # size
1877
 
                        fields[11] == 'y',        # executable
 
2066
                        fields[11] == b'y',        # executable
1878
2067
                        fields[12],               # packed_stat or revision_id
1879
2068
                    ),
1880
 
                    ( # Parent 2
 
2069
                    (  # Parent 2
1881
2070
                        fields[13],               # minikind
1882
2071
                        fields[14],               # fingerprint
1883
2072
                        _int(fields[15]),         # size
1884
 
                        fields[16] == 'y',        # executable
 
2073
                        fields[16] == b'y',        # executable
1885
2074
                        fields[17],               # packed_stat or revision_id
1886
2075
                    ),
1887
2076
                    ])
1890
2079
            def fields_to_entry_n_parents(fields, _int=int):
1891
2080
                path_name_file_id_key = (fields[0], fields[1], fields[2])
1892
2081
                trees = [(fields[cur],                # minikind
1893
 
                          fields[cur+1],              # fingerprint
1894
 
                          _int(fields[cur+2]),        # size
1895
 
                          fields[cur+3] == 'y',       # executable
1896
 
                          fields[cur+4],              # stat or revision_id
1897
 
                         ) for cur in xrange(3, len(fields)-1, 5)]
 
2082
                          fields[cur + 1],              # fingerprint
 
2083
                          _int(fields[cur + 2]),        # size
 
2084
                          fields[cur + 3] == b'y',       # executable
 
2085
                          fields[cur + 4],              # stat or revision_id
 
2086
                          ) for cur in range(3, len(fields) - 1, 5)]
1898
2087
                return path_name_file_id_key, trees
1899
2088
            return fields_to_entry_n_parents
1900
2089
 
1924
2113
            tree present there.
1925
2114
        """
1926
2115
        self._read_dirblocks_if_needed()
1927
 
        key = dirname, basename, ''
 
2116
        key = dirname, basename, b''
1928
2117
        block_index, present = self._find_block_index_from_key(key)
1929
2118
        if not present:
1930
2119
            # no such directory - return the dir index and 0 for the row.
1931
2120
            return block_index, 0, False, False
1932
 
        block = self._dirblocks[block_index][1] # access the entries only
 
2121
        block = self._dirblocks[block_index][1]  # access the entries only
1933
2122
        entry_index, present = self._find_entry_index(key, block)
1934
2123
        # linear search through entries at this path to find the one
1935
2124
        # requested.
1936
2125
        while entry_index < len(block) and block[entry_index][0][1] == basename:
1937
 
            if block[entry_index][1][tree_index][0] not in 'ar':
 
2126
            if block[entry_index][1][tree_index][0] not in (b'a', b'r'):
1938
2127
                # neither absent or relocated
1939
2128
                return block_index, entry_index, True, True
1940
2129
            entry_index += 1
1941
2130
        return block_index, entry_index, True, False
1942
2131
 
1943
 
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None, include_deleted=False):
 
2132
    def _get_entry(self, tree_index, fileid_utf8=None, path_utf8=None,
 
2133
                   include_deleted=False):
1944
2134
        """Get the dirstate entry for path in tree tree_index.
1945
2135
 
1946
2136
        If either file_id or path is supplied, it is used as the key to lookup.
1961
2151
        """
1962
2152
        self._read_dirblocks_if_needed()
1963
2153
        if path_utf8 is not None:
1964
 
            if type(path_utf8) is not str:
1965
 
                raise errors.BzrError('path_utf8 is not a str: %s %r'
1966
 
                    % (type(path_utf8), path_utf8))
 
2154
            if not isinstance(path_utf8, bytes):
 
2155
                raise errors.BzrError('path_utf8 is not bytes: %s %r'
 
2156
                                      % (type(path_utf8), path_utf8))
1967
2157
            # path lookups are faster
1968
2158
            dirname, basename = osutils.split(path_utf8)
1969
2159
            block_index, entry_index, dir_present, file_present = \
1971
2161
            if not file_present:
1972
2162
                return None, None
1973
2163
            entry = self._dirblocks[block_index][1][entry_index]
1974
 
            if not (entry[0][2] and entry[1][tree_index][0] not in ('a', 'r')):
 
2164
            if not (entry[0][2] and entry[1][tree_index][0] not in (b'a', b'r')):
1975
2165
                raise AssertionError('unversioned entry?')
1976
2166
            if fileid_utf8:
1977
2167
                if entry[0][2] != fileid_utf8:
1980
2170
                                          ' tree_index, file_id and path')
1981
2171
            return entry
1982
2172
        else:
1983
 
            possible_keys = self._get_id_index().get(fileid_utf8, None)
 
2173
            possible_keys = self._get_id_index().get(fileid_utf8, ())
1984
2174
            if not possible_keys:
1985
2175
                return None, None
1986
2176
            for key in possible_keys:
1999
2189
                    entry = self._dirblocks[block_index][1][entry_index]
2000
2190
                    # TODO: We might want to assert that entry[0][2] ==
2001
2191
                    #       fileid_utf8.
2002
 
                    if entry[1][tree_index][0] in 'fdlt':
 
2192
                    # GZ 2017-06-09: Hoist set of minkinds somewhere
 
2193
                    if entry[1][tree_index][0] in {b'f', b'd', b'l', b't'}:
2003
2194
                        # this is the result we are looking for: the
2004
2195
                        # real home of this file_id in this tree.
2005
2196
                        return entry
2006
 
                    if entry[1][tree_index][0] == 'a':
 
2197
                    if entry[1][tree_index][0] == b'a':
2007
2198
                        # there is no home for this entry in this tree
2008
2199
                        if include_deleted:
2009
2200
                            return entry
2010
2201
                        return None, None
2011
 
                    if entry[1][tree_index][0] != 'r':
 
2202
                    if entry[1][tree_index][0] != b'r':
2012
2203
                        raise AssertionError(
2013
 
                            "entry %r has invalid minikind %r for tree %r" \
 
2204
                            "entry %r has invalid minikind %r for tree %r"
2014
2205
                            % (entry,
2015
2206
                               entry[1][tree_index][0],
2016
2207
                               tree_index))
2017
2208
                    real_path = entry[1][tree_index][1]
2018
2209
                    return self._get_entry(tree_index, fileid_utf8=fileid_utf8,
2019
 
                        path_utf8=real_path)
 
2210
                                           path_utf8=real_path)
2020
2211
            return None, None
2021
2212
 
2022
2213
    @classmethod
2040
2231
            sha1_provider = DefaultSHA1Provider()
2041
2232
        result = cls(path, sha1_provider)
2042
2233
        # root dir and root dir contents with no children.
2043
 
        empty_tree_dirblocks = [('', []), ('', [])]
 
2234
        empty_tree_dirblocks = [(b'', []), (b'', [])]
2044
2235
        # a new root directory, with a NULLSTAT.
2045
2236
        empty_tree_dirblocks[0][1].append(
2046
 
            (('', '', inventory.ROOT_ID), [
2047
 
                ('d', '', 0, False, DirState.NULLSTAT),
 
2237
            ((b'', b'', inventory.ROOT_ID), [
 
2238
                (b'd', b'', 0, False, DirState.NULLSTAT),
2048
2239
            ]))
2049
2240
        result.lock_write()
2050
2241
        try:
2068
2259
        minikind = DirState._kind_to_minikind[kind]
2069
2260
        tree_data = inv_entry.revision
2070
2261
        if kind == 'directory':
2071
 
            fingerprint = ''
 
2262
            fingerprint = b''
2072
2263
            size = 0
2073
2264
            executable = False
2074
2265
        elif kind == 'symlink':
2075
2266
            if inv_entry.symlink_target is None:
2076
 
                fingerprint = ''
 
2267
                fingerprint = b''
2077
2268
            else:
2078
2269
                fingerprint = inv_entry.symlink_target.encode('utf8')
2079
2270
            size = 0
2080
2271
            executable = False
2081
2272
        elif kind == 'file':
2082
 
            fingerprint = inv_entry.text_sha1 or ''
 
2273
            fingerprint = inv_entry.text_sha1 or b''
2083
2274
            size = inv_entry.text_size or 0
2084
2275
            executable = inv_entry.executable
2085
2276
        elif kind == 'tree-reference':
2086
 
            fingerprint = inv_entry.reference_revision or ''
 
2277
            fingerprint = inv_entry.reference_revision or b''
2087
2278
            size = 0
2088
2279
            executable = False
2089
2280
        else:
2090
2281
            raise Exception("can't pack %s" % inv_entry)
2091
 
        return (minikind, fingerprint, size, executable, tree_data)
 
2282
        return static_tuple.StaticTuple(minikind, fingerprint, size,
 
2283
                                        executable, tree_data)
2092
2284
 
2093
2285
    def _iter_child_entries(self, tree_index, path_utf8):
2094
2286
        """Iterate over all the entries that are children of path_utf.
2095
2287
 
2096
 
        This only returns entries that are present (not in 'a', 'r') in
 
2288
        This only returns entries that are present (not in b'a', b'r') in
2097
2289
        tree_index. tree_index data is not refreshed, so if tree 0 is used,
2098
2290
        results may differ from that obtained if paths were statted to
2099
2291
        determine what ones were directories.
2103
2295
        """
2104
2296
        pending_dirs = []
2105
2297
        next_pending_dirs = [path_utf8]
2106
 
        absent = 'ar'
 
2298
        absent = (b'a', b'r')
2107
2299
        while next_pending_dirs:
2108
2300
            pending_dirs = next_pending_dirs
2109
2301
            next_pending_dirs = []
2110
2302
            for path in pending_dirs:
2111
2303
                block_index, present = self._find_block_index_from_key(
2112
 
                    (path, '', ''))
 
2304
                    (path, b'', b''))
2113
2305
                if block_index == 0:
2114
2306
                    block_index = 1
2115
2307
                    if len(self._dirblocks) == 1:
2124
2316
                    kind = entry[1][tree_index][0]
2125
2317
                    if kind not in absent:
2126
2318
                        yield entry
2127
 
                    if kind == 'd':
 
2319
                    if kind == b'd':
2128
2320
                        if entry[0][0]:
2129
 
                            path = entry[0][0] + '/' + entry[0][1]
 
2321
                            path = entry[0][0] + b'/' + entry[0][1]
2130
2322
                        else:
2131
2323
                            path = entry[0][1]
2132
2324
                        next_pending_dirs.append(path)
2135
2327
        """Iterate over all the entries in the dirstate.
2136
2328
 
2137
2329
        Each yelt item is an entry in the standard format described in the
2138
 
        docstring of bzrlib.dirstate.
 
2330
        docstring of breezy.dirstate.
2139
2331
        """
2140
2332
        self._read_dirblocks_if_needed()
2141
2333
        for directory in self._dirblocks:
2143
2335
                yield entry
2144
2336
 
2145
2337
    def _get_id_index(self):
2146
 
        """Get an id index of self._dirblocks."""
 
2338
        """Get an id index of self._dirblocks.
 
2339
 
 
2340
        This maps from file_id => [(directory, name, file_id)] entries where
 
2341
        that file_id appears in one of the trees.
 
2342
        """
2147
2343
        if self._id_index is None:
2148
2344
            id_index = {}
2149
2345
            for key, tree_details in self._iter_entries():
2150
 
                id_index.setdefault(key[2], set()).add(key)
 
2346
                self._add_to_id_index(id_index, key)
2151
2347
            self._id_index = id_index
2152
2348
        return self._id_index
2153
2349
 
 
2350
    def _add_to_id_index(self, id_index, entry_key):
 
2351
        """Add this entry to the _id_index mapping."""
 
2352
        # This code used to use a set for every entry in the id_index. However,
 
2353
        # it is *rare* to have more than one entry. So a set is a large
 
2354
        # overkill. And even when we do, we won't ever have more than the
 
2355
        # number of parent trees. Which is still a small number (rarely >2). As
 
2356
        # such, we use a simple tuple, and do our own uniqueness checks. While
 
2357
        # the 'in' check is O(N) since N is nicely bounded it shouldn't ever
 
2358
        # cause quadratic failure.
 
2359
        file_id = entry_key[2]
 
2360
        entry_key = static_tuple.StaticTuple.from_sequence(entry_key)
 
2361
        if file_id not in id_index:
 
2362
            id_index[file_id] = static_tuple.StaticTuple(entry_key,)
 
2363
        else:
 
2364
            entry_keys = id_index[file_id]
 
2365
            if entry_key not in entry_keys:
 
2366
                id_index[file_id] = entry_keys + (entry_key,)
 
2367
 
 
2368
    def _remove_from_id_index(self, id_index, entry_key):
 
2369
        """Remove this entry from the _id_index mapping.
 
2370
 
 
2371
        It is an programming error to call this when the entry_key is not
 
2372
        already present.
 
2373
        """
 
2374
        file_id = entry_key[2]
 
2375
        entry_keys = list(id_index[file_id])
 
2376
        entry_keys.remove(entry_key)
 
2377
        id_index[file_id] = static_tuple.StaticTuple.from_sequence(entry_keys)
 
2378
 
2154
2379
    def _get_output_lines(self, lines):
2155
2380
        """Format lines for final output.
2156
2381
 
2158
2383
            path lines.
2159
2384
        """
2160
2385
        output_lines = [DirState.HEADER_FORMAT_3]
2161
 
        lines.append('') # a final newline
2162
 
        inventory_text = '\0\n\0'.join(lines)
2163
 
        output_lines.append('crc32: %s\n' % (zlib.crc32(inventory_text),))
 
2386
        lines.append(b'')  # a final newline
 
2387
        inventory_text = b'\0\n\0'.join(lines)
 
2388
        output_lines.append(b'crc32: %d\n' % (zlib.crc32(inventory_text),))
2164
2389
        # -3, 1 for num parents, 1 for ghosts, 1 for final newline
2165
 
        num_entries = len(lines)-3
2166
 
        output_lines.append('num_entries: %s\n' % (num_entries,))
 
2390
        num_entries = len(lines) - 3
 
2391
        output_lines.append(b'num_entries: %d\n' % (num_entries,))
2167
2392
        output_lines.append(inventory_text)
2168
2393
        return output_lines
2169
2394
 
2170
2395
    def _make_deleted_row(self, fileid_utf8, parents):
2171
2396
        """Return a deleted row for fileid_utf8."""
2172
 
        return ('/', 'RECYCLED.BIN', 'file', fileid_utf8, 0, DirState.NULLSTAT,
2173
 
            ''), parents
 
2397
        return (b'/', b'RECYCLED.BIN', b'file', fileid_utf8, 0, DirState.NULLSTAT,
 
2398
                b''), parents
2174
2399
 
2175
2400
    def _num_present_parents(self):
2176
2401
        """The number of parent entries in each record row."""
2177
2402
        return len(self._parents) - len(self._ghosts)
2178
2403
 
2179
 
    @staticmethod
2180
 
    def on_file(path, sha1_provider=None):
 
2404
    @classmethod
 
2405
    def on_file(cls, path, sha1_provider=None, worth_saving_limit=0,
 
2406
                use_filesystem_for_exec=True):
2181
2407
        """Construct a DirState on the file at path "path".
2182
2408
 
2183
2409
        :param path: The path at which the dirstate file on disk should live.
2184
2410
        :param sha1_provider: an object meeting the SHA1Provider interface.
2185
2411
            If None, a DefaultSHA1Provider is used.
 
2412
        :param worth_saving_limit: when the exact number of hash changed
 
2413
            entries is known, only bother saving the dirstate if more than
 
2414
            this count of entries have changed. -1 means never save.
 
2415
        :param use_filesystem_for_exec: Whether to trust the filesystem
 
2416
            for executable bit information
2186
2417
        :return: An unlocked DirState object, associated with the given path.
2187
2418
        """
2188
2419
        if sha1_provider is None:
2189
2420
            sha1_provider = DefaultSHA1Provider()
2190
 
        result = DirState(path, sha1_provider)
 
2421
        result = cls(path, sha1_provider,
 
2422
                     worth_saving_limit=worth_saving_limit,
 
2423
                     use_filesystem_for_exec=use_filesystem_for_exec)
2191
2424
        return result
2192
2425
 
2193
2426
    def _read_dirblocks_if_needed(self):
2211
2444
        """
2212
2445
        self._read_prelude()
2213
2446
        parent_line = self._state_file.readline()
2214
 
        info = parent_line.split('\0')
 
2447
        info = parent_line.split(b'\0')
2215
2448
        num_parents = int(info[0])
2216
2449
        self._parents = info[1:-1]
2217
2450
        ghost_line = self._state_file.readline()
2218
 
        info = ghost_line.split('\0')
 
2451
        info = ghost_line.split(b'\0')
2219
2452
        num_ghosts = int(info[1])
2220
2453
        self._ghosts = info[2:-1]
2221
2454
        self._header_state = DirState.IN_MEMORY_UNMODIFIED
2243
2476
            raise errors.BzrError(
2244
2477
                'invalid header line: %r' % (header,))
2245
2478
        crc_line = self._state_file.readline()
2246
 
        if not crc_line.startswith('crc32: '):
 
2479
        if not crc_line.startswith(b'crc32: '):
2247
2480
            raise errors.BzrError('missing crc32 checksum: %r' % crc_line)
2248
 
        self.crc_expected = int(crc_line[len('crc32: '):-1])
 
2481
        self.crc_expected = int(crc_line[len(b'crc32: '):-1])
2249
2482
        num_entries_line = self._state_file.readline()
2250
 
        if not num_entries_line.startswith('num_entries: '):
 
2483
        if not num_entries_line.startswith(b'num_entries: '):
2251
2484
            raise errors.BzrError('missing num_entries line')
2252
 
        self._num_entries = int(num_entries_line[len('num_entries: '):-1])
 
2485
        self._num_entries = int(num_entries_line[len(b'num_entries: '):-1])
2253
2486
 
2254
 
    def sha1_from_stat(self, path, stat_result, _pack_stat=pack_stat):
 
2487
    def sha1_from_stat(self, path, stat_result):
2255
2488
        """Find a sha1 given a stat lookup."""
2256
 
        return self._get_packed_stat_index().get(_pack_stat(stat_result), None)
 
2489
        return self._get_packed_stat_index().get(pack_stat(stat_result), None)
2257
2490
 
2258
2491
    def _get_packed_stat_index(self):
2259
2492
        """Get a packed_stat index of self._dirblocks."""
2260
2493
        if self._packed_stat_index is None:
2261
2494
            index = {}
2262
2495
            for key, tree_details in self._iter_entries():
2263
 
                if tree_details[0][0] == 'f':
 
2496
                if tree_details[0][0] == b'f':
2264
2497
                    index[tree_details[0][4]] = tree_details[0][1]
2265
2498
            self._packed_stat_index = index
2266
2499
        return self._packed_stat_index
2283
2516
            # Should this be a warning? For now, I'm expecting that places that
2284
2517
            # mark it inconsistent will warn, making a warning here redundant.
2285
2518
            trace.mutter('Not saving DirState because '
2286
 
                    '_changes_aborted is set.')
2287
 
            return
2288
 
        if (self._header_state == DirState.IN_MEMORY_MODIFIED or
2289
 
            self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2519
                         '_changes_aborted is set.')
 
2520
            return
 
2521
        # TODO: Since we now distinguish IN_MEMORY_MODIFIED from
 
2522
        #       IN_MEMORY_HASH_MODIFIED, we should only fail quietly if we fail
 
2523
        #       to save an IN_MEMORY_HASH_MODIFIED, and fail *noisily* if we
 
2524
        #       fail to save IN_MEMORY_MODIFIED
 
2525
        if not self._worth_saving():
 
2526
            return
2290
2527
 
2291
 
            grabbed_write_lock = False
2292
 
            if self._lock_state != 'w':
2293
 
                grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
2294
 
                # Switch over to the new lock, as the old one may be closed.
 
2528
        grabbed_write_lock = False
 
2529
        if self._lock_state != 'w':
 
2530
            grabbed_write_lock, new_lock = self._lock_token.temporary_write_lock()
 
2531
            # Switch over to the new lock, as the old one may be closed.
 
2532
            # TODO: jam 20070315 We should validate the disk file has
 
2533
            #       not changed contents, since temporary_write_lock may
 
2534
            #       not be an atomic operation.
 
2535
            self._lock_token = new_lock
 
2536
            self._state_file = new_lock.f
 
2537
            if not grabbed_write_lock:
 
2538
                # We couldn't grab a write lock, so we switch back to a read one
 
2539
                return
 
2540
        try:
 
2541
            lines = self.get_lines()
 
2542
            self._state_file.seek(0)
 
2543
            self._state_file.writelines(lines)
 
2544
            self._state_file.truncate()
 
2545
            self._state_file.flush()
 
2546
            self._maybe_fdatasync()
 
2547
            self._mark_unmodified()
 
2548
        finally:
 
2549
            if grabbed_write_lock:
 
2550
                self._lock_token = self._lock_token.restore_read_lock()
 
2551
                self._state_file = self._lock_token.f
2295
2552
                # TODO: jam 20070315 We should validate the disk file has
2296
 
                #       not changed contents. Since temporary_write_lock may
 
2553
                #       not changed contents. Since restore_read_lock may
2297
2554
                #       not be an atomic operation.
2298
 
                self._lock_token = new_lock
2299
 
                self._state_file = new_lock.f
2300
 
                if not grabbed_write_lock:
2301
 
                    # We couldn't grab a write lock, so we switch back to a read one
2302
 
                    return
2303
 
            try:
2304
 
                self._state_file.seek(0)
2305
 
                self._state_file.writelines(self.get_lines())
2306
 
                self._state_file.truncate()
2307
 
                self._state_file.flush()
2308
 
                self._header_state = DirState.IN_MEMORY_UNMODIFIED
2309
 
                self._dirblock_state = DirState.IN_MEMORY_UNMODIFIED
2310
 
            finally:
2311
 
                if grabbed_write_lock:
2312
 
                    self._lock_token = self._lock_token.restore_read_lock()
2313
 
                    self._state_file = self._lock_token.f
2314
 
                    # TODO: jam 20070315 We should validate the disk file has
2315
 
                    #       not changed contents. Since restore_read_lock may
2316
 
                    #       not be an atomic operation.
 
2555
 
 
2556
    def _maybe_fdatasync(self):
 
2557
        """Flush to disk if possible and if not configured off."""
 
2558
        if self._config_stack.get('dirstate.fdatasync'):
 
2559
            osutils.fdatasync(self._state_file.fileno())
 
2560
 
 
2561
    def _worth_saving(self):
 
2562
        """Is it worth saving the dirstate or not?"""
 
2563
        if (self._header_state == DirState.IN_MEMORY_MODIFIED
 
2564
                or self._dirblock_state == DirState.IN_MEMORY_MODIFIED):
 
2565
            return True
 
2566
        if self._dirblock_state == DirState.IN_MEMORY_HASH_MODIFIED:
 
2567
            if self._worth_saving_limit == -1:
 
2568
                # We never save hash changes when the limit is -1
 
2569
                return False
 
2570
            # If we're using smart saving and only a small number of
 
2571
            # entries have changed their hash, don't bother saving. John has
 
2572
            # suggested using a heuristic here based on the size of the
 
2573
            # changed files and/or tree. For now, we go with a configurable
 
2574
            # number of changes, keeping the calculation time
 
2575
            # as low overhead as possible. (This also keeps all existing
 
2576
            # tests passing as the default is 0, i.e. always save.)
 
2577
            if len(self._known_hash_changes) >= self._worth_saving_limit:
 
2578
                return True
 
2579
        return False
2317
2580
 
2318
2581
    def _set_data(self, parent_ids, dirblocks):
2319
2582
        """Set the full dirstate data in memory.
2328
2591
        """
2329
2592
        # our memory copy is now authoritative.
2330
2593
        self._dirblocks = dirblocks
2331
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2332
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2594
        self._mark_modified(header_modified=True)
2333
2595
        self._parents = list(parent_ids)
2334
2596
        self._id_index = None
2335
2597
        self._packed_stat_index = None
2337
2599
    def set_path_id(self, path, new_id):
2338
2600
        """Change the id of path to new_id in the current working tree.
2339
2601
 
2340
 
        :param path: The path inside the tree to set - '' is the root, 'foo'
 
2602
        :param path: The path inside the tree to set - b'' is the root, 'foo'
2341
2603
            is the path foo in the root.
2342
2604
        :param new_id: The new id to assign to the path. This must be a utf8
2343
2605
            file id (not unicode, and not None).
2351
2613
        if entry[0][2] == new_id:
2352
2614
            # Nothing to change.
2353
2615
            return
 
2616
        if new_id.__class__ != bytes:
 
2617
            raise AssertionError(
 
2618
                "must be a utf8 file_id not %s" % (type(new_id), ))
2354
2619
        # mark the old path absent, and insert a new root path
2355
2620
        self._make_absent(entry)
2356
 
        self.update_minimal(('', '', new_id), 'd',
2357
 
            path_utf8='', packed_stat=entry[1][0][4])
2358
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2621
        self.update_minimal((b'', b'', new_id), b'd',
 
2622
                            path_utf8=b'', packed_stat=entry[1][0][4])
 
2623
        self._mark_modified()
2359
2624
 
2360
2625
    def set_parent_trees(self, trees, ghosts):
2361
2626
        """Set the parent trees for the dirstate.
2406
2671
        parent_trees = [tree for rev_id, tree in trees if rev_id not in ghosts]
2407
2672
        # how many trees do we end up with
2408
2673
        parent_count = len(parent_trees)
 
2674
        st = static_tuple.StaticTuple
2409
2675
 
2410
2676
        # one: the current tree
2411
2677
        for entry in self._iter_entries():
2412
2678
            # skip entries not in the current tree
2413
 
            if entry[1][0][0] in 'ar': # absent, relocated
 
2679
            if entry[1][0][0] in (b'a', b'r'):  # absent, relocated
2414
2680
                continue
2415
2681
            by_path[entry[0]] = [entry[1][0]] + \
2416
2682
                [DirState.NULL_PARENT_DETAILS] * parent_count
2417
 
            id_index[entry[0][2]] = set([entry[0]])
 
2683
            # TODO: Possibly inline this, since we know it isn't present yet
 
2684
            #       id_index[entry[0][2]] = (entry[0],)
 
2685
            self._add_to_id_index(id_index, entry[0])
2418
2686
 
2419
2687
        # now the parent trees:
2420
2688
        for tree_index, tree in enumerate(parent_trees):
2424
2692
            # any fileid in this tree as we set the by_path[id] to:
2425
2693
            # already_processed_tree_details + new_details + new_location_suffix
2426
2694
            # the suffix is from tree_index+1:parent_count+1.
2427
 
            new_location_suffix = [DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
 
2695
            new_location_suffix = [
 
2696
                DirState.NULL_PARENT_DETAILS] * (parent_count - tree_index)
2428
2697
            # now stitch in all the entries from this tree
2429
 
            for path, entry in tree.inventory.iter_entries_by_dir():
 
2698
            last_dirname = None
 
2699
            for path, entry in tree.iter_entries_by_dir():
2430
2700
                # here we process each trees details for each item in the tree.
2431
2701
                # we first update any existing entries for the id at other paths,
2432
2702
                # then we either create or update the entry for the id at the
2439
2709
                file_id = entry.file_id
2440
2710
                path_utf8 = path.encode('utf8')
2441
2711
                dirname, basename = osutils.split(path_utf8)
2442
 
                new_entry_key = (dirname, basename, file_id)
 
2712
                if dirname == last_dirname:
 
2713
                    # Try to re-use objects as much as possible
 
2714
                    dirname = last_dirname
 
2715
                else:
 
2716
                    last_dirname = dirname
 
2717
                new_entry_key = st(dirname, basename, file_id)
2443
2718
                # tree index consistency: All other paths for this id in this tree
2444
2719
                # index must point to the correct path.
2445
 
                for entry_key in id_index.setdefault(file_id, set()):
 
2720
                entry_keys = id_index.get(file_id, ())
 
2721
                for entry_key in entry_keys:
2446
2722
                    # TODO:PROFILING: It might be faster to just update
2447
2723
                    # rather than checking if we need to, and then overwrite
2448
2724
                    # the one we are located at.
2451
2727
                        # other trees, so put absent pointers there
2452
2728
                        # This is the vertical axis in the matrix, all pointing
2453
2729
                        # 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.
 
2730
                        by_path[entry_key][tree_index] = st(b'r', path_utf8, 0,
 
2731
                                                            False, b'')
 
2732
                # by path consistency: Insert into an existing path record
 
2733
                # (trivial), or add a new one with relocation pointers for the
 
2734
                # other tree indexes.
 
2735
                if new_entry_key in entry_keys:
 
2736
                    # there is already an entry where this data belongs, just
 
2737
                    # insert it.
2459
2738
                    by_path[new_entry_key][tree_index] = \
2460
2739
                        self._inv_entry_to_details(entry)
2461
2740
                else:
2463
2742
                    # mapping from path,id. We need to look up the correct path
2464
2743
                    # for the indexes from 0 to tree_index -1
2465
2744
                    new_details = []
2466
 
                    for lookup_index in xrange(tree_index):
 
2745
                    for lookup_index in range(tree_index):
2467
2746
                        # boundary case: this is the first occurence of file_id
2468
 
                        # so there are no id_indexs, possibly take this out of
 
2747
                        # so there are no id_indexes, possibly take this out of
2469
2748
                        # the loop?
2470
 
                        if not len(id_index[file_id]):
 
2749
                        if not len(entry_keys):
2471
2750
                            new_details.append(DirState.NULL_PARENT_DETAILS)
2472
2751
                        else:
2473
2752
                            # 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()
2478
 
                            if by_path[a_key][lookup_index][0] in ('r', 'a'):
2479
 
                                # its a pointer or missing statement, use it as is.
2480
 
                                new_details.append(by_path[a_key][lookup_index])
 
2753
                            a_key = next(iter(entry_keys))
 
2754
                            if by_path[a_key][lookup_index][0] in (b'r', b'a'):
 
2755
                                # its a pointer or missing statement, use it as
 
2756
                                # is.
 
2757
                                new_details.append(
 
2758
                                    by_path[a_key][lookup_index])
2481
2759
                            else:
2482
2760
                                # we have the right key, make a pointer to it.
2483
 
                                real_path = ('/'.join(a_key[0:2])).strip('/')
2484
 
                                new_details.append(('r', real_path, 0, False, ''))
 
2761
                                real_path = (b'/'.join(a_key[0:2])).strip(b'/')
 
2762
                                new_details.append(st(b'r', real_path, 0, False,
 
2763
                                                      b''))
2485
2764
                    new_details.append(self._inv_entry_to_details(entry))
2486
2765
                    new_details.extend(new_location_suffix)
2487
2766
                    by_path[new_entry_key] = new_details
2488
 
                    id_index[file_id].add(new_entry_key)
 
2767
                    self._add_to_id_index(id_index, new_entry_key)
2489
2768
        # --- end generation of full tree mappings
2490
2769
 
2491
2770
        # sort and output all the entries
2492
 
        new_entries = self._sort_entries(by_path.items())
 
2771
        new_entries = self._sort_entries(viewitems(by_path))
2493
2772
        self._entries_to_current_state(new_entries)
2494
2773
        self._parents = [rev_id for rev_id, tree in trees]
2495
2774
        self._ghosts = list(ghosts)
2496
 
        self._header_state = DirState.IN_MEMORY_MODIFIED
2497
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2775
        self._mark_modified(header_modified=True)
2498
2776
        self._id_index = id_index
2499
2777
 
2500
2778
    def _sort_entries(self, entry_list):
2504
2782
        try to keep everything in sorted blocks all the time, but sometimes
2505
2783
        it's easier to sort after the fact.
2506
2784
        """
2507
 
        def _key(entry):
 
2785
        # When sorting, we usually have 10x more entries than directories. (69k
 
2786
        # total entries, 4k directories). So cache the results of splitting.
 
2787
        # Saving time and objects. Also, use StaticTuple to avoid putting all
 
2788
        # of these object into python's garbage collector.
 
2789
        split_dirs = {}
 
2790
 
 
2791
        def _key(entry, _split_dirs=split_dirs, _st=static_tuple.StaticTuple):
2508
2792
            # sort by: directory parts, file name, file id
2509
 
            return entry[0][0].split('/'), entry[0][1], entry[0][2]
 
2793
            dirpath, fname, file_id = entry[0]
 
2794
            try:
 
2795
                split = _split_dirs[dirpath]
 
2796
            except KeyError:
 
2797
                split = _st.from_sequence(dirpath.split(b'/'))
 
2798
                _split_dirs[dirpath] = split
 
2799
            return _st(split, fname, file_id)
2510
2800
        return sorted(entry_list, key=_key)
2511
2801
 
2512
2802
    def set_state_from_inventory(self, new_inv):
2519
2809
        """
2520
2810
        if 'evil' in debug.debug_flags:
2521
2811
            trace.mutter_callsite(1,
2522
 
                "set_state_from_inventory called; please mutate the tree instead")
 
2812
                                  "set_state_from_inventory called; please mutate the tree instead")
2523
2813
        tracing = 'dirstate' in debug.debug_flags
2524
2814
        if tracing:
2525
2815
            trace.mutter("set_state_from_inventory trace:")
2542
2832
        # underlying dirstate.
2543
2833
        old_iterator = iter(list(self._iter_entries()))
2544
2834
        # both must have roots so this is safe:
2545
 
        current_new = new_iterator.next()
2546
 
        current_old = old_iterator.next()
 
2835
        current_new = next(new_iterator)
 
2836
        current_old = next(old_iterator)
 
2837
 
2547
2838
        def advance(iterator):
2548
2839
            try:
2549
 
                return iterator.next()
 
2840
                return next(iterator)
2550
2841
            except StopIteration:
2551
2842
                return None
2552
2843
        while current_new or current_old:
2553
2844
            # skip entries in old that are not really there
2554
 
            if current_old and current_old[1][0][0] in 'ar':
 
2845
            if current_old and current_old[1][0][0] in (b'a', b'r'):
2555
2846
                # relocated or absent
2556
2847
                current_old = advance(old_iterator)
2557
2848
                continue
2563
2854
                new_entry_key = (new_dirname, new_basename, new_id)
2564
2855
                current_new_minikind = \
2565
2856
                    DirState._kind_to_minikind[current_new[1].kind]
2566
 
                if current_new_minikind == 't':
2567
 
                    fingerprint = current_new[1].reference_revision or ''
 
2857
                if current_new_minikind == b't':
 
2858
                    fingerprint = current_new[1].reference_revision or b''
2568
2859
                else:
2569
2860
                    # We normally only insert or remove records, or update
2570
2861
                    # them when it has significantly changed.  Then we want to
2571
2862
                    # erase its fingerprint.  Unaffected records should
2572
2863
                    # normally not be updated at all.
2573
 
                    fingerprint = ''
 
2864
                    fingerprint = b''
2574
2865
            else:
2575
2866
                # for safety disable variables
2576
2867
                new_path_utf8 = new_dirname = new_basename = new_id = \
2581
2872
                # old is finished: insert current_new into the state.
2582
2873
                if tracing:
2583
2874
                    trace.mutter("Appending from new '%s'.",
2584
 
                        new_path_utf8.decode('utf8'))
 
2875
                                 new_path_utf8.decode('utf8'))
2585
2876
                self.update_minimal(new_entry_key, current_new_minikind,
2586
 
                    executable=current_new[1].executable,
2587
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2588
 
                    fullscan=True)
 
2877
                                    executable=current_new[1].executable,
 
2878
                                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2879
                                    fullscan=True)
2589
2880
                current_new = advance(new_iterator)
2590
2881
            elif not current_new:
2591
2882
                # new is finished
2592
2883
                if tracing:
2593
2884
                    trace.mutter("Truncating from old '%s/%s'.",
2594
 
                        current_old[0][0].decode('utf8'),
2595
 
                        current_old[0][1].decode('utf8'))
 
2885
                                 current_old[0][0].decode('utf8'),
 
2886
                                 current_old[0][1].decode('utf8'))
2596
2887
                self._make_absent(current_old)
2597
2888
                current_old = advance(old_iterator)
2598
2889
            elif new_entry_key == current_old[0]:
2604
2895
                # the minimal required trigger is if the execute bit or cached
2605
2896
                # kind has changed.
2606
2897
                if (current_old[1][0][3] != current_new[1].executable or
2607
 
                    current_old[1][0][0] != current_new_minikind):
 
2898
                        current_old[1][0][0] != current_new_minikind):
2608
2899
                    if tracing:
2609
2900
                        trace.mutter("Updating in-place change '%s'.",
2610
 
                            new_path_utf8.decode('utf8'))
 
2901
                                     new_path_utf8.decode('utf8'))
2611
2902
                    self.update_minimal(current_old[0], current_new_minikind,
2612
 
                        executable=current_new[1].executable,
2613
 
                        path_utf8=new_path_utf8, fingerprint=fingerprint,
2614
 
                        fullscan=True)
 
2903
                                        executable=current_new[1].executable,
 
2904
                                        path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2905
                                        fullscan=True)
2615
2906
                # both sides are dealt with, move on
2616
2907
                current_old = advance(old_iterator)
2617
2908
                current_new = advance(new_iterator)
2618
 
            elif (cmp_by_dirs(new_dirname, current_old[0][0]) < 0
2619
 
                  or (new_dirname == current_old[0][0]
2620
 
                      and new_entry_key[1:] < current_old[0][1:])):
 
2909
            elif (lt_by_dirs(new_dirname, current_old[0][0])
 
2910
                  or (new_dirname == current_old[0][0] and
 
2911
                      new_entry_key[1:] < current_old[0][1:])):
2621
2912
                # new comes before:
2622
2913
                # add a entry for this and advance new
2623
2914
                if tracing:
2624
2915
                    trace.mutter("Inserting from new '%s'.",
2625
 
                        new_path_utf8.decode('utf8'))
 
2916
                                 new_path_utf8.decode('utf8'))
2626
2917
                self.update_minimal(new_entry_key, current_new_minikind,
2627
 
                    executable=current_new[1].executable,
2628
 
                    path_utf8=new_path_utf8, fingerprint=fingerprint,
2629
 
                    fullscan=True)
 
2918
                                    executable=current_new[1].executable,
 
2919
                                    path_utf8=new_path_utf8, fingerprint=fingerprint,
 
2920
                                    fullscan=True)
2630
2921
                current_new = advance(new_iterator)
2631
2922
            else:
2632
2923
                # we've advanced past the place where the old key would be,
2633
2924
                # without seeing it in the new list.  so it must be gone.
2634
2925
                if tracing:
2635
2926
                    trace.mutter("Deleting from old '%s/%s'.",
2636
 
                        current_old[0][0].decode('utf8'),
2637
 
                        current_old[0][1].decode('utf8'))
 
2927
                                 current_old[0][0].decode('utf8'),
 
2928
                                 current_old[0][1].decode('utf8'))
2638
2929
                self._make_absent(current_old)
2639
2930
                current_old = advance(old_iterator)
2640
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
2931
        self._mark_modified()
2641
2932
        self._id_index = None
2642
2933
        self._packed_stat_index = None
2643
2934
        if tracing:
2644
2935
            trace.mutter("set_state_from_inventory complete.")
2645
2936
 
 
2937
    def set_state_from_scratch(self, working_inv, parent_trees, parent_ghosts):
 
2938
        """Wipe the currently stored state and set it to something new.
 
2939
 
 
2940
        This is a hard-reset for the data we are working with.
 
2941
        """
 
2942
        # Technically, we really want a write lock, but until we write, we
 
2943
        # don't really need it.
 
2944
        self._requires_lock()
 
2945
        # root dir and root dir contents with no children. We have to have a
 
2946
        # root for set_state_from_inventory to work correctly.
 
2947
        empty_root = ((b'', b'', inventory.ROOT_ID),
 
2948
                      [(b'd', b'', 0, False, DirState.NULLSTAT)])
 
2949
        empty_tree_dirblocks = [(b'', [empty_root]), (b'', [])]
 
2950
        self._set_data([], empty_tree_dirblocks)
 
2951
        self.set_state_from_inventory(working_inv)
 
2952
        self.set_parent_trees(parent_trees, parent_ghosts)
 
2953
 
2646
2954
    def _make_absent(self, current_old):
2647
2955
        """Mark current_old - an entry - as absent for tree 0.
2648
2956
 
2655
2963
        all_remaining_keys = set()
2656
2964
        # Dont check the working tree, because it's going.
2657
2965
        for details in current_old[1][1:]:
2658
 
            if details[0] not in 'ar': # absent, relocated
 
2966
            if details[0] not in (b'a', b'r'):  # absent, relocated
2659
2967
                all_remaining_keys.add(current_old[0])
2660
 
            elif details[0] == 'r': # relocated
 
2968
            elif details[0] == b'r':  # relocated
2661
2969
                # record the key for the real path.
2662
 
                all_remaining_keys.add(tuple(osutils.split(details[1])) + (current_old[0][2],))
 
2970
                all_remaining_keys.add(
 
2971
                    tuple(osutils.split(details[1])) + (current_old[0][2],))
2663
2972
            # absent rows are not present at any path.
2664
2973
        last_reference = current_old[0] not in all_remaining_keys
2665
2974
        if last_reference:
2667
2976
            # absent), and relocated or absent entries for the other trees:
2668
2977
            # Remove it, its meaningless.
2669
2978
            block = self._find_block(current_old[0])
2670
 
            entry_index, present = self._find_entry_index(current_old[0], block[1])
 
2979
            entry_index, present = self._find_entry_index(
 
2980
                current_old[0], block[1])
2671
2981
            if not present:
2672
 
                raise AssertionError('could not find entry for %s' % (current_old,))
 
2982
                raise AssertionError(
 
2983
                    'could not find entry for %s' % (current_old,))
2673
2984
            block[1].pop(entry_index)
2674
2985
            # if we have an id_index in use, remove this key from it for this id.
2675
2986
            if self._id_index is not None:
2676
 
                self._id_index[current_old[0][2]].remove(current_old[0])
 
2987
                self._remove_from_id_index(self._id_index, current_old[0])
2677
2988
        # update all remaining keys for this id to record it as absent. The
2678
2989
        # existing details may either be the record we are marking as deleted
2679
2990
        # (if there were other trees with the id present at this path), or may
2682
2993
            update_block_index, present = \
2683
2994
                self._find_block_index_from_key(update_key)
2684
2995
            if not present:
2685
 
                raise AssertionError('could not find block for %s' % (update_key,))
 
2996
                raise AssertionError(
 
2997
                    'could not find block for %s' % (update_key,))
2686
2998
            update_entry_index, present = \
2687
 
                self._find_entry_index(update_key, self._dirblocks[update_block_index][1])
 
2999
                self._find_entry_index(
 
3000
                    update_key, self._dirblocks[update_block_index][1])
2688
3001
            if not present:
2689
 
                raise AssertionError('could not find entry for %s' % (update_key,))
 
3002
                raise AssertionError(
 
3003
                    'could not find entry for %s' % (update_key,))
2690
3004
            update_tree_details = self._dirblocks[update_block_index][1][update_entry_index][1]
2691
3005
            # it must not be absent at the moment
2692
 
            if update_tree_details[0][0] == 'a': # absent
 
3006
            if update_tree_details[0][0] == b'a':  # absent
2693
3007
                raise AssertionError('bad row %r' % (update_tree_details,))
2694
3008
            update_tree_details[0] = DirState.NULL_PARENT_DETAILS
2695
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3009
        self._mark_modified()
2696
3010
        return last_reference
2697
3011
 
2698
 
    def update_minimal(self, key, minikind, executable=False, fingerprint='',
2699
 
        packed_stat=None, size=0, path_utf8=None, fullscan=False):
 
3012
    def update_minimal(self, key, minikind, executable=False, fingerprint=b'',
 
3013
                       packed_stat=None, size=0, path_utf8=None, fullscan=False):
2700
3014
        """Update an entry to the state in tree 0.
2701
3015
 
2702
3016
        This will either create a new entry at 'key' or update an existing one.
2704
3018
        updated as well.
2705
3019
 
2706
3020
        :param key: (dir, name, file_id) for the new entry
2707
 
        :param minikind: The type for the entry ('f' == 'file', 'd' ==
 
3021
        :param minikind: The type for the entry (b'f' == 'file', b'd' ==
2708
3022
                'directory'), etc.
2709
3023
        :param executable: Should the executable bit be set?
2710
3024
        :param fingerprint: Simple fingerprint for new entry: canonical-form
2723
3037
        block = self._find_block(key)[1]
2724
3038
        if packed_stat is None:
2725
3039
            packed_stat = DirState.NULLSTAT
2726
 
        # XXX: Some callers pass '' as the packed_stat, and it seems to be
 
3040
        # XXX: Some callers pass b'' as the packed_stat, and it seems to be
2727
3041
        # sometimes present in the dirstate - this seems oddly inconsistent.
2728
3042
        # mbp 20071008
2729
3043
        entry_index, present = self._find_entry_index(key, block)
2732
3046
        if not present:
2733
3047
            # New record. Check there isn't a entry at this path already.
2734
3048
            if not fullscan:
2735
 
                low_index, _ = self._find_entry_index(key[0:2] + ('',), block)
 
3049
                low_index, _ = self._find_entry_index(key[0:2] + (b'',), block)
2736
3050
                while low_index < len(block):
2737
3051
                    entry = block[low_index]
2738
3052
                    if entry[0][0:2] == key[0:2]:
2739
 
                        if entry[1][0][0] not in 'ar':
 
3053
                        if entry[1][0][0] not in (b'a', b'r'):
2740
3054
                            # This entry has the same path (but a different id) as
2741
3055
                            # the new entry we're adding, and is present in ths
2742
3056
                            # tree.
2743
 
                            raise errors.InconsistentDelta(
2744
 
                                ("%s/%s" % key[0:2]).decode('utf8'), key[2],
 
3057
                            self._raise_invalid(
 
3058
                                (b"%s/%s" % key[0:2]).decode('utf8'), key[2],
2745
3059
                                "Attempt to add item at path already occupied by "
2746
3060
                                "id %r" % entry[0][2])
2747
3061
                        low_index += 1
2748
3062
                    else:
2749
3063
                        break
2750
3064
            # new entry, synthesis cross reference here,
2751
 
            existing_keys = id_index.setdefault(key[2], set())
 
3065
            existing_keys = id_index.get(key[2], ())
2752
3066
            if not existing_keys:
2753
3067
                # not currently in the state, simplest case
2754
3068
                new_entry = key, [new_details] + self._empty_parent_info()
2784
3098
                    # entry, if not already examined, is skipped over by that
2785
3099
                    # loop.
2786
3100
                    other_entry = other_block[other_entry_index]
2787
 
                    other_entry[1][0] = ('r', path_utf8, 0, False, '')
2788
 
                    self._maybe_remove_row(other_block, other_entry_index,
2789
 
                        id_index)
 
3101
                    other_entry[1][0] = (b'r', path_utf8, 0, False, b'')
 
3102
                    if self._maybe_remove_row(other_block, other_entry_index,
 
3103
                                              id_index):
 
3104
                        # If the row holding this was removed, we need to
 
3105
                        # recompute where this entry goes
 
3106
                        entry_index, _ = self._find_entry_index(key, block)
2790
3107
 
2791
3108
                # This loop:
2792
3109
                # adds a tuple to the new details for each column
2794
3111
                #  - or by creating a new pointer to the right row inside that column
2795
3112
                num_present_parents = self._num_present_parents()
2796
3113
                if num_present_parents:
 
3114
                    # TODO: This re-evaluates the existing_keys set, do we need
 
3115
                    #       to do that ourselves?
2797
3116
                    other_key = list(existing_keys)[0]
2798
 
                for lookup_index in xrange(1, num_present_parents + 1):
 
3117
                for lookup_index in range(1, num_present_parents + 1):
2799
3118
                    # grab any one entry, use it to find the right path.
2800
3119
                    # TODO: optimise this to reduce memory use in highly
2801
3120
                    # fragmented situations by reusing the relocation
2803
3122
                    update_block_index, present = \
2804
3123
                        self._find_block_index_from_key(other_key)
2805
3124
                    if not present:
2806
 
                        raise AssertionError('could not find block for %s' % (other_key,))
 
3125
                        raise AssertionError(
 
3126
                            'could not find block for %s' % (other_key,))
2807
3127
                    update_entry_index, present = \
2808
 
                        self._find_entry_index(other_key, self._dirblocks[update_block_index][1])
 
3128
                        self._find_entry_index(
 
3129
                            other_key, self._dirblocks[update_block_index][1])
2809
3130
                    if not present:
2810
 
                        raise AssertionError('update_minimal: could not find entry for %s' % (other_key,))
 
3131
                        raise AssertionError(
 
3132
                            'update_minimal: could not find entry for %s' % (other_key,))
2811
3133
                    update_details = self._dirblocks[update_block_index][1][update_entry_index][1][lookup_index]
2812
 
                    if update_details[0] in 'ar': # relocated, absent
 
3134
                    if update_details[0] in (b'a', b'r'):  # relocated, absent
2813
3135
                        # its a pointer or absent in lookup_index's tree, use
2814
3136
                        # it as is.
2815
3137
                        new_entry[1].append(update_details)
2816
3138
                    else:
2817
3139
                        # we have the right key, make a pointer to it.
2818
3140
                        pointer_path = osutils.pathjoin(*other_key[0:2])
2819
 
                        new_entry[1].append(('r', pointer_path, 0, False, ''))
 
3141
                        new_entry[1].append(
 
3142
                            (b'r', pointer_path, 0, False, b''))
2820
3143
            block.insert(entry_index, new_entry)
2821
 
            existing_keys.add(key)
 
3144
            self._add_to_id_index(id_index, key)
2822
3145
        else:
2823
3146
            # Does the new state matter?
2824
3147
            block[entry_index][1][0] = new_details
2833
3156
            # converted to relocated.
2834
3157
            if path_utf8 is None:
2835
3158
                raise AssertionError('no path')
2836
 
            for entry_key in id_index.setdefault(key[2], set()):
 
3159
            existing_keys = id_index.get(key[2], ())
 
3160
            if key not in existing_keys:
 
3161
                raise AssertionError('We found the entry in the blocks, but'
 
3162
                                     ' the key is not in the id_index.'
 
3163
                                     ' key: %s, existing_keys: %s' % (key, existing_keys))
 
3164
            for entry_key in existing_keys:
2837
3165
                # TODO:PROFILING: It might be faster to just update
2838
3166
                # rather than checking if we need to, and then overwrite
2839
3167
                # the one we are located at.
2842
3170
                    # other trees, so put absent pointers there
2843
3171
                    # This is the vertical axis in the matrix, all pointing
2844
3172
                    # to the real path.
2845
 
                    block_index, present = self._find_block_index_from_key(entry_key)
 
3173
                    block_index, present = self._find_block_index_from_key(
 
3174
                        entry_key)
2846
3175
                    if not present:
2847
3176
                        raise AssertionError('not present: %r', entry_key)
2848
 
                    entry_index, present = self._find_entry_index(entry_key, self._dirblocks[block_index][1])
 
3177
                    entry_index, present = self._find_entry_index(
 
3178
                        entry_key, self._dirblocks[block_index][1])
2849
3179
                    if not present:
2850
3180
                        raise AssertionError('not present: %r', entry_key)
2851
3181
                    self._dirblocks[block_index][1][entry_index][1][0] = \
2852
 
                        ('r', path_utf8, 0, False, '')
 
3182
                        (b'r', path_utf8, 0, False, b'')
2853
3183
        # add a containing dirblock if needed.
2854
 
        if new_details[0] == 'd':
2855
 
            subdir_key = (osutils.pathjoin(*key[0:2]), '', '')
 
3184
        if new_details[0] == b'd':
 
3185
            # GZ 2017-06-09: Using pathjoin why?
 
3186
            subdir_key = (osutils.pathjoin(*key[0:2]), b'', b'')
2856
3187
            block_index, present = self._find_block_index_from_key(subdir_key)
2857
3188
            if not present:
2858
3189
                self._dirblocks.insert(block_index, (subdir_key[0], []))
2859
3190
 
2860
 
        self._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3191
        self._mark_modified()
2861
3192
 
2862
3193
    def _maybe_remove_row(self, block, index, id_index):
2863
3194
        """Remove index if it is absent or relocated across the row.
2864
 
        
 
3195
 
2865
3196
        id_index is updated accordingly.
 
3197
        :return: True if we removed the row, False otherwise
2866
3198
        """
2867
3199
        present_in_row = False
2868
3200
        entry = block[index]
2869
3201
        for column in entry[1]:
2870
 
            if column[0] not in 'ar':
 
3202
            if column[0] not in (b'a', b'r'):
2871
3203
                present_in_row = True
2872
3204
                break
2873
3205
        if not present_in_row:
2874
3206
            block.pop(index)
2875
 
            id_index[entry[0][2]].remove(entry[0])
 
3207
            self._remove_from_id_index(id_index, entry[0])
 
3208
            return True
 
3209
        return False
2876
3210
 
2877
3211
    def _validate(self):
2878
3212
        """Check that invariants on the dirblock are correct.
2885
3219
        # NOTE: This must always raise AssertionError not just assert,
2886
3220
        # otherwise it may not behave properly under python -O
2887
3221
        #
2888
 
        # TODO: All entries must have some content that's not 'a' or 'r',
 
3222
        # TODO: All entries must have some content that's not b'a' or b'r',
2889
3223
        # otherwise it could just be removed.
2890
3224
        #
2891
3225
        # TODO: All relocations must point directly to a real entry.
2896
3230
        from pprint import pformat
2897
3231
        self._read_dirblocks_if_needed()
2898
3232
        if len(self._dirblocks) > 0:
2899
 
            if not self._dirblocks[0][0] == '':
 
3233
            if not self._dirblocks[0][0] == b'':
2900
3234
                raise AssertionError(
2901
 
                    "dirblocks don't start with root block:\n" + \
2902
 
                    pformat(self._dirblocks))
 
3235
                    "dirblocks don't start with root block:\n"
 
3236
                    + pformat(self._dirblocks))
2903
3237
        if len(self._dirblocks) > 1:
2904
 
            if not self._dirblocks[1][0] == '':
 
3238
            if not self._dirblocks[1][0] == b'':
2905
3239
                raise AssertionError(
2906
 
                    "dirblocks missing root directory:\n" + \
2907
 
                    pformat(self._dirblocks))
 
3240
                    "dirblocks missing root directory:\n"
 
3241
                    + pformat(self._dirblocks))
2908
3242
        # the dirblocks are sorted by their path components, name, and dir id
2909
 
        dir_names = [d[0].split('/')
2910
 
                for d in self._dirblocks[1:]]
 
3243
        dir_names = [d[0].split(b'/')
 
3244
                     for d in self._dirblocks[1:]]
2911
3245
        if dir_names != sorted(dir_names):
2912
3246
            raise AssertionError(
2913
 
                "dir names are not in sorted order:\n" + \
2914
 
                pformat(self._dirblocks) + \
 
3247
                "dir names are not in sorted order:\n" +
 
3248
                pformat(self._dirblocks) +
2915
3249
                "\nkeys:\n" +
2916
3250
                pformat(dir_names))
2917
3251
        for dirblock in self._dirblocks:
2925
3259
                        (entry, pformat(dirblock)))
2926
3260
            if dirblock[1] != sorted(dirblock[1]):
2927
3261
                raise AssertionError(
2928
 
                    "dirblock for %r is not sorted:\n%s" % \
 
3262
                    "dirblock for %r is not sorted:\n%s" %
2929
3263
                    (dirblock[0], pformat(dirblock)))
2930
3264
 
2931
3265
        def check_valid_parent():
2936
3270
            current tree. (It is invalid to have a non-absent file in an absent
2937
3271
            directory.)
2938
3272
            """
2939
 
            if entry[0][0:2] == ('', ''):
 
3273
            if entry[0][0:2] == (b'', b''):
2940
3274
                # There should be no parent for the root row
2941
3275
                return
2942
3276
            parent_entry = self._get_entry(tree_index, path_utf8=entry[0][0])
2944
3278
                raise AssertionError(
2945
3279
                    "no parent entry for: %s in tree %s"
2946
3280
                    % (this_path, tree_index))
2947
 
            if parent_entry[1][tree_index][0] != 'd':
 
3281
            if parent_entry[1][tree_index][0] != b'd':
2948
3282
                raise AssertionError(
2949
3283
                    "Parent entry for %s is not marked as a valid"
2950
3284
                    " directory. %s" % (this_path, parent_entry,))
2958
3292
        # We check this with a dict per tree pointing either to the present
2959
3293
        # name, or None if absent.
2960
3294
        tree_count = self._num_present_parents() + 1
2961
 
        id_path_maps = [dict() for i in range(tree_count)]
 
3295
        id_path_maps = [{} for _ in range(tree_count)]
2962
3296
        # Make sure that all renamed entries point to the correct location.
2963
3297
        for entry in self._iter_entries():
2964
3298
            file_id = entry[0][2]
2965
3299
            this_path = osutils.pathjoin(entry[0][0], entry[0][1])
2966
3300
            if len(entry[1]) != tree_count:
2967
3301
                raise AssertionError(
2968
 
                "wrong number of entry details for row\n%s" \
2969
 
                ",\nexpected %d" % \
2970
 
                (pformat(entry), tree_count))
 
3302
                    "wrong number of entry details for row\n%s"
 
3303
                    ",\nexpected %d" %
 
3304
                    (pformat(entry), tree_count))
2971
3305
            absent_positions = 0
2972
3306
            for tree_index, tree_state in enumerate(entry[1]):
2973
3307
                this_tree_map = id_path_maps[tree_index]
2974
3308
                minikind = tree_state[0]
2975
 
                if minikind in 'ar':
 
3309
                if minikind in (b'a', b'r'):
2976
3310
                    absent_positions += 1
2977
3311
                # have we seen this id before in this column?
2978
3312
                if file_id in this_tree_map:
2979
3313
                    previous_path, previous_loc = this_tree_map[file_id]
2980
3314
                    # any later mention of this file must be consistent with
2981
3315
                    # what was said before
2982
 
                    if minikind == 'a':
 
3316
                    if minikind == b'a':
2983
3317
                        if previous_path is not None:
2984
3318
                            raise AssertionError(
2985
 
                            "file %s is absent in row %r but also present " \
2986
 
                            "at %r"% \
2987
 
                            (file_id, entry, previous_path))
2988
 
                    elif minikind == 'r':
 
3319
                                "file %s is absent in row %r but also present "
 
3320
                                "at %r" %
 
3321
                                (file_id.decode('utf-8'), entry, previous_path))
 
3322
                    elif minikind == b'r':
2989
3323
                        target_location = tree_state[1]
2990
3324
                        if previous_path != target_location:
2991
3325
                            raise AssertionError(
2992
 
                            "file %s relocation in row %r but also at %r" \
2993
 
                            % (file_id, entry, previous_path))
 
3326
                                "file %s relocation in row %r but also at %r"
 
3327
                                % (file_id, entry, previous_path))
2994
3328
                    else:
2995
3329
                        # a file, directory, etc - may have been previously
2996
3330
                        # pointed to by a relocation, which must point here
3001
3335
                                (entry, previous_path, previous_loc))
3002
3336
                        check_valid_parent()
3003
3337
                else:
3004
 
                    if minikind == 'a':
 
3338
                    if minikind == b'a':
3005
3339
                        # absent; should not occur anywhere else
3006
3340
                        this_tree_map[file_id] = None, this_path
3007
 
                    elif minikind == 'r':
 
3341
                    elif minikind == b'r':
3008
3342
                        # relocation, must occur at expected location
3009
3343
                        this_tree_map[file_id] = tree_state[1], this_path
3010
3344
                    else:
3014
3348
                raise AssertionError(
3015
3349
                    "entry %r has no data for any tree." % (entry,))
3016
3350
        if self._id_index is not None:
3017
 
            for file_id, entry_keys in self._id_index.iteritems():
 
3351
            for file_id, entry_keys in viewitems(self._id_index):
3018
3352
                for entry_key in entry_keys:
 
3353
                    # Check that the entry in the map is pointing to the same
 
3354
                    # file_id
3019
3355
                    if entry_key[2] != file_id:
3020
3356
                        raise AssertionError(
3021
3357
                            'file_id %r did not match entry key %s'
3022
3358
                            % (file_id, entry_key))
 
3359
                    # And that from this entry key, we can look up the original
 
3360
                    # record
 
3361
                    block_index, present = self._find_block_index_from_key(
 
3362
                        entry_key)
 
3363
                    if not present:
 
3364
                        raise AssertionError(
 
3365
                            'missing block for entry key: %r', entry_key)
 
3366
                    entry_index, present = self._find_entry_index(
 
3367
                        entry_key, self._dirblocks[block_index][1])
 
3368
                    if not present:
 
3369
                        raise AssertionError(
 
3370
                            'missing entry for key: %r', entry_key)
 
3371
                if len(entry_keys) != len(set(entry_keys)):
 
3372
                    raise AssertionError(
 
3373
                        'id_index contained non-unique data for %s'
 
3374
                        % (entry_keys,))
3023
3375
 
3024
3376
    def _wipe_state(self):
3025
3377
        """Forget all state information about the dirstate."""
3047
3399
        self._lock_state = 'r'
3048
3400
        self._state_file = self._lock_token.f
3049
3401
        self._wipe_state()
 
3402
        return lock.LogicalLockResult(self.unlock)
3050
3403
 
3051
3404
    def lock_write(self):
3052
3405
        """Acquire a write lock on the dirstate."""
3060
3413
        self._lock_state = 'w'
3061
3414
        self._state_file = self._lock_token.f
3062
3415
        self._wipe_state()
 
3416
        return lock.LogicalLockResult(self.unlock, self._lock_token)
3063
3417
 
3064
3418
    def unlock(self):
3065
3419
        """Drop any locks held on the dirstate."""
3082
3436
 
3083
3437
 
3084
3438
def py_update_entry(state, entry, abspath, stat_value,
3085
 
                 _stat_to_minikind=DirState._stat_to_minikind,
3086
 
                 _pack_stat=pack_stat):
 
3439
                    _stat_to_minikind=DirState._stat_to_minikind):
3087
3440
    """Update the entry based on what is actually on disk.
3088
3441
 
3089
3442
    This function only calculates the sha if it needs to - if the entry is
3098
3451
        target of a symlink.
3099
3452
    """
3100
3453
    try:
3101
 
        minikind = _stat_to_minikind[stat_value.st_mode & 0170000]
 
3454
        minikind = _stat_to_minikind[stat_value.st_mode & 0o170000]
3102
3455
    except KeyError:
3103
3456
        # Unhandled kind
3104
3457
        return None
3105
 
    packed_stat = _pack_stat(stat_value)
 
3458
    packed_stat = pack_stat(stat_value)
3106
3459
    (saved_minikind, saved_link_or_sha1, saved_file_size,
3107
3460
     saved_executable, saved_packed_stat) = entry[1][0]
 
3461
    if not isinstance(saved_minikind, bytes):
 
3462
        raise TypeError(saved_minikind)
3108
3463
 
3109
 
    if minikind == 'd' and saved_minikind == 't':
3110
 
        minikind = 't'
 
3464
    if minikind == b'd' and saved_minikind == b't':
 
3465
        minikind = b't'
3111
3466
    if (minikind == saved_minikind
3112
 
        and packed_stat == saved_packed_stat):
 
3467
            and packed_stat == saved_packed_stat):
3113
3468
        # The stat hasn't changed since we saved, so we can re-use the
3114
3469
        # saved sha hash.
3115
 
        if minikind == 'd':
 
3470
        if minikind == b'd':
3116
3471
            return None
3117
3472
 
3118
3473
        # size should also be in packed_stat
3122
3477
    # If we have gotten this far, that means that we need to actually
3123
3478
    # process this entry.
3124
3479
    link_or_sha1 = None
3125
 
    if minikind == 'f':
 
3480
    worth_saving = True
 
3481
    if minikind == b'f':
3126
3482
        executable = state._is_executable(stat_value.st_mode,
3127
 
                                         saved_executable)
 
3483
                                          saved_executable)
3128
3484
        if state._cutoff_time is None:
3129
3485
            state._sha_cutoff_time()
3130
3486
        if (stat_value.st_mtime < state._cutoff_time
3131
3487
            and stat_value.st_ctime < state._cutoff_time
3132
3488
            and len(entry[1]) > 1
3133
 
            and entry[1][1][0] != 'a'):
 
3489
                and entry[1][1][0] != b'a'):
3134
3490
            # Could check for size changes for further optimised
3135
3491
            # avoidance of sha1's. However the most prominent case of
3136
3492
            # over-shaing is during initial add, which this catches.
3138
3494
            # are calculated at the same time, so checking just the size
3139
3495
            # gains nothing w.r.t. performance.
3140
3496
            link_or_sha1 = state._sha1_file(abspath)
3141
 
            entry[1][0] = ('f', link_or_sha1, stat_value.st_size,
 
3497
            entry[1][0] = (b'f', link_or_sha1, stat_value.st_size,
3142
3498
                           executable, packed_stat)
3143
3499
        else:
3144
 
            entry[1][0] = ('f', '', stat_value.st_size,
 
3500
            entry[1][0] = (b'f', b'', stat_value.st_size,
3145
3501
                           executable, DirState.NULLSTAT)
3146
 
    elif minikind == 'd':
 
3502
            worth_saving = False
 
3503
    elif minikind == b'd':
3147
3504
        link_or_sha1 = None
3148
 
        entry[1][0] = ('d', '', 0, False, packed_stat)
3149
 
        if saved_minikind != 'd':
 
3505
        entry[1][0] = (b'd', b'', 0, False, packed_stat)
 
3506
        if saved_minikind != b'd':
3150
3507
            # This changed from something into a directory. Make sure we
3151
3508
            # have a directory block for it. This doesn't happen very
3152
3509
            # often, so this doesn't have to be super fast.
3153
3510
            block_index, entry_index, dir_present, file_present = \
3154
3511
                state._get_block_entry_index(entry[0][0], entry[0][1], 0)
3155
3512
            state._ensure_block(block_index, entry_index,
3156
 
                               osutils.pathjoin(entry[0][0], entry[0][1]))
3157
 
    elif minikind == 'l':
 
3513
                                osutils.pathjoin(entry[0][0], entry[0][1]))
 
3514
        else:
 
3515
            worth_saving = False
 
3516
    elif minikind == b'l':
 
3517
        if saved_minikind == b'l':
 
3518
            worth_saving = False
3158
3519
        link_or_sha1 = state._read_link(abspath, saved_link_or_sha1)
3159
3520
        if state._cutoff_time is None:
3160
3521
            state._sha_cutoff_time()
3161
3522
        if (stat_value.st_mtime < state._cutoff_time
3162
 
            and stat_value.st_ctime < state._cutoff_time):
3163
 
            entry[1][0] = ('l', link_or_sha1, stat_value.st_size,
 
3523
                and stat_value.st_ctime < state._cutoff_time):
 
3524
            entry[1][0] = (b'l', link_or_sha1, stat_value.st_size,
3164
3525
                           False, packed_stat)
3165
3526
        else:
3166
 
            entry[1][0] = ('l', '', stat_value.st_size,
 
3527
            entry[1][0] = (b'l', b'', stat_value.st_size,
3167
3528
                           False, DirState.NULLSTAT)
3168
 
    state._dirblock_state = DirState.IN_MEMORY_MODIFIED
 
3529
    if worth_saving:
 
3530
        state._mark_modified([entry])
3169
3531
    return link_or_sha1
3170
3532
 
3171
3533
 
3172
3534
class ProcessEntryPython(object):
3173
3535
 
3174
3536
    __slots__ = ["old_dirname_to_file_id", "new_dirname_to_file_id",
3175
 
        "last_source_parent", "last_target_parent", "include_unchanged",
3176
 
        "partial", "use_filesystem_for_exec", "utf8_decode",
3177
 
        "searched_specific_files", "search_specific_files",
3178
 
        "searched_exact_paths", "search_specific_file_parents", "seen_ids",
3179
 
        "state", "source_index", "target_index", "want_unversioned", "tree"]
 
3537
                 "last_source_parent", "last_target_parent", "include_unchanged",
 
3538
                 "partial", "use_filesystem_for_exec", "utf8_decode",
 
3539
                 "searched_specific_files", "search_specific_files",
 
3540
                 "searched_exact_paths", "search_specific_file_parents", "seen_ids",
 
3541
                 "state", "source_index", "target_index", "want_unversioned", "tree"]
3180
3542
 
3181
3543
    def __init__(self, include_unchanged, use_filesystem_for_exec,
3182
 
        search_specific_files, state, source_index, target_index,
3183
 
        want_unversioned, tree):
 
3544
                 search_specific_files, state, source_index, target_index,
 
3545
                 want_unversioned, tree):
3184
3546
        self.old_dirname_to_file_id = {}
3185
3547
        self.new_dirname_to_file_id = {}
3186
3548
        # Are we doing a partial iter_changes?
3187
 
        self.partial = search_specific_files != set([''])
 
3549
        self.partial = search_specific_files != {''}
3188
3550
        # Using a list so that we can access the values and change them in
3189
3551
        # nested scope. Each one is [path, file_id, entry]
3190
3552
        self.last_source_parent = [None, None]
3219
3581
        """Compare an entry and real disk to generate delta information.
3220
3582
 
3221
3583
        :param path_info: top_relpath, basename, kind, lstat, abspath for
3222
 
            the path of entry. If None, then the path is considered absent in 
 
3584
            the path of entry. If None, then the path is considered absent in
3223
3585
            the target (Perhaps we should pass in a concrete entry for this ?)
3224
3586
            Basename is returned as a utf8 string because we expect this
3225
3587
            tuple will be ignored, and don't want to take the time to
3236
3598
            source_details = DirState.NULL_PARENT_DETAILS
3237
3599
        else:
3238
3600
            source_details = entry[1][self.source_index]
 
3601
        # GZ 2017-06-09: Eck, more sets.
 
3602
        _fdltr = {b'f', b'd', b'l', b't', b'r'}
 
3603
        _fdlt = {b'f', b'd', b'l', b't'}
 
3604
        _ra = (b'r', b'a')
3239
3605
        target_details = entry[1][self.target_index]
3240
3606
        target_minikind = target_details[0]
3241
 
        if path_info is not None and target_minikind in 'fdlt':
 
3607
        if path_info is not None and target_minikind in _fdlt:
3242
3608
            if not (self.target_index == 0):
3243
3609
                raise AssertionError()
3244
3610
            link_or_sha1 = update_entry(self.state, entry,
3245
 
                abspath=path_info[4], stat_value=path_info[3])
 
3611
                                        abspath=path_info[4], stat_value=path_info[3])
3246
3612
            # The entry may have been modified by update_entry
3247
3613
            target_details = entry[1][self.target_index]
3248
3614
            target_minikind = target_details[0]
3250
3616
            link_or_sha1 = None
3251
3617
        file_id = entry[0][2]
3252
3618
        source_minikind = source_details[0]
3253
 
        if source_minikind in 'fdltr' and target_minikind in 'fdlt':
 
3619
        if source_minikind in _fdltr and target_minikind in _fdlt:
3254
3620
            # claimed content in both: diff
3255
3621
            #   r    | fdlt   |      | add source to search, add id path move and perform
3256
3622
            #        |        |      | diff check on source-target
3257
3623
            #   r    | fdlt   |  a   | dangling file that was present in the basis.
3258
3624
            #        |        |      | ???
3259
 
            if source_minikind in 'r':
 
3625
            if source_minikind == b'r':
3260
3626
                # add the source to the search path to find any children it
3261
3627
                # has.  TODO ? : only add if it is a container ?
3262
3628
                if not osutils.is_inside_any(self.searched_specific_files,
3268
3634
                old_dirname, old_basename = os.path.split(old_path)
3269
3635
                path = pathjoin(entry[0][0], entry[0][1])
3270
3636
                old_entry = self.state._get_entry(self.source_index,
3271
 
                                             path_utf8=old_path)
 
3637
                                                  path_utf8=old_path)
3272
3638
                # update the source details variable to be the real
3273
3639
                # location.
3274
3640
                if old_entry == (None, None):
3275
 
                    raise errors.CorruptDirstate(self.state._filename,
3276
 
                        "entry '%s/%s' is considered renamed from %r"
3277
 
                        " but source does not exist\n"
3278
 
                        "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
 
3641
                    raise DirstateCorrupt(self.state._filename,
 
3642
                                          "entry '%s/%s' is considered renamed from %r"
 
3643
                                          " but source does not exist\n"
 
3644
                                          "entry: %s" % (entry[0][0], entry[0][1], old_path, entry))
3279
3645
                source_details = old_entry[1][self.source_index]
3280
3646
                source_minikind = source_details[0]
3281
3647
            else:
3294
3660
                    if path is None:
3295
3661
                        old_path = path = pathjoin(old_dirname, old_basename)
3296
3662
                    self.new_dirname_to_file_id[path] = file_id
3297
 
                    if source_minikind != 'd':
 
3663
                    if source_minikind != b'd':
3298
3664
                        content_change = True
3299
3665
                    else:
3300
3666
                        # directories have no fingerprint
3301
3667
                        content_change = False
3302
3668
                    target_exec = False
3303
3669
                elif target_kind == 'file':
3304
 
                    if source_minikind != 'f':
 
3670
                    if source_minikind != b'f':
3305
3671
                        content_change = True
3306
3672
                    else:
3307
3673
                        # Check the sha. We can't just rely on the size as
3311
3677
                            # Stat cache miss:
3312
3678
                            statvalue, link_or_sha1 = \
3313
3679
                                self.state._sha1_provider.stat_and_sha1(
3314
 
                                path_info[4])
 
3680
                                    path_info[4])
3315
3681
                            self.state._observed_sha1(entry, link_or_sha1,
3316
 
                                statvalue)
 
3682
                                                      statvalue)
3317
3683
                        content_change = (link_or_sha1 != source_details[1])
3318
3684
                    # Target details is updated at update_entry time
3319
3685
                    if self.use_filesystem_for_exec:
3323
3689
                    else:
3324
3690
                        target_exec = target_details[3]
3325
3691
                elif target_kind == 'symlink':
3326
 
                    if source_minikind != 'l':
 
3692
                    if source_minikind != b'l':
3327
3693
                        content_change = True
3328
3694
                    else:
3329
3695
                        content_change = (link_or_sha1 != source_details[1])
3330
3696
                    target_exec = False
3331
3697
                elif target_kind == 'tree-reference':
3332
 
                    if source_minikind != 't':
 
3698
                    if source_minikind != b't':
3333
3699
                        content_change = True
3334
3700
                    else:
3335
3701
                        content_change = False
3338
3704
                    if path is None:
3339
3705
                        path = pathjoin(old_dirname, old_basename)
3340
3706
                    raise errors.BadFileKindError(path, path_info[2])
3341
 
            if source_minikind == 'd':
 
3707
            if source_minikind == b'd':
3342
3708
                if path is None:
3343
3709
                    old_path = path = pathjoin(old_dirname, old_basename)
3344
3710
                self.old_dirname_to_file_id[old_path] = file_id
3350
3716
                    source_parent_id = self.old_dirname_to_file_id[old_dirname]
3351
3717
                except KeyError:
3352
3718
                    source_parent_entry = self.state._get_entry(self.source_index,
3353
 
                                                           path_utf8=old_dirname)
 
3719
                                                                path_utf8=old_dirname)
3354
3720
                    source_parent_id = source_parent_entry[0][2]
3355
3721
                if source_parent_id == entry[0][2]:
3356
3722
                    # This is the root, so the parent is None
3368
3734
                    # TODO: We don't always need to do the lookup, because the
3369
3735
                    #       parent entry will be the same as the source entry.
3370
3736
                    target_parent_entry = self.state._get_entry(self.target_index,
3371
 
                                                           path_utf8=new_dirname)
 
3737
                                                                path_utf8=new_dirname)
3372
3738
                    if target_parent_entry == (None, None):
3373
3739
                        raise AssertionError(
3374
3740
                            "Could not find target parent in wt: %s\nparent of: %s"
3383
3749
 
3384
3750
            source_exec = source_details[3]
3385
3751
            changed = (content_change
3386
 
                or source_parent_id != target_parent_id
3387
 
                or old_basename != entry[0][1]
3388
 
                or source_exec != target_exec
3389
 
                )
 
3752
                       or source_parent_id != target_parent_id
 
3753
                       or old_basename != entry[0][1]
 
3754
                       or source_exec != target_exec
 
3755
                       )
3390
3756
            if not changed and not self.include_unchanged:
3391
3757
                return None, False
3392
3758
            else:
3401
3767
                    else:
3402
3768
                        path_u = self.utf8_decode(path)[0]
3403
3769
                source_kind = DirState._minikind_to_kind[source_minikind]
3404
 
                return (entry[0][2],
3405
 
                       (old_path_u, path_u),
3406
 
                       content_change,
3407
 
                       (True, True),
3408
 
                       (source_parent_id, target_parent_id),
3409
 
                       (self.utf8_decode(old_basename)[0], self.utf8_decode(entry[0][1])[0]),
3410
 
                       (source_kind, target_kind),
3411
 
                       (source_exec, target_exec)), changed
3412
 
        elif source_minikind in 'a' and target_minikind in 'fdlt':
 
3770
                return TreeChange(
 
3771
                    entry[0][2],
 
3772
                    (old_path_u, path_u),
 
3773
                    content_change,
 
3774
                    (True, True),
 
3775
                    (source_parent_id, target_parent_id),
 
3776
                    (self.utf8_decode(old_basename)[
 
3777
                     0], self.utf8_decode(entry[0][1])[0]),
 
3778
                    (source_kind, target_kind),
 
3779
                    (source_exec, target_exec)), changed
 
3780
        elif source_minikind in b'a' and target_minikind in _fdlt:
3413
3781
            # looks like a new file
3414
3782
            path = pathjoin(entry[0][0], entry[0][1])
3415
3783
            # parent id is the entry for the path in the target tree
3416
3784
            # TODO: these are the same for an entire directory: cache em.
3417
3785
            parent_id = self.state._get_entry(self.target_index,
3418
 
                                         path_utf8=entry[0][0])[0][2]
 
3786
                                              path_utf8=entry[0][0])[0][2]
3419
3787
            if parent_id == entry[0][2]:
3420
3788
                parent_id = None
3421
3789
            if path_info is not None:
3428
3796
                        and stat.S_IEXEC & path_info[3].st_mode)
3429
3797
                else:
3430
3798
                    target_exec = target_details[3]
3431
 
                return (entry[0][2],
3432
 
                       (None, self.utf8_decode(path)[0]),
3433
 
                       True,
3434
 
                       (False, True),
3435
 
                       (None, parent_id),
3436
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3437
 
                       (None, path_info[2]),
3438
 
                       (None, target_exec)), True
 
3799
                return TreeChange(
 
3800
                    entry[0][2],
 
3801
                    (None, self.utf8_decode(path)[0]),
 
3802
                    True,
 
3803
                    (False, True),
 
3804
                    (None, parent_id),
 
3805
                    (None, self.utf8_decode(entry[0][1])[0]),
 
3806
                    (None, path_info[2]),
 
3807
                    (None, target_exec)), True
3439
3808
            else:
3440
3809
                # Its a missing file, report it as such.
3441
 
                return (entry[0][2],
3442
 
                       (None, self.utf8_decode(path)[0]),
3443
 
                       False,
3444
 
                       (False, True),
3445
 
                       (None, parent_id),
3446
 
                       (None, self.utf8_decode(entry[0][1])[0]),
3447
 
                       (None, None),
3448
 
                       (None, False)), True
3449
 
        elif source_minikind in 'fdlt' and target_minikind in 'a':
 
3810
                return TreeChange(
 
3811
                    entry[0][2],
 
3812
                    (None, self.utf8_decode(path)[0]),
 
3813
                    False,
 
3814
                    (False, True),
 
3815
                    (None, parent_id),
 
3816
                    (None, self.utf8_decode(entry[0][1])[0]),
 
3817
                    (None, None),
 
3818
                    (None, False)), True
 
3819
        elif source_minikind in _fdlt and target_minikind in b'a':
3450
3820
            # unversioned, possibly, or possibly not deleted: we dont care.
3451
3821
            # if its still on disk, *and* theres no other entry at this
3452
3822
            # path [we dont know this in this routine at the moment -
3453
3823
            # perhaps we should change this - then it would be an unknown.
3454
3824
            old_path = pathjoin(entry[0][0], entry[0][1])
3455
3825
            # parent id is the entry for the path in the target tree
3456
 
            parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
 
3826
            parent_id = self.state._get_entry(
 
3827
                self.source_index, path_utf8=entry[0][0])[0][2]
3457
3828
            if parent_id == entry[0][2]:
3458
3829
                parent_id = None
3459
 
            return (entry[0][2],
3460
 
                   (self.utf8_decode(old_path)[0], None),
3461
 
                   True,
3462
 
                   (True, False),
3463
 
                   (parent_id, None),
3464
 
                   (self.utf8_decode(entry[0][1])[0], None),
3465
 
                   (DirState._minikind_to_kind[source_minikind], None),
3466
 
                   (source_details[3], None)), True
3467
 
        elif source_minikind in 'fdlt' and target_minikind in 'r':
 
3830
            return TreeChange(
 
3831
                entry[0][2],
 
3832
                (self.utf8_decode(old_path)[0], None),
 
3833
                True,
 
3834
                (True, False),
 
3835
                (parent_id, None),
 
3836
                (self.utf8_decode(entry[0][1])[0], None),
 
3837
                (DirState._minikind_to_kind[source_minikind], None),
 
3838
                (source_details[3], None)), True
 
3839
        elif source_minikind in _fdlt and target_minikind in b'r':
3468
3840
            # a rename; could be a true rename, or a rename inherited from
3469
3841
            # a renamed parent. TODO: handle this efficiently. Its not
3470
3842
            # common case to rename dirs though, so a correct but slow
3471
3843
            # implementation will do.
3472
 
            if not osutils.is_inside_any(self.searched_specific_files, target_details[1]):
 
3844
            if not osutils.is_inside_any(self.searched_specific_files,
 
3845
                                         target_details[1]):
3473
3846
                self.search_specific_files.add(target_details[1])
3474
 
        elif source_minikind in 'ra' and target_minikind in 'ra':
 
3847
        elif source_minikind in _ra and target_minikind in _ra:
3475
3848
            # neither of the selected trees contain this file,
3476
3849
            # so skip over it. This is not currently directly tested, but
3477
3850
            # is indirectly via test_too_much.TestCommands.test_conflicts.
3478
3851
            pass
3479
3852
        else:
3480
3853
            raise AssertionError("don't know how to compare "
3481
 
                "source_minikind=%r, target_minikind=%r"
3482
 
                % (source_minikind, target_minikind))
3483
 
            ## import pdb;pdb.set_trace()
 
3854
                                 "source_minikind=%r, target_minikind=%r"
 
3855
                                 % (source_minikind, target_minikind))
3484
3856
        return None, None
3485
3857
 
3486
3858
    def __iter__(self):
3488
3860
 
3489
3861
    def _gather_result_for_consistency(self, result):
3490
3862
        """Check a result we will yield to make sure we are consistent later.
3491
 
        
 
3863
 
3492
3864
        This gathers result's parents into a set to output later.
3493
3865
 
3494
3866
        :param result: A result tuple.
3495
3867
        """
3496
 
        if not self.partial or not result[0]:
 
3868
        if not self.partial or not result.file_id:
3497
3869
            return
3498
 
        self.seen_ids.add(result[0])
3499
 
        new_path = result[1][1]
 
3870
        self.seen_ids.add(result.file_id)
 
3871
        new_path = result.path[1]
3500
3872
        if new_path:
3501
3873
            # Not the root and not a delete: queue up the parents of the path.
3502
3874
            self.search_specific_file_parents.update(
3503
 
                osutils.parent_directories(new_path.encode('utf8')))
 
3875
                p.encode('utf8') for p in osutils.parent_directories(new_path))
3504
3876
            # Add the root directory which parent_directories does not
3505
3877
            # provide.
3506
 
            self.search_specific_file_parents.add('')
 
3878
            self.search_specific_file_parents.add(b'')
3507
3879
 
3508
3880
    def iter_changes(self):
3509
3881
        """Iterate over the changes."""
3510
3882
        utf8_decode = cache_utf8._utf8_decode
3511
 
        _cmp_by_dirs = cmp_by_dirs
 
3883
        _lt_by_dirs = lt_by_dirs
3512
3884
        _process_entry = self._process_entry
3513
3885
        search_specific_files = self.search_specific_files
3514
3886
        searched_specific_files = self.searched_specific_files
3563
3935
            root_abspath = self.tree.abspath(current_root_unicode)
3564
3936
            try:
3565
3937
                root_stat = os.lstat(root_abspath)
3566
 
            except OSError, e:
 
3938
            except OSError as e:
3567
3939
                if e.errno == errno.ENOENT:
3568
3940
                    # the path does not exist: let _process_entry know that.
3569
3941
                    root_dir_info = None
3571
3943
                    # some other random error: hand it up.
3572
3944
                    raise
3573
3945
            else:
3574
 
                root_dir_info = ('', current_root,
3575
 
                    osutils.file_kind_from_stat_mode(root_stat.st_mode), root_stat,
3576
 
                    root_abspath)
 
3946
                root_dir_info = (b'', current_root,
 
3947
                                 osutils.file_kind_from_stat_mode(
 
3948
                                     root_stat.st_mode), root_stat,
 
3949
                                 root_abspath)
3577
3950
                if root_dir_info[2] == 'directory':
3578
3951
                    if self.tree._directory_is_tree_reference(
3579
 
                        current_root.decode('utf8')):
 
3952
                            current_root.decode('utf8')):
3580
3953
                        root_dir_info = root_dir_info[:2] + \
3581
3954
                            ('tree-reference',) + root_dir_info[3:]
3582
3955
 
3596
3969
                new_executable = bool(
3597
3970
                    stat.S_ISREG(root_dir_info[3].st_mode)
3598
3971
                    and stat.S_IEXEC & root_dir_info[3].st_mode)
3599
 
                yield (None,
3600
 
                       (None, current_root_unicode),
3601
 
                       True,
3602
 
                       (False, False),
3603
 
                       (None, None),
3604
 
                       (None, splitpath(current_root_unicode)[-1]),
3605
 
                       (None, root_dir_info[2]),
3606
 
                       (None, new_executable)
3607
 
                      )
3608
 
            initial_key = (current_root, '', '')
 
3972
                yield TreeChange(
 
3973
                    None,
 
3974
                    (None, current_root_unicode),
 
3975
                    True,
 
3976
                    (False, False),
 
3977
                    (None, None),
 
3978
                    (None, splitpath(current_root_unicode)[-1]),
 
3979
                    (None, root_dir_info[2]),
 
3980
                    (None, new_executable)
 
3981
                    )
 
3982
            initial_key = (current_root, b'', b'')
3609
3983
            block_index, _ = self.state._find_block_index_from_key(initial_key)
3610
3984
            if block_index == 0:
3611
3985
                # we have processed the total root already, but because the
3612
3986
                # initial key matched it we should skip it here.
3613
 
                block_index +=1
 
3987
                block_index += 1
3614
3988
            if root_dir_info and root_dir_info[2] == 'tree-reference':
3615
3989
                current_dir_info = None
3616
3990
            else:
3617
 
                dir_iterator = osutils._walkdirs_utf8(root_abspath, prefix=current_root)
 
3991
                dir_iterator = osutils._walkdirs_utf8(
 
3992
                    root_abspath, prefix=current_root)
3618
3993
                try:
3619
 
                    current_dir_info = dir_iterator.next()
3620
 
                except OSError, e:
 
3994
                    current_dir_info = next(dir_iterator)
 
3995
                except OSError as e:
3621
3996
                    # on win32, python2.4 has e.errno == ERROR_DIRECTORY, but
3622
3997
                    # python 2.5 has e.errno == EINVAL,
3623
3998
                    #            and e.winerror == ERROR_DIRECTORY
3629
4004
                    if e.errno in (errno.ENOENT, errno.ENOTDIR, errno.EINVAL):
3630
4005
                        current_dir_info = None
3631
4006
                    elif (sys.platform == 'win32'
3632
 
                          and (e.errno in win_errors
3633
 
                               or e_winerror in win_errors)):
 
4007
                          and (e.errno in win_errors or
 
4008
                               e_winerror in win_errors)):
3634
4009
                        current_dir_info = None
3635
4010
                    else:
3636
4011
                        raise
3637
4012
                else:
3638
 
                    if current_dir_info[0][0] == '':
 
4013
                    if current_dir_info[0][0] == b'':
3639
4014
                        # remove .bzr from iteration
3640
 
                        bzr_index = bisect.bisect_left(current_dir_info[1], ('.bzr',))
3641
 
                        if current_dir_info[1][bzr_index][0] != '.bzr':
 
4015
                        bzr_index = bisect.bisect_left(
 
4016
                            current_dir_info[1], (b'.bzr',))
 
4017
                        if current_dir_info[1][bzr_index][0] != b'.bzr':
3642
4018
                            raise AssertionError()
3643
4019
                        del current_dir_info[1][bzr_index]
3644
4020
            # walk until both the directory listing and the versioned metadata
3645
4021
            # are exhausted.
3646
4022
            if (block_index < len(self.state._dirblocks) and
3647
 
                osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
4023
                osutils.is_inside(current_root,
 
4024
                                  self.state._dirblocks[block_index][0])):
3648
4025
                current_block = self.state._dirblocks[block_index]
3649
4026
            else:
3650
4027
                current_block = None
3651
4028
            while (current_dir_info is not None or
3652
4029
                   current_block is not None):
3653
4030
                if (current_dir_info and current_block
3654
 
                    and current_dir_info[0][0] != current_block[0]):
3655
 
                    if _cmp_by_dirs(current_dir_info[0][0], current_block[0]) < 0:
 
4031
                        and current_dir_info[0][0] != current_block[0]):
 
4032
                    if _lt_by_dirs(current_dir_info[0][0], current_block[0]):
3656
4033
                        # filesystem data refers to paths not covered by the dirblock.
3657
4034
                        # this has two possibilities:
3658
4035
                        # A) it is versioned but empty, so there is no block for it
3664
4041
                        # recurse into unknown directories.
3665
4042
                        path_index = 0
3666
4043
                        while path_index < len(current_dir_info[1]):
3667
 
                                current_path_info = current_dir_info[1][path_index]
3668
 
                                if self.want_unversioned:
3669
 
                                    if current_path_info[2] == 'directory':
3670
 
                                        if self.tree._directory_is_tree_reference(
 
4044
                            current_path_info = current_dir_info[1][path_index]
 
4045
                            if self.want_unversioned:
 
4046
                                if current_path_info[2] == 'directory':
 
4047
                                    if self.tree._directory_is_tree_reference(
3671
4048
                                            current_path_info[0].decode('utf8')):
3672
 
                                            current_path_info = current_path_info[:2] + \
3673
 
                                                ('tree-reference',) + current_path_info[3:]
3674
 
                                    new_executable = bool(
3675
 
                                        stat.S_ISREG(current_path_info[3].st_mode)
3676
 
                                        and stat.S_IEXEC & current_path_info[3].st_mode)
3677
 
                                    yield (None,
3678
 
                                        (None, utf8_decode(current_path_info[0])[0]),
3679
 
                                        True,
3680
 
                                        (False, False),
3681
 
                                        (None, None),
3682
 
                                        (None, utf8_decode(current_path_info[1])[0]),
3683
 
                                        (None, current_path_info[2]),
3684
 
                                        (None, new_executable))
3685
 
                                # dont descend into this unversioned path if it is
3686
 
                                # a dir
3687
 
                                if current_path_info[2] in ('directory',
3688
 
                                                            'tree-reference'):
3689
 
                                    del current_dir_info[1][path_index]
3690
 
                                    path_index -= 1
3691
 
                                path_index += 1
 
4049
                                        current_path_info = current_path_info[:2] + \
 
4050
                                            ('tree-reference',) + \
 
4051
                                            current_path_info[3:]
 
4052
                                new_executable = bool(
 
4053
                                    stat.S_ISREG(current_path_info[3].st_mode)
 
4054
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
 
4055
                                yield TreeChange(
 
4056
                                    None,
 
4057
                                    (None, utf8_decode(current_path_info[0])[0]),
 
4058
                                    True,
 
4059
                                    (False, False),
 
4060
                                    (None, None),
 
4061
                                    (None, utf8_decode(current_path_info[1])[0]),
 
4062
                                    (None, current_path_info[2]),
 
4063
                                    (None, new_executable))
 
4064
                            # dont descend into this unversioned path if it is
 
4065
                            # a dir
 
4066
                            if current_path_info[2] in ('directory',
 
4067
                                                        'tree-reference'):
 
4068
                                del current_dir_info[1][path_index]
 
4069
                                path_index -= 1
 
4070
                            path_index += 1
3692
4071
 
3693
4072
                        # This dir info has been handled, go to the next
3694
4073
                        try:
3695
 
                            current_dir_info = dir_iterator.next()
 
4074
                            current_dir_info = next(dir_iterator)
3696
4075
                        except StopIteration:
3697
4076
                            current_dir_info = None
3698
4077
                    else:
3706
4085
                        for current_entry in current_block[1]:
3707
4086
                            # entry referring to file not present on disk.
3708
4087
                            # advance the entry only, after processing.
3709
 
                            result, changed = _process_entry(current_entry, None)
 
4088
                            result, changed = _process_entry(
 
4089
                                current_entry, None)
3710
4090
                            if changed is not None:
3711
4091
                                if changed:
3712
4092
                                    self._gather_result_for_consistency(result)
3713
4093
                                if changed or self.include_unchanged:
3714
4094
                                    yield result
3715
 
                        block_index +=1
 
4095
                        block_index += 1
3716
4096
                        if (block_index < len(self.state._dirblocks) and
3717
4097
                            osutils.is_inside(current_root,
3718
4098
                                              self.state._dirblocks[block_index][0])):
3731
4111
                    current_path_info = current_dir_info[1][path_index]
3732
4112
                    if current_path_info[2] == 'directory':
3733
4113
                        if self.tree._directory_is_tree_reference(
3734
 
                            current_path_info[0].decode('utf8')):
 
4114
                                current_path_info[0].decode('utf8')):
3735
4115
                            current_path_info = current_path_info[:2] + \
3736
4116
                                ('tree-reference',) + current_path_info[3:]
3737
4117
                else:
3739
4119
                advance_path = True
3740
4120
                path_handled = False
3741
4121
                while (current_entry is not None or
3742
 
                    current_path_info is not None):
 
4122
                       current_path_info is not None):
3743
4123
                    if current_entry is None:
3744
4124
                        # the check for path_handled when the path is advanced
3745
4125
                        # will yield this path if needed.
3746
4126
                        pass
3747
4127
                    elif current_path_info is None:
3748
4128
                        # no path is fine: the per entry code will handle it.
3749
 
                        result, changed = _process_entry(current_entry, current_path_info)
 
4129
                        result, changed = _process_entry(
 
4130
                            current_entry, current_path_info)
3750
4131
                        if changed is not None:
3751
4132
                            if changed:
3752
4133
                                self._gather_result_for_consistency(result)
3753
4134
                            if changed or self.include_unchanged:
3754
4135
                                yield result
3755
4136
                    elif (current_entry[0][1] != current_path_info[1]
3756
 
                          or current_entry[1][self.target_index][0] in 'ar'):
 
4137
                          or current_entry[1][self.target_index][0] in (b'a', b'r')):
3757
4138
                        # The current path on disk doesn't match the dirblock
3758
4139
                        # record. Either the dirblock is marked as absent, or
3759
4140
                        # the file on disk is not present at all in the
3769
4150
                        else:
3770
4151
                            # entry referring to file not present on disk.
3771
4152
                            # advance the entry only, after processing.
3772
 
                            result, changed = _process_entry(current_entry, None)
 
4153
                            result, changed = _process_entry(
 
4154
                                current_entry, None)
3773
4155
                            if changed is not None:
3774
4156
                                if changed:
3775
4157
                                    self._gather_result_for_consistency(result)
3777
4159
                                    yield result
3778
4160
                            advance_path = False
3779
4161
                    else:
3780
 
                        result, changed = _process_entry(current_entry, current_path_info)
 
4162
                        result, changed = _process_entry(
 
4163
                            current_entry, current_path_info)
3781
4164
                        if changed is not None:
3782
4165
                            path_handled = True
3783
4166
                            if changed:
3791
4174
                        else:
3792
4175
                            current_entry = None
3793
4176
                    else:
3794
 
                        advance_entry = True # reset the advance flaga
 
4177
                        advance_entry = True  # reset the advance flaga
3795
4178
                    if advance_path and current_path_info is not None:
3796
4179
                        if not path_handled:
3797
4180
                            # unversioned in all regards
3800
4183
                                    stat.S_ISREG(current_path_info[3].st_mode)
3801
4184
                                    and stat.S_IEXEC & current_path_info[3].st_mode)
3802
4185
                                try:
3803
 
                                    relpath_unicode = utf8_decode(current_path_info[0])[0]
 
4186
                                    relpath_unicode = utf8_decode(
 
4187
                                        current_path_info[0])[0]
3804
4188
                                except UnicodeDecodeError:
3805
4189
                                    raise errors.BadFilenameEncoding(
3806
4190
                                        current_path_info[0], osutils._fs_enc)
3807
 
                                yield (None,
 
4191
                                yield TreeChange(
 
4192
                                    None,
3808
4193
                                    (None, relpath_unicode),
3809
4194
                                    True,
3810
4195
                                    (False, False),
3827
4212
                            current_path_info = current_dir_info[1][path_index]
3828
4213
                            if current_path_info[2] == 'directory':
3829
4214
                                if self.tree._directory_is_tree_reference(
3830
 
                                    current_path_info[0].decode('utf8')):
 
4215
                                        current_path_info[0].decode('utf8')):
3831
4216
                                    current_path_info = current_path_info[:2] + \
3832
 
                                        ('tree-reference',) + current_path_info[3:]
 
4217
                                        ('tree-reference',) + \
 
4218
                                        current_path_info[3:]
3833
4219
                        else:
3834
4220
                            current_path_info = None
3835
4221
                        path_handled = False
3836
4222
                    else:
3837
 
                        advance_path = True # reset the advance flagg.
 
4223
                        advance_path = True  # reset the advance flagg.
3838
4224
                if current_block is not None:
3839
4225
                    block_index += 1
3840
4226
                    if (block_index < len(self.state._dirblocks) and
3841
 
                        osutils.is_inside(current_root, self.state._dirblocks[block_index][0])):
 
4227
                        osutils.is_inside(current_root,
 
4228
                                          self.state._dirblocks[block_index][0])):
3842
4229
                        current_block = self.state._dirblocks[block_index]
3843
4230
                    else:
3844
4231
                        current_block = None
3845
4232
                if current_dir_info is not None:
3846
4233
                    try:
3847
 
                        current_dir_info = dir_iterator.next()
 
4234
                        current_dir_info = next(dir_iterator)
3848
4235
                    except StopIteration:
3849
4236
                        current_dir_info = None
3850
4237
        for result in self._iter_specific_file_parents():
3872
4259
            found_item = False
3873
4260
            for candidate_entry in path_entries:
3874
4261
                # Find entries present in target at this path:
3875
 
                if candidate_entry[1][self.target_index][0] not in 'ar':
 
4262
                if candidate_entry[1][self.target_index][0] not in (b'a', b'r'):
3876
4263
                    found_item = True
3877
4264
                    selected_entries.append(candidate_entry)
3878
4265
                # Find entries present in source at this path:
3879
4266
                elif (self.source_index is not None and
3880
 
                    candidate_entry[1][self.source_index][0] not in 'ar'):
 
4267
                      candidate_entry[1][self.source_index][0] not in (b'a', b'r')):
3881
4268
                    found_item = True
3882
 
                    if candidate_entry[1][self.target_index][0] == 'a':
 
4269
                    if candidate_entry[1][self.target_index][0] == b'a':
3883
4270
                        # Deleted, emit it here.
3884
4271
                        selected_entries.append(candidate_entry)
3885
4272
                    else:
3890
4277
            if not found_item:
3891
4278
                raise AssertionError(
3892
4279
                    "Missing entry for specific path parent %r, %r" % (
3893
 
                    path_utf8, path_entries))
 
4280
                        path_utf8, path_entries))
3894
4281
            path_info = self._path_info(path_utf8, path_utf8.decode('utf8'))
3895
4282
            for entry in selected_entries:
3896
4283
                if entry[0][2] in self.seen_ids:
3900
4287
                    raise AssertionError(
3901
4288
                        "Got entry<->path mismatch for specific path "
3902
4289
                        "%r entry %r path_info %r " % (
3903
 
                        path_utf8, entry, path_info))
 
4290
                            path_utf8, entry, path_info))
3904
4291
                # Only include changes - we're outside the users requested
3905
4292
                # expansion.
3906
4293
                if changed:
3907
4294
                    self._gather_result_for_consistency(result)
3908
 
                    if (result[6][0] == 'directory' and
3909
 
                        result[6][1] != 'directory'):
 
4295
                    if (result.kind[0] == 'directory' and
 
4296
                            result.kind[1] != 'directory'):
3910
4297
                        # This stopped being a directory, the old children have
3911
4298
                        # to be included.
3912
 
                        if entry[1][self.source_index][0] == 'r':
 
4299
                        if entry[1][self.source_index][0] == b'r':
3913
4300
                            # renamed, take the source path
3914
4301
                            entry_path_utf8 = entry[1][self.source_index][1]
3915
4302
                        else:
3916
4303
                            entry_path_utf8 = path_utf8
3917
 
                        initial_key = (entry_path_utf8, '', '')
 
4304
                        initial_key = (entry_path_utf8, b'', b'')
3918
4305
                        block_index, _ = self.state._find_block_index_from_key(
3919
4306
                            initial_key)
3920
4307
                        if block_index == 0:
3921
4308
                            # The children of the root are in block index 1.
3922
 
                            block_index +=1
 
4309
                            block_index += 1
3923
4310
                        current_block = None
3924
4311
                        if block_index < len(self.state._dirblocks):
3925
4312
                            current_block = self.state._dirblocks[block_index]
3926
4313
                            if not osutils.is_inside(
3927
 
                                entry_path_utf8, current_block[0]):
 
4314
                                    entry_path_utf8, current_block[0]):
3928
4315
                                # No entries for this directory at all.
3929
4316
                                current_block = None
3930
4317
                        if current_block is not None:
3931
4318
                            for entry in current_block[1]:
3932
 
                                if entry[1][self.source_index][0] in 'ar':
 
4319
                                if entry[1][self.source_index][0] in (b'a', b'r'):
3933
4320
                                    # Not in the source tree, so doesn't have to be
3934
4321
                                    # included.
3935
4322
                                    continue
3949
4336
        abspath = self.tree.abspath(unicode_path)
3950
4337
        try:
3951
4338
            stat = os.lstat(abspath)
3952
 
        except OSError, e:
 
4339
        except OSError as e:
3953
4340
            if e.errno == errno.ENOENT:
3954
4341
                # the path does not exist.
3955
4342
                return None
3956
4343
            else:
3957
4344
                raise
3958
 
        utf8_basename = utf8_path.rsplit('/', 1)[-1]
 
4345
        utf8_basename = utf8_path.rsplit(b'/', 1)[-1]
3959
4346
        dir_info = (utf8_path, utf8_basename,
3960
 
            osutils.file_kind_from_stat_mode(stat.st_mode), stat,
3961
 
            abspath)
 
4347
                    osutils.file_kind_from_stat_mode(stat.st_mode), stat,
 
4348
                    abspath)
3962
4349
        if dir_info[2] == 'directory':
3963
4350
            if self.tree._directory_is_tree_reference(
3964
 
                unicode_path):
 
4351
                    unicode_path):
3965
4352
                self.root_dir_info = self.root_dir_info[:2] + \
3966
4353
                    ('tree-reference',) + self.root_dir_info[3:]
3967
4354
        return dir_info
3969
4356
 
3970
4357
# Try to load the compiled form if possible
3971
4358
try:
3972
 
    from bzrlib._dirstate_helpers_pyx import (
 
4359
    from ._dirstate_helpers_pyx import (
3973
4360
        _read_dirblocks,
3974
4361
        bisect_dirblock,
3975
4362
        _bisect_path_left,
3976
4363
        _bisect_path_right,
3977
 
        cmp_by_dirs,
 
4364
        lt_by_dirs,
 
4365
        pack_stat,
3978
4366
        ProcessEntryC as _process_entry,
3979
4367
        update_entry as update_entry,
3980
4368
        )
3981
 
except ImportError, e:
 
4369
except ImportError as e:
3982
4370
    osutils.failed_to_load_extension(e)
3983
 
    from bzrlib._dirstate_helpers_py import (
 
4371
    from ._dirstate_helpers_py import (
3984
4372
        _read_dirblocks,
3985
4373
        bisect_dirblock,
3986
4374
        _bisect_path_left,
3987
4375
        _bisect_path_right,
3988
 
        cmp_by_dirs,
 
4376
        lt_by_dirs,
 
4377
        pack_stat,
3989
4378
        )
3990
4379
    # FIXME: It would be nice to be able to track moved lines so that the
3991
4380
    # corresponding python code can be moved to the _dirstate_helpers_py