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 984 - (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 :     | HYPERBLOCK (* hyperblock *)
26 :    
27 :     (*
28 : george 984 * NOTE 1: the instructions are listed in reverse order.
29 : george 906 * This choice is for a few reasons:
30 :     *
31 :     * i) Clusters represent instructions in reverse order, so keeping this
32 :     * the same avoid having to do conversions.
33 :     *
34 :     * ii) This makes it easier to add instructions at the end of the block,
35 :     * which is more common than adding instructions to the front.
36 :     *
37 :     * iii) This also makes it easier to manipulate the branch/jump instruction
38 :     * at the end of the block.
39 : george 984 *
40 :     * NOTE 2:
41 :     * Alignment always appear before labels in a block.
42 : george 906 *)
43 :    
44 :     and block =
45 :     BLOCK of
46 :     { id : int, (* block id *)
47 :     kind : block_kind, (* block kind *)
48 :     freq : weight ref, (* execution frequency *)
49 :     labels : Label.label list ref, (* labels on blocks *)
50 :     insns : I.instruction list ref, (* in rev order *)
51 : george 984 align : P.pseudo_op option ref, (* alignment only *)
52 : george 906 annotations : Annotations.annotations ref (* annotations *)
53 :     }
54 :    
55 :    
56 :     and edge_kind = ENTRY (* entry edge *)
57 :     | EXIT (* exit edge *)
58 :     | JUMP (* unconditional jump *)
59 :     | FALLSTHRU (* falls through to next block *)
60 :     | BRANCH of bool (* branch *)
61 :     | SWITCH of int (* computed goto *)
62 :     | SIDEEXIT of int (* the ith side exit in a hyperblock *)
63 :    
64 :     and edge_info = EDGE of { k : edge_kind, (* edge kind *)
65 :     w : weight ref, (* edge freq *)
66 :     a : Annotations.annotations ref (* annotations *)
67 :     }
68 :    
69 :     type edge = edge_info Graph.edge
70 :     type node = block Graph.node
71 :    
72 :     datatype info =
73 :     INFO of { annotations : Annotations.annotations ref,
74 :     firstBlock : int ref, (* id of first block *)
75 : george 984 reorder : bool ref, (* has the CFG been reordered? *)
76 :     data : P.pseudo_op list ref (* reverse order of generation *)
77 : george 906 }
78 :    
79 :     type cfg = (block,edge_info,info) Graph.graph
80 :    
81 :     (*========================================================================
82 :     *
83 :     * Various kinds of annotations on basic blocks
84 :     *
85 :     *========================================================================*)
86 :     val LIVEOUT : I.C.cellset Annotations.property
87 :     (* escaping live out information *)
88 :     val CHANGED : (string * (unit -> unit)) Annotations.property
89 :    
90 :     (*========================================================================
91 :     *
92 :     * Methods for manipulating basic blocks
93 :     *
94 :     *========================================================================*)
95 :     val newBlock : int * W.freq ref -> block (* empty *)
96 :     val newStart : int * W.freq ref -> block (* start node *)
97 :     val newStop : int * W.freq ref -> block (* stop node *)
98 :     val copyBlock : int * block -> block (* copy a block *)
99 :     val defineLabel : block -> Label.label (* define a label *)
100 :     val insns : block -> I.instruction list ref
101 :     val freq : block -> W.freq ref
102 :     val branchOf : edge_info -> bool option
103 :    
104 :     (* emit assembly *)
105 : jhr 926 val emit : Annotations.annotations -> block -> unit
106 : george 906
107 :     (*========================================================================
108 :     *
109 :     * Methods for manipulating CFG
110 :     *
111 :     *========================================================================*)
112 :     val cfg : info -> cfg (* create a new cfg *)
113 :     val new : unit -> cfg (* create a new cfg *)
114 :     val subgraph : cfg -> cfg (* mark as subgraph *)
115 :     val init : cfg -> unit (* add start/stop nodes *)
116 :     val changed : cfg -> unit (* mark cfg as changed *)
117 :    
118 :     val annotations : cfg -> Annotations.annotations ref
119 :     val liveOut : block -> I.C.cellset
120 :     val fallsThruFrom : cfg * Graph.node_id -> Graph.node_id option
121 :     val fallsThruTo : cfg * Graph.node_id -> Graph.node_id option
122 :     val removeEdge : cfg -> edge -> unit
123 :     val setBranch : cfg * Graph.node_id * bool -> I.instruction
124 :     val edgeDir : edge_info Graph.edge -> bool option
125 :    
126 :     (*========================================================================
127 :     *
128 :     * For viewing
129 :     *
130 :     *========================================================================*)
131 :     (*****
132 :     val viewStyle : cfg -> (block,edge_info,info) GraphLayout.style
133 :     val viewLayout : cfg -> GraphLayout.layout
134 :     val headerText : block -> string
135 :     val footerText : block -> string
136 :     val subgraphLayout : { cfg : cfg, subgraph : cfg } -> GraphLayout.layout
137 :     *****)
138 :    
139 :     (*========================================================================
140 :     *
141 :     * Miscellaneous stuff
142 :     *
143 :     *========================================================================*)
144 :     val cdgEdge : edge_info -> bool (* for building a CDG *)
145 :    
146 : jhr 926 (*========================================================================
147 :     *
148 :     * Methods for printing CFGs
149 :     *
150 :     *========================================================================*)
151 :     val show_block : Annotations.annotations -> block -> string
152 :     val show_edge : edge_info -> string
153 :    
154 : george 906 end
155 :    

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