How to submit an LLVM bug report

From: Chris Lattner Date: Wed, 21 May 2003 22:21:07 +0000 (+0000) Subject: New document X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=8b6be36bcafb9e8a573df3c84a96453ed759f2d1;p=oota-llvm.git New document git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@6275 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/HowToSubmitABug.html b/docs/HowToSubmitABug.html new file mode 100644 index 00000000000..e3f20197c15 --- /dev/null +++ b/docs/HowToSubmitABug.html @@ -0,0 +1,197 @@ + +How to submit an LLVM bug report + + + + + +

How to submit an LLVM bug report

+ + + +

Introduction - Got bugs? +

Crashing Bugs +

Front-end bugs +
GCCAS bugs +
GCCLD bugs +
Bugs in LLVM passes +

Miscompilations + +

Written by Chris Lattner

+ + + + +

+Introduction - Got bugs? +

+ +Basically you have to do two things at a minimum. First, decide whether the bug +crashes the compiler (or an LLVM pass), or if the +compiler is miscompiling the program. Based on +what type of bug it is, follow the instructions in the linked section to narrow +down the bug so that the person who fixes it will be able to find the problem +more easily.

+ +Once you have a reduced test-case, email information about the bug to: llvmbugs@cs.uiuc.edu. This should +include all of the information necessary to reproduce the problem, including +where you got the LLVM tree from (if you're not working out of CVS).

+ +Thanks for helping us make LLVM better!

+ + + +

+Crashing Bugs +

opt

analyze

bugs in LLVM passes

+ +To figure out which program is crashing (the front-end, gccas, +or gccld), run the llvm-gcc command line as you +were when the crash occurred, but add a -v option to the command line. +The compiler will print out a bunch of stuff, and should end with telling you +that one of cc1, gccas, or gccld +crashed.

+ +

If cc1 crashed, you found a problem with the front-end. +Jump ahead to the section on front-end bugs. +
If gccas crashed, you found a bug in one of +the passes in gccas. +
If gccld crashed, you found a bug in one +of the passes in gccld. +
Otherwise, something really weird happened. Email the list with what you +have at this point. +

+ + + +

+ +Front-end bugs +

-E

+ + + +

+ +GCCAS bugs +

gccas

.s

-S

llvm-gcc

+ +

+  gccas -debug-pass=Arguments < /dev/null -o - > /dev/null
+

+ +... which will print a list of arguments, indicating the list of passes that +gccas runs. Once you have the input file and the list of +passes, go to the section on debugging bugs in LLVM +passes.

+ + + +

+ +GCCLD bugs +

gccld

.o

llvm-gcc -v

+ +

+  gccld -debug-pass=Arguments < /dev/null -o - > /dev/null
+

+ +... which will print a list of arguments, indicating the list of passes that +gccld runs. Once you have the input files and the list of +passes, go to the section on debugging bugs in LLVM +passes.

+ + +

+ +Bugs in LLVM passes +

bugpoint

+ +

+  bugpoint <input files> <list of passes>
+

+ +bugpoint will print a bunch of output as it reduces the +test-case, but it should eventually print something like this:

+ +

+  ...
+  Emitted bytecode to 'bugpoint-reduced-simplified.bc'
+
+  *** You can reproduce the problem with: opt bugpoint-reduced-simplified.bc -licm
+

+ +Once you complete this, please send the LLVM bytecode file and the command line +to reproduce the problem to the llvmbugs mailing list.

+ + + +

+Miscompilations +

+ + + +

+ + +

Chris Lattner

+ + +Last modified: Wed May 21 17:20:13 CDT 2003 + +