Add a declaration of environ global for Darwin
[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="#code-cleanups">Implementing Code Cleanup bugs</a></li>
19     <li><a href="#glibc">Port glibc to LLVM</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="#newfeaturebugs">Implementing new feature PRs</a></li>
28     <li><a href="#pointeranalysis">Pointer and Alias Analysis</a></li>
29     <li><a href="#profileguided">Profile Guided Optimization</a></li>
30     <li><a href="#xforms">New Transformations and Analyses</a></li>
31     <li><a href="#x86be">X86 Back-end Improvements</a></li>
32     <li><a href="#misc_new">Miscellaneous Additions</a></li>
33   </ol></li>
34 </ul>
35
36 <div class="doc_author">
37   <p>Written by the <a href="http://llvm.cs.uiuc.edu/">LLVM Team</a></p>
38 </div>
39
40
41 <!-- *********************************************************************** -->
42 <div class="doc_section">
43   <a name="what">What is this?</a>
44 </div>
45 <!-- *********************************************************************** -->
46
47 <div class="doc_text">
48
49 <p>This document is meant to be a sort of "big TODO list" for LLVM.  Each
50 project in this document is something that would be useful for LLVM to have, and
51 would also be a great way to get familiar with the system.  Some of these
52 projects are small and self-contained, which may be implemented in a couple of
53 days, others are larger.  Several of these projects may lead to interesting
54 research projects in their own right.  In any case, we welcome all
55 contributions.</p>
56
57 <p>If you are thinking about tackling one of these projects, please send a mail
58 to the <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM
59 Developer's</a> mailing list, so that we know the project is being worked on.
60 Additionally this is a good way to get more information about a specific project
61 or to suggest other projects to add to this page.
62 </p>
63
64 <p>The projects in this page are open-ended. More specific projects are
65 filed as unassigned enhancements in the <a href="http://llvm.cs.uiuc.edu/bugs/">
66 LLVM bug tracker</a>. See the <a href="http://llvm.cs.uiuc.edu/bugs/buglist.cgi?keywords_type=allwords&amp;keywords=&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;bug_severity=enhancement&amp;emailassigned_to1=1&amp;emailtype1=substring&amp;email1=unassigned">list of currently outstanding issues</a> if you wish to help improve LLVM.</p>
67
68 </div>
69
70 <!-- *********************************************************************** -->
71 <div class="doc_section">
72   <a name="improving">Improving the current system</a>
73 </div>
74 <!-- *********************************************************************** -->
75
76 <div class="doc_text">
77
78 <p>Improvements to the current infrastructure are always very welcome and tend
79 to be fairly straight-forward to implement.  Here are some of the key areas that
80 can use improvement...</p>
81
82 </div>
83
84 <!-- ======================================================================= -->
85 <div class="doc_subsection">
86   <a name="code-cleanups">Implementing Code Cleanup bugs</a>
87 </div>
88
89 <div class="doc_text">
90
91 <p>
92 The <a href="http://llvm.cs.uiuc.edu/bugs/">LLVM bug tracker</a> occasionally
93 has <a href="http://llvm.cs.uiuc.edu/bugs/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=code-cleanup&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Bug+Number&field0-0-0=noop&type0-0-0=noop&value0-0-0=">"code-cleanup" bugs</a> filed in it.  Taking one of these and fixing it is a good
94 way to get your feet wet in the LLVM code and discover how some of its components
95 work.
96 </p>
97
98 </div>
99
100 <!-- ======================================================================= -->
101 <div class="doc_subsection">
102   <a name="glibc">Port glibc to LLVM</a>
103 </div>
104
105 <div class="doc_text">
106
107 <p>It would be very useful to <a
108 href="http://www.gnu.org/software/libc/manual/html_node/Porting.html">port</a> <a
109 href="http://www.gnu.org/software/libc/">glibc</a> to LLVM.  This would allow a
110 variety of interprocedural algorithms to be much more effective in the face of
111 library calls.  The most important pieces to port are things like the string
112 library and the <tt>stdio</tt> related functions... low-level system calls like
113 '<tt>read</tt>' should stay unimplemented in LLVM.</p>
114
115 </div>
116
117 <!-- ======================================================================= -->
118 <div class="doc_subsection">
119   <a name="programs">Compile programs with the LLVM Compiler</a>
120 </div>
121
122 <div class="doc_text">
123
124 <p>We are always looking for new testcases and benchmarks for use with LLVM.  In
125 particular, it is useful to try compiling your favorite C source code with LLVM.
126 If it doesn't compile, try to figure out why or report it to the <a
127 href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">llvm-bugs</a> list.  If you
128 get the program to compile, it would be extremely useful to convert the build
129 system to be compatible with the LLVM Programs testsuite so that we can check it
130 into CVS and the automated tester can use it to track progress of the
131 compiler.</p>
132
133 <p>When testing a code, try running it with a variety of optimizations, and with
134 all the back-ends: CBE, llc, and lli.</p>
135
136 </div>
137
138 <!-- ======================================================================= -->
139 <div class="doc_subsection">
140   <a name="llvm_ir">Extend the LLVM intermediate representation</a>
141 </div>
142
143 <div class="doc_text">
144
145 <ol>
146 <li>Add support for platform-independent prefetch support.  The GCC <a
147     href="http://gcc.gnu.org/projects/prefetch.html">prefetch project</a> page
148     has a good survey of the prefetching capabilities of a variety of modern
149     processors.</li>
150
151 </ol>
152
153 </div>
154
155 <!-- ======================================================================= -->
156 <div class="doc_subsection">
157   <a name="misc_imp">Miscellaneous Improvements</a>
158 </div>
159
160 <div class="doc_text">
161
162 <ol>
163 <li>Someone needs to look into getting the <tt>ranlib</tt> tool to index LLVM
164     bytecode files, so that linking in .a files is not hideously slow.  They
165     would also then have to implement the reader for this index in
166     <tt>gccld</tt>.</li>
167
168 <li>Rework the PassManager to be more flexible</li>
169
170 <li>Some transformations and analyses only work on reducible flow graphs.  It
171 would be nice to have a transformation which could be "required" by these passes
172 which makes irreducible graphs reducible.  This can easily be accomplished
173 through code duplication.  See <a
174 href="http://citeseer.nj.nec.com/janssen97making.html">Making Graphs Reducible
175 with Controlled Node Splitting</a> and perhaps <a
176 href="http://doi.acm.org/10.1145/262004.262005">Nesting of Reducible and
177 Irreducible Loops</a>.</li>
178
179 </ol>
180
181 </div>
182
183 <!-- *********************************************************************** -->
184 <div class="doc_section">
185   <a name="new">Adding new capabilities to LLVM</a>
186 </div>
187 <!-- *********************************************************************** -->
188
189 <div class="doc_text">
190
191 <p>Sometimes creating new things is more fun than improving existing things.
192 These projects tend to be more involved and perhaps require more work, but can
193 also be very rewarding.</p>
194
195 </div>
196
197
198 <!-- ======================================================================= -->
199 <div class="doc_subsection">
200   <a name="newfeaturebugs">Implementing new feature PRs</a>
201 </div>
202
203 <div class="doc_text">
204
205 <p>Many ideas for feature requests are stored in LLVM bugzilla.  Just <a href="http://llvm.org/bugs/buglist.cgi?short_desc_type=allwordssubstr&short_desc=&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=new-feature&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&namedcmd=All+PRs&newqueryname=&order=Bug+Number&field0-0-0=noop&type0-0-0=noop&value0-0-0=">search for bugs with a "new-feature" keyword</a>.</p>
206
207 </div>
208
209 <!-- ======================================================================= -->
210 <div class="doc_subsection">
211   <a name="pointeranalysis">Pointer and Alias Analysis</a>
212 </div>
213
214 <div class="doc_text">
215
216 <p>We have a <a href="AliasAnalysis.html">strong base for development</a> of
217 both pointer analysis based optimizations as well as pointer analyses
218 themselves.  It seems natural to want to take advantage of this...</p>
219
220 <ol>
221 <li>Implement a flow-sensitive context-sensitive alias analysis algorithm<br>
222   - Pick one of the somewhat efficient algorithms, but strive for maximum
223     precision</li>
224
225 <li>Implement a flow-sensitive context-insensitive alias analysis algorithm<br>
226   - Just an efficient local algorithm perhaps?</li>
227
228 <li>Implement alias-analysis-based optimizations:
229   <ul>
230   <li>Dead store elimination</li>
231   <li>...</li>
232   </ul></li>
233 </ol>
234
235 </div>
236
237 <!-- ======================================================================= -->
238 <div class="doc_subsection">
239   <a name="profileguided">Profile Guided Optimization</a>
240 </div>
241
242 <div class="doc_text">
243
244 <p>We now have a unified infrastructure for writing profile-guided
245 transformations, which will work either at offline-compile-time or in the JIT,
246 but we don't have many transformations.  We would welcome new profile-guided
247 transformations as well as improvements to the current profiling system.
248 </p>
249
250 <p>Ideas for profile guided transformations:</p>
251
252 <ol>
253 <li>Superblock formation (with many optimizations)</li>
254 <li>Loop unrolling/peeling</li>
255 <li>Profile directed inlining</li>
256 <li>Code layout</li>
257 <li>...</li>
258 </ol>
259
260 <p>Improvements to the existing support:</p>
261
262 <ol>
263 <li>The current block and edge profiling code that gets inserted is very simple
264 and inefficient.  Through the use of control-dependence information, many fewer
265 counters could be inserted into the code.  Also, if the execution count of a
266 loop is known to be a compile-time or runtime constant, all of the counters in
267 the loop could be avoided.</li>
268
269 <li>You could implement one of the "static profiling" algorithms which analyze a
270 piece of code an make educated guesses about the relative execution frequencies
271 of various parts of the code.</li>
272
273 <li>You could add path profiling support, or adapt the existing LLVM path
274 profiling code to work with the generic profiling interfaces.</li>
275 </ol>
276
277 </div>
278
279 <!-- ======================================================================= -->
280 <div class="doc_subsection">
281   <a name="xforms">New Transformations and Analyses</a>
282 </div>
283
284 <div class="doc_text">
285
286 <ol>
287 <li>Implement a Dependence Analysis Infrastructure<br>
288      - Design some way to represent and query dep analysis</li>
289 <li>Implement a strength reduction pass</li>
290 <li>Value range propagation pass</li>
291 </ol>
292
293 </div>
294
295 <!-- ======================================================================= -->
296 <div class="doc_section">
297   <a name="x86be">X86 Back-end Improvements</a>
298 </div>
299
300 <div class="doc_text">
301
302 <ol>
303 <li>Implement a better instruction selector</li>
304 <li>Implement support for the "switch" instruction without requiring the 
305     lower-switches pass.</li>
306 <li>Implement interprocedural register allocation. The CallGraphSCCPass can be
307     used to implement a bottom-up analysis that will determine the *actual* 
308     registers clobbered by a function. Use the pass to fine tune register usage 
309     in callers based on *actual* registers used by the callee.</li>
310 </ol>
311
312 </div>
313
314 <!-- ======================================================================= -->
315 <div class="doc_section">
316   <a name="misc_new">Miscellaneous Additions</a>
317 </div>
318
319 <div class="doc_text">
320
321 <ol>
322 <li>Port the <a href="http://www-sop.inria.fr/mimosa/fp/Bigloo/">Bigloo</A>
323 Scheme compiler, from Manuel Serrano at INRIA Sophia-Antipolis, to
324 output LLVM bytecode. It seems that it can already output .NET
325 bytecode, JVM bytecode, and C, so LLVM would ostensibly be another good
326 candidate.</li>
327 <li>Write a new frontend for C/C++ <b>in</b> C++, giving us the ability to
328 directly use LLVM C++ classes from within a compiler rather than use
329 C-based wrapper functions a la llvm-gcc.  One possible starting point is the <a
330 href="http://www.parashift.com/c++-faq-lite/compiler-dependencies.html#faq-37.11">C++
331 yacc grammar by Ed Willink</a>.</li>
332 <li>Write a new frontend for some other language (Java? OCaml? Forth?)</li>
333 <li>Write a new backend for a target (IA64? MIPS? MMIX?)</li>
334 <li>Write a disassembler for machine code that would use TableGen to output 
335 <tt>MachineInstr</tt>s for transformations, optimizations, etc.</li>
336 <li>Random test vector generator: Use a C grammar to generate random C code;
337 run it through llvm-gcc, then run a random set of passes on it using opt.
338 Try to crash opt. When opt crashes, use bugpoint to reduce the test case and
339 mail the result to yourself.  Repeat ad infinitum.</li>
340 <li>Design a simple, recognizable logo.</li>
341 </ol>
342
343 </div>
344
345 <!-- *********************************************************************** -->
346
347 <hr>
348 <address>
349   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
350   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
351   <a href="http://validator.w3.org/check/referer"><img
352   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
353
354   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
355   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
356   Last modified: $Date$
357 </address>
358
359 </body>
360 </html>