~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tsort.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
"""Topological sorting routines."""
19
19
 
20
20
 
21
 
from bzrlib import errors
22
 
import bzrlib.revision as _mod_revision
 
21
from bzrlib import (
 
22
    errors,
 
23
    graph as _mod_graph,
 
24
    revision as _mod_revision,
 
25
    )
23
26
 
24
27
 
25
28
__all__ = ["topo_sort", "TopoSorter", "merge_sort", "MergeSorter"]
30
33
 
31
34
    graph -- sequence of pairs of node->parents_list.
32
35
 
33
 
    The result is a list of node names, such that all parents come before
34
 
    their children.
 
36
    The result is a list of node names, such that all parents come before their
 
37
    children.
35
38
 
36
39
    node identifiers can be any hashable object, and are typically strings.
 
40
 
 
41
    This function has the same purpose as the TopoSorter class, but uses a
 
42
    different algorithm to sort the graph. That means that while both return a
 
43
    list with parents before their child nodes, the exact ordering can be
 
44
    different.
 
45
 
 
46
    topo_sort is faster when the whole list is needed, while when iterating
 
47
    over a part of the list, TopoSorter.iter_topo_order should be used.
37
48
    """
38
 
    return TopoSorter(graph).sorted()
 
49
    kg = _mod_graph.KnownGraph(dict(graph))
 
50
    return kg.topo_sort()
39
51
 
40
52
 
41
53
class TopoSorter(object):
42
54
 
43
55
    def __init__(self, graph):
44
56
        """Topological sorting of a graph.
45
 
    
 
57
 
46
58
        :param graph: sequence of pairs of node_name->parent_names_list.
47
59
                      i.e. [('C', ['B']), ('B', ['A']), ('A', [])]
48
60
                      For this input the output from the sort or
49
61
                      iter_topo_order routines will be:
50
62
                      'A', 'B', 'C'
51
 
        
 
63
 
52
64
        node identifiers can be any hashable object, and are typically strings.
53
65
 
54
66
        If you have a graph like [('a', ['b']), ('a', ['c'])] this will only use
57
69
        The graph is sorted lazily: until you iterate or sort the input is
58
70
        not processed other than to create an internal representation.
59
71
 
60
 
        iteration or sorting may raise GraphCycleError if a cycle is present 
 
72
        iteration or sorting may raise GraphCycleError if a cycle is present
61
73
        in the graph.
62
74
        """
63
 
        # a dict of the graph.
 
75
        # store a dict of the graph.
64
76
        self._graph = dict(graph)
65
 
        self._visitable = set(self._graph)
66
 
        ### if debugging:
67
 
        # self._original_graph = dict(graph)
68
 
        
69
 
        # this is a stack storing the depth first search into the graph.
70
 
        self._node_name_stack = []
71
 
        # at each level of 'recursion' we have to check each parent. This
72
 
        # stack stores the parents we have not yet checked for the node at the 
73
 
        # matching depth in _node_name_stack
74
 
        self._pending_parents_stack = []
75
 
        # this is a set of the completed nodes for fast checking whether a
76
 
        # parent in a node we are processing on the stack has already been
77
 
        # emitted and thus can be skipped.
78
 
        self._completed_node_names = set()
79
77
 
80
78
    def sorted(self):
81
79
        """Sort the graph and return as a list.
82
 
        
 
80
 
83
81
        After calling this the sorter is empty and you must create a new one.
84
82
        """
85
83
        return list(self.iter_topo_order())
96
94
 
97
95
    def iter_topo_order(self):
98
96
        """Yield the nodes of the graph in a topological order.
99
 
        
 
97
 
100
98
        After finishing iteration the sorter is empty and you cannot continue
101
99
        iteration.
102
100
        """
103
 
        while self._graph:
 
101
        graph = self._graph
 
102
        visitable = set(graph)
 
103
 
 
104
        # this is a stack storing the depth first search into the graph.
 
105
        pending_node_stack = []
 
106
        # at each level of 'recursion' we have to check each parent. This
 
107
        # stack stores the parents we have not yet checked for the node at the
 
108
        # matching depth in pending_node_stack
 
109
        pending_parents_stack = []
 
110
 
 
111
        # this is a set of the completed nodes for fast checking whether a
 
112
        # parent in a node we are processing on the stack has already been
 
113
        # emitted and thus can be skipped.
 
114
        completed_node_names = set()
 
115
 
 
116
        while graph:
104
117
            # now pick a random node in the source graph, and transfer it to the
105
 
            # top of the depth first search stack.
106
 
            node_name, parents = self._graph.popitem()
107
 
            self._push_node(node_name, parents)
108
 
            while self._node_name_stack:
109
 
                # loop until this call completes.
110
 
                parents_to_visit = self._pending_parents_stack[-1]
111
 
                # if all parents are done, the revision is done
 
118
            # top of the depth first search stack of pending nodes.
 
119
            node_name, parents = graph.popitem()
 
120
            pending_node_stack.append(node_name)
 
121
            pending_parents_stack.append(list(parents))
 
122
 
 
123
            # loop until pending_node_stack is empty
 
124
            while pending_node_stack:
 
125
                parents_to_visit = pending_parents_stack[-1]
 
126
                # if there are no parents left, the revision is done
112
127
                if not parents_to_visit:
113
128
                    # append the revision to the topo sorted list
114
 
                    # all the nodes parents have been added to the output, now
115
 
                    # we can add it to the output.
116
 
                    yield self._pop_node()
 
129
                    # all the nodes parents have been added to the output,
 
130
                    # now we can add it to the output.
 
131
                    popped_node = pending_node_stack.pop()
 
132
                    pending_parents_stack.pop()
 
133
                    completed_node_names.add(popped_node)
 
134
                    yield popped_node
117
135
                else:
118
 
                    while self._pending_parents_stack[-1]:
119
 
                        # recurse depth first into a single parent 
120
 
                        next_node_name = self._pending_parents_stack[-1].pop()
121
 
                        if next_node_name in self._completed_node_names:
122
 
                            # this parent was completed by a child on the
123
 
                            # call stack. skip it.
124
 
                            continue
125
 
                        if next_node_name not in self._visitable:
126
 
                            continue
127
 
                        # otherwise transfer it from the source graph into the
128
 
                        # top of the current depth first search stack.
129
 
                        try:
130
 
                            parents = self._graph.pop(next_node_name)
131
 
                        except KeyError:
132
 
                            # if the next node is not in the source graph it has
133
 
                            # already been popped from it and placed into the
134
 
                            # current search stack (but not completed or we would
135
 
                            # have hit the continue 4 lines up.
136
 
                            # this indicates a cycle.
137
 
                            raise errors.GraphCycleError(self._node_name_stack)
138
 
                        self._push_node(next_node_name, parents)
139
 
                        # and do not continue processing parents until this 'call' 
140
 
                        # has recursed.
141
 
                        break
142
 
 
143
 
    def _push_node(self, node_name, parents):
144
 
        """Add node_name to the pending node stack.
145
 
        
146
 
        Names in this stack will get emitted into the output as they are popped
147
 
        off the stack.
148
 
        """
149
 
        self._node_name_stack.append(node_name)
150
 
        self._pending_parents_stack.append(list(parents))
151
 
 
152
 
    def _pop_node(self):
153
 
        """Pop the top node off the stack 
154
 
 
155
 
        The node is appended to the sorted output.
156
 
        """
157
 
        # we are returning from the flattened call frame:
158
 
        # pop off the local variables
159
 
        node_name = self._node_name_stack.pop()
160
 
        self._pending_parents_stack.pop()
161
 
 
162
 
        self._completed_node_names.add(node_name)
163
 
        return node_name
 
136
                    # recurse depth first into a single parent
 
137
                    next_node_name = parents_to_visit.pop()
 
138
 
 
139
                    if next_node_name in completed_node_names:
 
140
                        # parent was already completed by a child, skip it.
 
141
                        continue
 
142
                    if next_node_name not in visitable:
 
143
                        # parent is not a node in the original graph, skip it.
 
144
                        continue
 
145
 
 
146
                    # transfer it along with its parents from the source graph
 
147
                    # into the top of the current depth first search stack.
 
148
                    try:
 
149
                        parents = graph.pop(next_node_name)
 
150
                    except KeyError:
 
151
                        # if the next node is not in the source graph it has
 
152
                        # already been popped from it and placed into the
 
153
                        # current search stack (but not completed or we would
 
154
                        # have hit the continue 6 lines up).  this indicates a
 
155
                        # cycle.
 
156
                        raise errors.GraphCycleError(pending_node_stack)
 
157
                    pending_node_stack.append(next_node_name)
 
158
                    pending_parents_stack.append(list(parents))
164
159
 
165
160
 
166
161
def merge_sort(graph, branch_tip, mainline_revisions=None, generate_revno=False):
167
162
    """Topological sort a graph which groups merges.
168
163
 
169
164
    :param graph: sequence of pairs of node->parents_list.
170
 
    :param branch_tip: the tip of the branch to graph. Revisions not 
 
165
    :param branch_tip: the tip of the branch to graph. Revisions not
171
166
                       reachable from branch_tip are not included in the
172
167
                       output.
173
168
    :param mainline_revisions: If not None this forces a mainline to be
182
177
        revision number sequences in the output. See the output description of
183
178
        the MergeSorter docstring for details.
184
179
    :result: See the MergeSorter docstring for details.
185
 
    node identifiers can be any hashable object, and are typically strings.
 
180
 
 
181
    Node identifiers can be any hashable object, and are typically strings.
186
182
    """
187
183
    return MergeSorter(graph, branch_tip, mainline_revisions,
188
184
        generate_revno).sorted()
209
205
    def __init__(self, graph, branch_tip, mainline_revisions=None,
210
206
        generate_revno=False):
211
207
        """Merge-aware topological sorting of a graph.
212
 
    
 
208
 
213
209
        :param graph: sequence of pairs of node_name->parent_names_list.
214
210
                      i.e. [('C', ['B']), ('B', ['A']), ('A', [])]
215
211
                      For this input the output from the sort or
216
212
                      iter_topo_order routines will be:
217
213
                      'A', 'B', 'C'
218
 
        :param branch_tip: the tip of the branch to graph. Revisions not 
 
214
        :param branch_tip: the tip of the branch to graph. Revisions not
219
215
                       reachable from branch_tip are not included in the
220
216
                       output.
221
217
        :param mainline_revisions: If not None this forces a mainline to be
233
229
        The result is a list sorted so that all parents come before
234
230
        their children. Each element of the list is a tuple containing:
235
231
        (sequence_number, node_name, merge_depth, end_of_merge)
236
 
         * sequence_number: The sequence of this row in the output. Useful for 
 
232
         * sequence_number: The sequence of this row in the output. Useful for
237
233
           GUIs.
238
234
         * node_name: The node name: opaque text to the merge routine.
239
235
         * merge_depth: How many levels of merging deep this node has been
250
246
             second commit in the trunk'.
251
247
         * end_of_merge: When True the next node is part of a different merge.
252
248
 
253
 
        
 
249
 
254
250
        node identifiers can be any hashable object, and are typically strings.
255
251
 
256
252
        If you have a graph like [('a', ['b']), ('a', ['c'])] this will only use
259
255
        The graph is sorted lazily: until you iterate or sort the input is
260
256
        not processed other than to create an internal representation.
261
257
 
262
 
        iteration or sorting may raise GraphCycleError if a cycle is present 
 
258
        iteration or sorting may raise GraphCycleError if a cycle is present
263
259
        in the graph.
264
260
 
265
261
        Background information on the design:
284
280
              E  1   [F]
285
281
              F 0
286
282
              C is the end of a cluster due to rule 1.
287
 
              D is not the end of a cluster from rule 1, but is from rule 2: E 
 
283
              D is not the end of a cluster from rule 1, but is from rule 2: E
288
284
                is not its left most ancestor
289
285
              E is the end of a cluster due to rule 1
290
286
              F might be but we need more data.
291
 
              
 
287
 
292
288
        we show connecting lines to a parent when:
293
289
         - The parent is the start of a merge within this cluster.
294
 
           That is, the merge was not done to the mainline before this cluster 
 
290
           That is, the merge was not done to the mainline before this cluster
295
291
           was merged to the mainline.
296
292
           This can be detected thus:
297
 
            * The parent has a higher merge depth and is the next revision in 
 
293
            * The parent has a higher merge depth and is the next revision in
298
294
              the list.
299
 
          
 
295
 
300
296
          The next revision in the list constraint is needed for this case:
301
 
          A 0   [D, B]   
302
 
          B  1  [C, F]   # we do not want to show a line to F which is depth 2 
 
297
          A 0   [D, B]
 
298
          B  1  [C, F]   # we do not want to show a line to F which is depth 2
303
299
                           but not a merge
304
 
          C  1  [H]      # note that this is a long line to show back to the 
 
300
          C  1  [H]      # note that this is a long line to show back to the
305
301
                           ancestor - see the end of merge rules.
306
302
          D 0   [G, E]
307
303
          E  1  [G, F]
342
338
        else:
343
339
            self._mainline_revisions = list(mainline_revisions)
344
340
            self._stop_revision = self._mainline_revisions[0]
345
 
        # skip the first revision, its what we reach and its parents are 
 
341
        # skip the first revision, its what we reach and its parents are
346
342
        # therefore irrelevant
347
343
        for index, revision in enumerate(self._mainline_revisions[1:]):
348
344
            # NB: index 0 means self._mainline_revisions[1]
378
374
                            for revision in self._graph)
379
375
        # Each mainline revision counts how many child branches have spawned from it.
380
376
        self._revno_to_branch_count = {}
381
 
        
 
377
 
382
378
        # this is a stack storing the depth first search into the graph.
383
379
        self._node_name_stack = []
384
380
        # at each level of recursion we need the merge depth this node is at:
385
381
        self._node_merge_depth_stack = []
386
382
        # at each level of 'recursion' we have to check each parent. This
387
 
        # stack stores the parents we have not yet checked for the node at the 
 
383
        # stack stores the parents we have not yet checked for the node at the
388
384
        # matching depth in _node_name_stack
389
385
        self._pending_parents_stack = []
390
386
        # When we first look at a node we assign it a seqence number from its
402
398
        # D 0  [F, E]
403
399
        # E  1 [F]
404
400
        # F 0
405
 
        # the scheduling order is: F, E, D, C, B, A 
 
401
        # the scheduling order is: F, E, D, C, B, A
406
402
        # that is - 'left subtree, right subtree, node'
407
403
        # which would mean that when we schedule A we can emit the entire tree.
408
404
        self._scheduled_nodes = []
409
 
        # This records for each node when we have processed its left most 
 
405
        # This records for each node when we have processed its left most
410
406
        # unmerged subtree. After this subtree is scheduled, all other subtrees
411
407
        # have their merge depth increased by one from this nodes merge depth.
412
408
        # it contains tuples - name, merge_depth
414
410
 
415
411
        # seed the search with the tip of the branch
416
412
        if (branch_tip is not None and
417
 
            branch_tip != _mod_revision.NULL_REVISION):
 
413
            branch_tip != _mod_revision.NULL_REVISION and
 
414
            branch_tip != (_mod_revision.NULL_REVISION,)):
418
415
            parents = self._graph.pop(branch_tip)
419
416
            self._push_node(branch_tip, 0, parents)
420
417
 
421
418
    def sorted(self):
422
419
        """Sort the graph and return as a list.
423
 
        
 
420
 
424
421
        After calling this the sorter is empty and you must create a new one.
425
422
        """
426
423
        return list(self.iter_topo_order())
427
424
 
428
425
    def iter_topo_order(self):
429
426
        """Yield the nodes of the graph in a topological order.
430
 
        
 
427
 
431
428
        After finishing iteration the sorter is empty and you cannot continue
432
429
        iteration.
433
430
        """
463
460
            left_subtree_pushed_stack_append(False)
464
461
            pending_parents_stack_append(list(parents))
465
462
            # as we push it, check if it is the first child
 
463
            parent_info = None
466
464
            if parents:
467
465
                # node has parents, assign from the left most parent.
468
 
                parent_info = revnos[parents[0]]
 
466
                try:
 
467
                    parent_info = revnos[parents[0]]
 
468
                except KeyError:
 
469
                    # Left-hand parent is a ghost, consider it not to exist
 
470
                    pass
 
471
            if parent_info is not None:
469
472
                first_child = parent_info[1]
470
473
                parent_info[1] = False
471
474
            else:
499
502
            pending_parents_stack_pop()
500
503
 
501
504
            parents = original_graph[node_name]
 
505
            parent_revno = None
502
506
            if parents:
503
507
                # node has parents, assign from the left most parent.
504
 
                parent_revno = revnos[parents[0]][0]
 
508
                try:
 
509
                    parent_revno = revnos[parents[0]][0]
 
510
                except KeyError:
 
511
                    # left-hand parent is a ghost, treat it as not existing
 
512
                    pass
 
513
            if parent_revno is not None:
505
514
                if not first_child:
506
515
                    # not the first child, make a new branch
507
516
                    base_revno = parent_revno[0]
545
554
                    if not left_subtree_pushed_stack[-1]:
546
555
                        # recurse depth first into the primary parent
547
556
                        next_node_name = pending_parents_stack[-1].pop(0)
 
557
                        is_left_subtree = True
 
558
                        left_subtree_pushed_stack[-1] = True
548
559
                    else:
549
560
                        # place any merges in right-to-left order for scheduling
550
561
                        # which gives us left-to-right order after we reverse
551
 
                        # the scheduled queue. XXX: This has the effect of 
 
562
                        # the scheduled queue. XXX: This has the effect of
552
563
                        # allocating common-new revisions to the right-most
553
 
                        # subtree rather than the left most, which will 
 
564
                        # subtree rather than the left most, which will
554
565
                        # display nicely (you get smaller trees at the top
555
566
                        # of the combined merge).
556
567
                        next_node_name = pending_parents_stack[-1].pop()
 
568
                        is_left_subtree = False
557
569
                    if next_node_name in completed_node_names:
558
570
                        # this parent was completed by a child on the
559
571
                        # call stack. skip it.
568
580
                        # current search stack (but not completed or we would
569
581
                        # have hit the continue 4 lines up.
570
582
                        # this indicates a cycle.
571
 
                        raise errors.GraphCycleError(node_name_stack)
 
583
                        if next_node_name in self._original_graph:
 
584
                            raise errors.GraphCycleError(node_name_stack)
 
585
                        else:
 
586
                            # This is just a ghost parent, ignore it
 
587
                            continue
572
588
                    next_merge_depth = 0
573
 
                    if left_subtree_pushed_stack[-1]:
 
589
                    if is_left_subtree:
574
590
                        # a new child branch from name_stack[-1]
 
591
                        next_merge_depth = 0
 
592
                    else:
575
593
                        next_merge_depth = 1
576
 
                    else:
577
 
                        next_merge_depth = 0
578
 
                        left_subtree_pushed_stack[-1] = True
579
594
                    next_merge_depth = (
580
595
                        node_merge_depth_stack[-1] + next_merge_depth)
581
596
                    push_node(
582
597
                        next_node_name,
583
598
                        next_merge_depth,
584
599
                        parents)
585
 
                    # and do not continue processing parents until this 'call' 
 
600
                    # and do not continue processing parents until this 'call'
586
601
                    # has recursed.
587
602
                    break
588
603
 
617
632
 
618
633
    def _push_node(self, node_name, merge_depth, parents):
619
634
        """Add node_name to the pending node stack.
620
 
        
 
635
 
621
636
        Names in this stack will get emitted into the output as they are popped
622
637
        off the stack.
623
638
        """
626
641
        self._left_subtree_pushed_stack.append(False)
627
642
        self._pending_parents_stack.append(list(parents))
628
643
        # as we push it, figure out if this is the first child
629
 
        parents = self._original_graph[node_name]
 
644
        parent_info = None
630
645
        if parents:
631
646
            # node has parents, assign from the left most parent.
632
 
            parent_info = self._revnos[parents[0]]
 
647
            try:
 
648
                parent_info = self._revnos[parents[0]]
 
649
            except KeyError:
 
650
                # Left-hand parent is a ghost, consider it not to exist
 
651
                pass
 
652
        if parent_info is not None:
633
653
            first_child = parent_info[1]
634
654
            parent_info[1] = False
635
655
        else:
639
659
        self._first_child_stack.append(first_child)
640
660
 
641
661
    def _pop_node(self):
642
 
        """Pop the top node off the stack 
 
662
        """Pop the top node off the stack
643
663
 
644
664
        The node is appended to the sorted output.
645
665
        """
653
673
        self._pending_parents_stack.pop()
654
674
 
655
675
        parents = self._original_graph[node_name]
 
676
        parent_revno = None
656
677
        if parents:
657
678
            # node has parents, assign from the left most parent.
658
 
            parent_revno = self._revnos[parents[0]][0]
 
679
            try:
 
680
                parent_revno = self._revnos[parents[0]][0]
 
681
            except KeyError:
 
682
                # left-hand parent is a ghost, treat it as not existing
 
683
                pass
 
684
        if parent_revno is not None:
659
685
            if not first_child:
660
686
                # not the first child, make a new branch
661
687
                base_revno = parent_revno[0]
671
697
        else:
672
698
            # no parents, use the root sequence
673
699
            root_count = self._revno_to_branch_count.get(0, 0)
 
700
            root_count = self._revno_to_branch_count.get(0, -1)
 
701
            root_count += 1
674
702
            if root_count:
675
703
                revno = (0, root_count, 1)
676
704
            else:
677
705
                revno = (1,)
678
 
            root_count += 1
679
706
            self._revno_to_branch_count[0] = root_count
680
707
 
681
708
        # store the revno for this node for future reference