Add brainstorm for a random test vector generator
[oota-llvm.git] / docs / OpenProjects.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2                       "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5   <title>Open LLVM Projects</title>
6   <link rel="stylesheet" href="llvm.css" type="text/css">
7 </head>
8 <body>
9
10 <div class="doc_title">
11   Open LLVM Projects
12 </div>
13
14 <ul>
15   <li><a href="#what">What is this?</a></li>
16   <li><a href="#improving">Improving the current system</a>
17   <ol>
18     <li><a href="#glibc">Port glibc to LLVM</a></li>
19     <li><a href="#NightlyTest">Improving the Nightly Tester</a></li>
20     <li><a href="#programs">Compile programs with the LLVM Compiler</a></li>
21     <li><a href="#llvm_ir">Extend the LLVM intermediate representation</a></li>
22     <li><a href="#misc_imp">Miscellaneous Improvements</a></li>
23   </ol></li>
24
25   <li><a href="#new">Adding new capabilities to LLVM</a>
26   <ol>
27     <li><a href="#pointeranalysis">Pointer and Alias Analysis</a></li>
28     <li><a href="#profileguided">Profile Guided Optimization</a></li>
29     <li><a href="#xforms">New Transformations and Analyses</a></li>
30     <li><a href="#x86be">X86 Back-end Improvements</a></li>
31     <li><a href="#misc_new">Miscellaneous Additions</a></li>
32   </ol></li>
33 </ul>
34
35 <!-- *********************************************************************** -->
36 <div class="doc_section">
37   <a name="what">What is this?</a>
38 </div>
39 <!-- *********************************************************************** -->
40
41 <div class="doc_text">
42
43 <p>This document is meant to be a sort of "big TODO list" for LLVM.  Each
44 project in this document is something that would be useful for LLVM to have, and
45 would also be a great way to get familiar with the system.  Some of these
46 projects are small and self-contained, which may be implemented in a couple of
47 days, others are larger.  Several of these projects may lead to interesting
48 research projects in their own right.  In any case, we welcome all
49 contributions.</p>
50
51 <p>If you are thinking about tackling one of these projects, please send a mail
52 to the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM
53 Developer's</a> mailing list, so that we know the project is being worked on.
54 Additionally this is a good way to get more information about a specific project
55 or to suggest other projects to add to this page.  Another good place to look
56 for ideas is the <a href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug
57 tracker</a>.</p>
58
59 </div>
60
61 <!-- *********************************************************************** -->
62 <div class="doc_section">
63   <a name="improving">Improving the current system</a>
64 </div>
65 <!-- *********************************************************************** -->
66
67 <div class="doc_text">
68
69 <p>Improvements to the current infrastructure are always very welcome and tend
70 to be fairly straight-forward to implement.  Here are some of the key areas that
71 can use improvement...</p>
72
73 </div>
74
75 <!-- ======================================================================= -->
76 <div class="doc_subsection">
77   <a name="glibc">Port glibc to LLVM</a>
78 </div>
79
80 <div class="doc_text">
81
82 <p>It would be very useful to <a
83 href="http://www.gnu.org/software/libc/porting.html">port</a> <a
84 href="http://www.gnu.org/software/glibc/">glibc</a> to LLVM.  This would allow a
85 variety of interprocedural algorithms to be much more effective in the face of
86 library calls.  The most important pieces to port are things like the string
87 library and the <tt>stdio</tt> related functions... low-level system calls like
88 '<tt>read</tt>' should stay unimplemented in LLVM.</p>
89
90 </div>
91
92 <!-- ======================================================================= -->
93 <div class="doc_subsection">
94   <a name="NightlyTest">Improving the Nightly Tester</a>
95 </div>
96
97 <div class="doc_text">
98
99 <p>The <a href="/testresults/">Nightly Tester</a> is a simple perl script
100 (located in <tt>utils/NightlyTest.pl</tt>) which runs every night to generate a
101 daily report.  It could use the following improvements:</p>
102
103 <ol>
104 <li>Regression tests - We should run the regression tests in addition to the
105     program tests...</li>
106 </ol>
107
108 </div>
109
110 <!-- ======================================================================= -->
111 <div class="doc_subsection">
112   <a name="programs">Compile programs with the LLVM Compiler</a>
113 </div>
114
115 <div class="doc_text">
116
117 <p>We are always looking for new testcases and benchmarks for use with LLVM.  In
118 particular, it is useful to try compiling your favorite C source code with LLVM.
119 If it doesn't compile, try to figure out why or report it to the <a
120 href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">llvm-bugs</a> list.  If you
121 get the program to compile, it would be extremely useful to convert the build
122 system to be compatible with the LLVM Programs testsuite so that we can check it
123 into CVS and the automated tester can use it to track progress of the
124 compiler.</p>
125
126 <p>When testing a code, try running it with a variety of optimizations, and with
127 all the back-ends: CBE, llc, and lli.</p>
128
129 </div>
130
131 <!-- ======================================================================= -->
132 <div class="doc_subsection">
133   <a name="llvm_ir">Extend the LLVM intermediate representation</a>
134 </div>
135
136 <div class="doc_text">
137
138 <ol>
139
140 <li>Add a new conditional move instruction: <tt>X = select bool Cond, Y,
141     Z</tt></li>
142
143 <li>Add support for platform-independent prefetch support.  The GCC <a
144     href="http://gcc.gnu.org/projects/prefetch.html">prefetch project</a> page
145     has a good survey of the prefetching capabilities of a variety of modern
146     processors.</li>
147
148 </ol>
149
150 </div>
151
152 <!-- ======================================================================= -->
153 <div class="doc_subsection">
154   <a name="misc_imp">Miscellaneous Improvements</a>
155 </div>
156
157 <div class="doc_text">
158
159 <ol>
160 <li>Someone needs to look into getting the <tt>ranlib</tt> tool to index LLVM
161     bytecode files, so that linking in .a files is not hideously slow.  They
162     would also then have to implement the reader for this index in
163     <tt>gccld</tt>.</li>
164
165 <li>Rework the PassManager to be more flexible</li>
166
167 <li>Some transformations and analyses only work on reducible flow graphs.  It
168 would be nice to have a transformation which could be "required" by these passes
169 which makes irreducible graphs reducible.  This can easily be accomplished
170 through code duplication.  See <a
171 href="http://citeseer.nj.nec.com/janssen97making.html">Making Graphs Reducible
172 with Controlled Node Splitting</a> and perhaps <a
173 href="http://doi.acm.org/10.1145/262004.262005">Nesting of Reducible and
174 Irreducible Loops</a>.</li>
175
176 </ol>
177
178 </div>
179
180 <!-- *********************************************************************** -->
181 <div class="doc_section">
182   <a name="new">Adding new capabilities to LLVM</a>
183 </div>
184 <!-- *********************************************************************** -->
185
186 <div class="doc_text">
187
188 <p>Sometimes creating new things is more fun that improving existing things.
189 These projects tend to be more involved and perhaps require more work, but can
190 also be very rewarding.</p>
191
192 </div>
193
194 <!-- ======================================================================= -->
195 <div class="doc_subsection">
196   <a name="pointeranalysis">Pointer and Alias Analysis</a>
197 </div>
198
199 <div class="doc_text">
200
201 <p>We have a <a href="AliasAnalysis.html">strong base for development</a> of
202 both pointer analysis based optimizations as well as pointer analyses
203 themselves.  It seems natural to want to take advantage of this...</p>
204
205 <ol>
206 <li>Implement a flow-sensitive context-sensitive alias analysis algorithm<br>
207   - Pick one of the somewhat efficient algorithms, but strive for maximum
208     precision</li>
209
210 <li>Implement a flow-sensitive context-insensitive alias analysis algorithm<br>
211   - Just an efficient local algorithm perhaps?</li>
212
213 <li>Implement an interface to update analyses in response to common code motion
214     transformations</li>
215
216 <li>Implement alias-analysis-based optimizations:
217   <ul>
218   <li>Dead store elimination</li>
219   <li>...</li>
220   </ul></li>
221 </ol>
222
223 </div>
224
225 <!-- ======================================================================= -->
226 <div class="doc_subsection">
227   <a name="profileguided">Profile Guided Optimization</a>
228 </div>
229
230 <div class="doc_text">
231
232 <p>We now have a unified infrastructure for writing profile-guided
233 transformations, which will work either at offline-compile-time or in the JIT,
234 but we don't have many transformations.  We would welcome new profile-guided
235 transformations as well as improvements to the current profiling system.
236 </p>
237
238 <p>Ideas for profile guided transformations:</p>
239
240 <ol>
241 <li>Superblock formation (with many optimizations)</li>
242 <li>Loop unrolling/peeling</li>
243 <li>Profile directed inlining</li>
244 <li>Code layout</li>
245 <li>...</li>
246 </ol>
247
248 <p>Improvements to the existing support:</p>
249
250 <ol>
251 <li>The current block and edge profiling code that gets inserted is very simple
252 and inefficient.  Through the use of control-dependence information, many fewer
253 counters could be inserted into the code.  Also, if the execution count of a
254 loop is known to be a compile-time or runtime constant, all of the counters in
255 the loop could be avoided.</li>
256
257 <li>You could implement one of the "static profiling" algorithms which analyze a
258 piece of code an make educated guesses about the relative execution frequencies
259 of various parts of the code.</li>
260
261 <li>You could add path profiling support, or adapt the existing LLVM path
262 profiling code to work with the generic profiling interfaces.</li>
263 </ol>
264
265 </div>
266
267 <!-- ======================================================================= -->
268 <div class="doc_subsection">
269   <a name="xforms">New Transformations and Analyses</a>
270 </div>
271
272 <div class="doc_text">
273
274 <ol>
275 <li>Implement a Dependence Analysis Infrastructure<br>
276      - Design some way to represent and query dep analysis</li>
277 <li>Implement a strength reduction pass</li>
278 <li>Value range propagation pass</li>
279 <li>Implement an unswitching pass</li>
280 <li>Write a loop unroller, with a simple heuristic for when to unroll</li>
281 </ol>
282
283 </div>
284
285 <!-- ======================================================================= -->
286 <div class="doc_section">
287   <a name="x86be">X86 Back-end Improvements</a>
288 </div>
289
290 <div class="doc_text">
291
292 <ol>
293 <li>Implement a global register allocator</li>
294 <li>Implement a better instruction selector</li>
295 <li>Implement support for the "switch" instruction without requiring the 
296     lower-switches pass.</li>
297 </ol>
298
299 </div>
300
301 <!-- ======================================================================= -->
302 <div class="doc_subsection">
303   <a name="misc_new">Miscellaneous Additions</a>
304 </div>
305
306 <div class="doc_text">
307
308 <ol>
309 <li>Write a new frontend for some language (Java? OCaml? Forth?)</li>
310 <li>Write a new backend for a target (IA64? MIPS? MMIX?)</li>
311 <li>Random test vector generator: Use a C grammar to generate random C code;
312 run it through llvm-gcc, then run a random set of passes on it using opt.
313 Try to crash opt. When opt crashes, use bugpoint to reduce the test case and
314 mail the result to yourself.  Repeat ad infinitum.</li>
315 </ol>
316
317 </div>
318
319 <!-- *********************************************************************** -->
320
321 <hr>
322 <div class="doc_footer">
323   <address><a href="mailto:sabre@nondot.org">Chris Lattner</a></address>
324   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
325   <br>
326   Last modified: $Date$
327 </div>
328
329 </body>
330 </html>