Home My Page Projects Code Snippets Project Openings SML/NJ
Summary Activity Forums Tracker Lists Tasks Docs Surveys News SCM Files

SCM Repository

[smlnj] Annotation of /sml/trunk/src/MLRISC/flowgraph/cfg.sig
ViewVC logotype

Annotation of /sml/trunk/src/MLRISC/flowgraph/cfg.sig

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1084 - (view) (download) (as text)

1 : jhr 926 (* cfg.sig
2 :     *
3 :     * COPYRIGHT (c) 2001 Bell Labs, Lucent Technologies
4 :     *
5 : george 906 * Control flow graph data structure used by the MLRISC IR.
6 :     * All basic optimizations are based on this representation.
7 :     *
8 :     * -- Allen
9 :     *)
10 :    
11 :     signature CONTROL_FLOW_GRAPH =
12 :     sig
13 :    
14 :     structure P : PSEUDO_OPS
15 :     structure I : INSTRUCTIONS
16 :    
17 :     structure W : FREQ
18 :    
19 :     type weight = W.freq
20 :    
21 :     datatype block_kind =
22 :     START (* entry node *)
23 :     | STOP (* exit node *)
24 :     | NORMAL (* normal node *)
25 :    
26 :     (*
27 : george 984 * NOTE 1: the instructions are listed in reverse order.
28 : george 906 * This choice is for a few reasons:
29 :     *
30 :     * i) Clusters represent instructions in reverse order, so keeping this
31 :     * the same avoid having to do conversions.
32 :     *
33 :     * ii) This makes it easier to add instructions at the end of the block,
34 :     * which is more common than adding instructions to the front.
35 :     *
36 :     * iii) This also makes it easier to manipulate the branch/jump instruction
37 :     * at the end of the block.
38 : george 984 *
39 :     * NOTE 2:
40 :     * Alignment always appear before labels in a block.
41 : george 906 *)
42 :    
43 :     and block =
44 :     BLOCK of
45 :     { id : int, (* block id *)
46 :     kind : block_kind, (* block kind *)
47 :     freq : weight ref, (* execution frequency *)
48 :     labels : Label.label list ref, (* labels on blocks *)
49 :     insns : I.instruction list ref, (* in rev order *)
50 : george 984 align : P.pseudo_op option ref, (* alignment only *)
51 : george 906 annotations : Annotations.annotations ref (* annotations *)
52 :     }
53 :    
54 :    
55 : jhr 1084 (* We have the following invariant on blocks and out-edge kinds:
56 :     *
57 :     * If the last instruction of the block is an unconditional jump, then
58 :     * there is one out edge labeled with JUMP.
59 :     *
60 :     * If the last instruction of the block is a conditional jump, then
61 :     * there are two out edges. The one corresponding to the jump is
62 :     * labeled BRANCH(true) and the other is labeled BRANCH(false).
63 :     *
64 :     * If the last instruction of the block is not a jump, then there is
65 :     * one out edge labeled with FALLSTHRU.
66 :     *
67 :     * If the block ends with a switch, then the out edges are labeled with
68 :     * SWITCH.
69 :     *
70 :     * If the block ends with a call that has been wrapped with a FLOW_TO,
71 :     * then there will be one FALLSTHRU out edges and one or more FLOWSTO
72 :     * out edges.
73 :     *)
74 :     and edge_kind (* edge kinds *)
75 :     = ENTRY (* entry edge *)
76 :     | EXIT (* exit edge *)
77 :     | JUMP (* unconditional jump *)
78 :     | FALLSTHRU (* falls through to next block *)
79 :     | BRANCH of bool (* branch *)
80 :     | SWITCH of int (* computed goto *)
81 :     | FLOWSTO (* FLOW_TO edge *)
82 :    
83 :     and edge_info = EDGE of {
84 :     k : edge_kind, (* edge kind *)
85 :     w : weight ref, (* edge freq *)
86 :     a : Annotations.annotations ref (* annotations *)
87 :     }
88 : george 906
89 :     type edge = edge_info Graph.edge
90 :     type node = block Graph.node
91 :    
92 :     datatype info =
93 :     INFO of { annotations : Annotations.annotations ref,
94 :     firstBlock : int ref, (* id of first block *)
95 : george 984 reorder : bool ref, (* has the CFG been reordered? *)
96 :     data : P.pseudo_op list ref (* reverse order of generation *)
97 : george 906 }
98 :    
99 :     type cfg = (block,edge_info,info) Graph.graph
100 :    
101 :     (*========================================================================
102 :     *
103 :     * Various kinds of annotations on basic blocks
104 :     *
105 :     *========================================================================*)
106 :     val LIVEOUT : I.C.cellset Annotations.property
107 :     (* escaping live out information *)
108 :     val CHANGED : (string * (unit -> unit)) Annotations.property
109 :    
110 :     (*========================================================================
111 :     *
112 :     * Methods for manipulating basic blocks
113 :     *
114 :     *========================================================================*)
115 :     val newBlock : int * W.freq ref -> block (* empty *)
116 :     val newStart : int * W.freq ref -> block (* start node *)
117 :     val newStop : int * W.freq ref -> block (* stop node *)
118 :     val copyBlock : int * block -> block (* copy a block *)
119 :     val defineLabel : block -> Label.label (* define a label *)
120 :     val insns : block -> I.instruction list ref
121 :     val freq : block -> W.freq ref
122 :     val branchOf : edge_info -> bool option
123 :    
124 :     (* emit assembly *)
125 : jhr 926 val emit : Annotations.annotations -> block -> unit
126 : george 906
127 :     (*========================================================================
128 :     *
129 :     * Methods for manipulating CFG
130 :     *
131 :     *========================================================================*)
132 :     val cfg : info -> cfg (* create a new cfg *)
133 :     val new : unit -> cfg (* create a new cfg *)
134 :     val subgraph : cfg -> cfg (* mark as subgraph *)
135 :     val init : cfg -> unit (* add start/stop nodes *)
136 :     val changed : cfg -> unit (* mark cfg as changed *)
137 :    
138 :     val annotations : cfg -> Annotations.annotations ref
139 :     val liveOut : block -> I.C.cellset
140 :     val fallsThruFrom : cfg * Graph.node_id -> Graph.node_id option
141 :     val fallsThruTo : cfg * Graph.node_id -> Graph.node_id option
142 :     val removeEdge : cfg -> edge -> unit
143 :     val setBranch : cfg * Graph.node_id * bool -> I.instruction
144 :     val edgeDir : edge_info Graph.edge -> bool option
145 :    
146 :     (*========================================================================
147 :     *
148 :     * For viewing
149 :     *
150 :     *========================================================================*)
151 :     (*****
152 :     val viewStyle : cfg -> (block,edge_info,info) GraphLayout.style
153 :     val viewLayout : cfg -> GraphLayout.layout
154 :     val headerText : block -> string
155 :     val footerText : block -> string
156 :     val subgraphLayout : { cfg : cfg, subgraph : cfg } -> GraphLayout.layout
157 :     *****)
158 :    
159 :     (*========================================================================
160 :     *
161 :     * Miscellaneous stuff
162 :     *
163 :     *========================================================================*)
164 :     val cdgEdge : edge_info -> bool (* for building a CDG *)
165 :    
166 : jhr 926 (*========================================================================
167 :     *
168 :     * Methods for printing CFGs
169 :     *
170 :     *========================================================================*)
171 :     val show_block : Annotations.annotations -> block -> string
172 :     val show_edge : edge_info -> string
173 :    
174 : george 906 end
175 :    

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0