Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 1 | //===-- FindBugs.cpp - Run Many Different Optimizations -------------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | 21c62da | 2007-12-29 20:44:31 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file defines an interface that allows bugpoint to choose different |
| 11 | // combinations of optimizations to run on the selected input. Bugpoint will |
| 12 | // run these optimizations and record the success/failure of each. This way |
| 13 | // we can hopefully spot bugs in the optimizations. |
| 14 | // |
| 15 | //===----------------------------------------------------------------------===// |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 16 | |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 17 | #include "BugDriver.h" |
| 18 | #include "ToolRunner.h" |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 19 | #include "llvm/Pass.h" |
Chris Lattner | 74382b7 | 2009-08-23 22:45:37 +0000 | [diff] [blame] | 20 | #include "llvm/Support/raw_ostream.h" |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 21 | #include <algorithm> |
| 22 | #include <ctime> |
| 23 | using namespace llvm; |
| 24 | |
| 25 | /// runManyPasses - Take the specified pass list and create different |
| 26 | /// combinations of passes to compile the program with. Compile the program with |
| 27 | /// each set and mark test to see if it compiled correctly. If the passes |
| 28 | /// compiled correctly output nothing and rearrange the passes into a new order. |
| 29 | /// If the passes did not compile correctly, output the command required to |
| 30 | /// recreate the failure. This returns true if a compiler error is found. |
| 31 | /// |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 32 | bool BugDriver::runManyPasses(const std::vector<const PassInfo*> &AllPasses) { |
Nick Lewycky | 1d1ef14 | 2008-02-14 05:01:46 +0000 | [diff] [blame] | 33 | setPassesToRun(AllPasses); |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 34 | outs() << "Starting bug finding procedure...\n\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 35 | |
| 36 | // Creating a reference output if necessary |
| 37 | if (initializeExecutionEnvironment()) return false; |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 38 | |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 39 | outs() << "\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 40 | if (ReferenceOutputFile.empty()) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 41 | outs() << "Generating reference output from raw program: \n"; |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 42 | if (!createReferenceFile(Program)) |
| 43 | return false; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 44 | } |
| 45 | |
| 46 | srand(time(NULL)); |
Nick Lewycky | 1d1ef14 | 2008-02-14 05:01:46 +0000 | [diff] [blame] | 47 | |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 48 | unsigned num = 1; |
| 49 | while(1) { |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 50 | // |
| 51 | // Step 1: Randomize the order of the optimizer passes. |
| 52 | // |
Nick Lewycky | 1d1ef14 | 2008-02-14 05:01:46 +0000 | [diff] [blame] | 53 | std::random_shuffle(PassesToRun.begin(), PassesToRun.end()); |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 54 | |
| 55 | // |
| 56 | // Step 2: Run optimizer passes on the program and check for success. |
| 57 | // |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 58 | outs() << "Running selected passes on program to test for crash: "; |
Nick Lewycky | 1d1ef14 | 2008-02-14 05:01:46 +0000 | [diff] [blame] | 59 | for(int i = 0, e = PassesToRun.size(); i != e; i++) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 60 | outs() << "-" << PassesToRun[i]->getPassArgument( )<< " "; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 61 | } |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 62 | |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 63 | std::string Filename; |
Nick Lewycky | 1d1ef14 | 2008-02-14 05:01:46 +0000 | [diff] [blame] | 64 | if(runPasses(PassesToRun, Filename, false)) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 65 | outs() << "\n"; |
| 66 | outs() << "Optimizer passes caused failure!\n\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 67 | debugOptimizerCrash(); |
| 68 | return true; |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 69 | } else { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 70 | outs() << "Combination " << num << " optimized successfully!\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 71 | } |
Nick Lewycky | 1d1ef14 | 2008-02-14 05:01:46 +0000 | [diff] [blame] | 72 | |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 73 | // |
| 74 | // Step 3: Compile the optimized code. |
| 75 | // |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 76 | outs() << "Running the code generator to test for a crash: "; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 77 | try { |
| 78 | compileProgram(Program); |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 79 | outs() << '\n'; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 80 | } catch (ToolExecutionError &TEE) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 81 | outs() << "\n*** compileProgram threw an exception: "; |
| 82 | outs() << TEE.what(); |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 83 | return debugCodeGeneratorCrash(); |
| 84 | } |
Nick Lewycky | 1d1ef14 | 2008-02-14 05:01:46 +0000 | [diff] [blame] | 85 | |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 86 | // |
| 87 | // Step 4: Run the program and compare its output to the reference |
| 88 | // output (created above). |
| 89 | // |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 90 | outs() << "*** Checking if passes caused miscompliation:\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 91 | try { |
| 92 | if (diffProgram(Filename, "", false)) { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 93 | outs() << "\n*** diffProgram returned true!\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 94 | debugMiscompilation(); |
| 95 | return true; |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 96 | } else { |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 97 | outs() << "\n*** diff'd output matches!\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 98 | } |
| 99 | } catch (ToolExecutionError &TEE) { |
Dan Gohman | 65f57c2 | 2009-07-15 16:35:29 +0000 | [diff] [blame] | 100 | errs() << TEE.what(); |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 101 | debugCodeGeneratorCrash(); |
| 102 | return true; |
| 103 | } |
| 104 | |
| 105 | sys::Path(Filename).eraseFromDisk(); |
| 106 | |
Dan Gohman | ac95cc7 | 2009-07-16 15:30:09 +0000 | [diff] [blame] | 107 | outs() << "\n\n"; |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 108 | num++; |
| 109 | } //end while |
| 110 | |
Chris Lattner | 7f27570 | 2006-08-17 18:49:52 +0000 | [diff] [blame] | 111 | // Unreachable. |
Patrick Jenkins | 032091d | 2006-08-15 16:41:52 +0000 | [diff] [blame] | 112 | } |