share/doc/gccint/Using-RTL-SSA.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1988-2023 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "Funding Free Software", the Front-Cover
Texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below).  A copy of the license is included in the section entitled
"GNU Free Documentation License".

(a) The FSF's Front-Cover Text is:

A GNU Manual

(b) The FSF's Back-Cover Text is:

You have freedom to copy and modify this GNU Manual, like GNU
     software.  Copies published by the Free Software Foundation raise
     funds for GNU development. -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Compiler Collection (GCC) Internals: Using RTL SSA</title>

<meta name="description" content="GNU Compiler Collection (GCC) Internals: Using RTL SSA">
<meta name="keywords" content="GNU Compiler Collection (GCC) Internals: Using RTL SSA">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="RTL-SSA.html#RTL-SSA" rel="up" title="RTL SSA">
<link href="RTL-SSA-Instructions.html#RTL-SSA-Instructions" rel="next" title="RTL SSA Instructions">
<link href="RTL-SSA.html#RTL-SSA" rel="previous" title="RTL SSA">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Using-RTL-SSA"></a>
<div class="header">
<p>
Next: <a href="RTL-SSA-Instructions.html#RTL-SSA-Instructions" accesskey="n" rel="next">RTL SSA Instructions</a>, Up: <a href="RTL-SSA.html#RTL-SSA" accesskey="u" rel="up">RTL SSA</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Using-RTL-SSA-in-a-pass"></a>
<h4 class="subsection">14.21.1 Using RTL SSA in a pass</h4>

<p>A pass that wants to use the RTL SSA form should start with the following:
</p>
<div class="smallexample">
<pre class="smallexample">#define INCLUDE_ALGORITHM
#define INCLUDE_FUNCTIONAL
#include &quot;config.h&quot;
#include &quot;system.h&quot;
#include &quot;coretypes.h&quot;
#include &quot;backend.h&quot;
#include &quot;rtl.h&quot;
#include &quot;df.h&quot;
#include &quot;rtl-ssa.h&quot;
</pre></div>

<p>All the RTL SSA code is contained in the <code>rtl_ssa</code> namespace,
so most passes will then want to do:
</p>
<div class="smallexample">
<pre class="smallexample">using namespace rtl_ssa;
</pre></div>

<p>However, this is purely a matter of taste, and the examples in the rest of
this section do not require it.
</p>
<p>The RTL SSA represention is an optional on-the-side feature that applies
on top of the normal RTL instructions.  It is currently local to individual
RTL passes and is not maintained across passes.
</p>
<p>However, in order to allow the RTL SSA information to be preserved across
passes in future, &lsquo;<samp>crtl-&gt;ssa</samp>&rsquo; points to the current function&rsquo;s
SSA form (if any).  Passes that want to use the RTL SSA form should
first do:
</p>
<div class="smallexample">
<pre class="smallexample">crtl-&gt;ssa = new rtl_ssa::function_info (<var>fn</var>);
</pre></div>

<p>where <var>fn</var> is the function that the pass is processing.
(Passes that are <code>using namespace rtl_ssa</code> do not need
the &lsquo;<samp>rtl_ssa::</samp>&rsquo;.)
</p>
<p>Once the pass has finished with the SSA form, it should do the following:
</p>
<div class="smallexample">
<pre class="smallexample">free_dominance_info (CDI_DOMINATORS);
if (crtl-&gt;ssa-&gt;perform_pending_updates ())
  cleanup_cfg (0);

delete crtl-&gt;ssa;
crtl-&gt;ssa = nullptr;
</pre></div>

<p>The <code>free_dominance_info</code> call is necessary because
dominance information is not currently maintained between RTL passes.
The next two lines commit any changes to the RTL instructions that
were queued for later; see the comment above the declaration of
<code>perform_pending_updates</code> for details.  The final two lines
discard the RTL SSA form and free the associated memory.
</p>
<hr>
<div class="header">
<p>
Next: <a href="RTL-SSA-Instructions.html#RTL-SSA-Instructions" accesskey="n" rel="next">RTL SSA Instructions</a>, Up: <a href="RTL-SSA.html#RTL-SSA" accesskey="u" rel="up">RTL SSA</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
</div>


</body>
</html>