FindBugs.cpp revision 74382b7c699120fbec5cb5603c9cf4212eb37f06
1032091d7f62774443c282915964189ea3d8930dePatrick Jenkins//===-- FindBugs.cpp - Run Many Different Optimizations -------------------===// 2032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// 3032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// The LLVM Compiler Infrastructure 4032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// 521c62da287237d39d0d95004881ea4baae3be6daChris Lattner// This file is distributed under the University of Illinois Open Source 621c62da287237d39d0d95004881ea4baae3be6daChris Lattner// License. See LICENSE.TXT for details. 7032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// 8032091d7f62774443c282915964189ea3d8930dePatrick Jenkins//===----------------------------------------------------------------------===// 9032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// 10032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// This file defines an interface that allows bugpoint to choose different 11032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// combinations of optimizations to run on the selected input. Bugpoint will 12032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// run these optimizations and record the success/failure of each. This way 13032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// we can hopefully spot bugs in the optimizations. 14032091d7f62774443c282915964189ea3d8930dePatrick Jenkins// 15032091d7f62774443c282915964189ea3d8930dePatrick Jenkins//===----------------------------------------------------------------------===// 167f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner 17032091d7f62774443c282915964189ea3d8930dePatrick Jenkins#include "BugDriver.h" 18032091d7f62774443c282915964189ea3d8930dePatrick Jenkins#include "ToolRunner.h" 197f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner#include "llvm/Pass.h" 2074382b7c699120fbec5cb5603c9cf4212eb37f06Chris Lattner#include "llvm/Support/raw_ostream.h" 21032091d7f62774443c282915964189ea3d8930dePatrick Jenkins#include <algorithm> 22032091d7f62774443c282915964189ea3d8930dePatrick Jenkins#include <ctime> 23032091d7f62774443c282915964189ea3d8930dePatrick Jenkinsusing namespace llvm; 24032091d7f62774443c282915964189ea3d8930dePatrick Jenkins 25032091d7f62774443c282915964189ea3d8930dePatrick Jenkins/// runManyPasses - Take the specified pass list and create different 26032091d7f62774443c282915964189ea3d8930dePatrick Jenkins/// combinations of passes to compile the program with. Compile the program with 27032091d7f62774443c282915964189ea3d8930dePatrick Jenkins/// each set and mark test to see if it compiled correctly. If the passes 28032091d7f62774443c282915964189ea3d8930dePatrick Jenkins/// compiled correctly output nothing and rearrange the passes into a new order. 29032091d7f62774443c282915964189ea3d8930dePatrick Jenkins/// If the passes did not compile correctly, output the command required to 30032091d7f62774443c282915964189ea3d8930dePatrick Jenkins/// recreate the failure. This returns true if a compiler error is found. 31032091d7f62774443c282915964189ea3d8930dePatrick Jenkins/// 327f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattnerbool BugDriver::runManyPasses(const std::vector<const PassInfo*> &AllPasses) { 331d1ef14248a24cb7239e0bc9298d84004a8044e6Nick Lewycky setPassesToRun(AllPasses); 34ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Starting bug finding procedure...\n\n"; 35032091d7f62774443c282915964189ea3d8930dePatrick Jenkins 36032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // Creating a reference output if necessary 37032091d7f62774443c282915964189ea3d8930dePatrick Jenkins if (initializeExecutionEnvironment()) return false; 387f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner 39ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n"; 40032091d7f62774443c282915964189ea3d8930dePatrick Jenkins if (ReferenceOutputFile.empty()) { 41ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Generating reference output from raw program: \n"; 427f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner if (!createReferenceFile(Program)) 437f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner return false; 44032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } 45032091d7f62774443c282915964189ea3d8930dePatrick Jenkins 46032091d7f62774443c282915964189ea3d8930dePatrick Jenkins srand(time(NULL)); 471d1ef14248a24cb7239e0bc9298d84004a8044e6Nick Lewycky 487f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner unsigned num = 1; 497f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner while(1) { 50032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 51032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // Step 1: Randomize the order of the optimizer passes. 52032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 531d1ef14248a24cb7239e0bc9298d84004a8044e6Nick Lewycky std::random_shuffle(PassesToRun.begin(), PassesToRun.end()); 54032091d7f62774443c282915964189ea3d8930dePatrick Jenkins 55032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 56032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // Step 2: Run optimizer passes on the program and check for success. 57032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 58ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Running selected passes on program to test for crash: "; 591d1ef14248a24cb7239e0bc9298d84004a8044e6Nick Lewycky for(int i = 0, e = PassesToRun.size(); i != e; i++) { 60ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "-" << PassesToRun[i]->getPassArgument( )<< " "; 61032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } 627f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner 63032091d7f62774443c282915964189ea3d8930dePatrick Jenkins std::string Filename; 641d1ef14248a24cb7239e0bc9298d84004a8044e6Nick Lewycky if(runPasses(PassesToRun, Filename, false)) { 65ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n"; 66ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Optimizer passes caused failure!\n\n"; 67032091d7f62774443c282915964189ea3d8930dePatrick Jenkins debugOptimizerCrash(); 68032091d7f62774443c282915964189ea3d8930dePatrick Jenkins return true; 697f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner } else { 70ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Combination " << num << " optimized successfully!\n"; 71032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } 721d1ef14248a24cb7239e0bc9298d84004a8044e6Nick Lewycky 73032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 74032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // Step 3: Compile the optimized code. 75032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 76ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "Running the code generator to test for a crash: "; 77032091d7f62774443c282915964189ea3d8930dePatrick Jenkins try { 78032091d7f62774443c282915964189ea3d8930dePatrick Jenkins compileProgram(Program); 79ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << '\n'; 80032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } catch (ToolExecutionError &TEE) { 81ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** compileProgram threw an exception: "; 82ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << TEE.what(); 83032091d7f62774443c282915964189ea3d8930dePatrick Jenkins return debugCodeGeneratorCrash(); 84032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } 851d1ef14248a24cb7239e0bc9298d84004a8044e6Nick Lewycky 86032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 87032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // Step 4: Run the program and compare its output to the reference 88032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // output (created above). 89032091d7f62774443c282915964189ea3d8930dePatrick Jenkins // 90ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "*** Checking if passes caused miscompliation:\n"; 91032091d7f62774443c282915964189ea3d8930dePatrick Jenkins try { 92032091d7f62774443c282915964189ea3d8930dePatrick Jenkins if (diffProgram(Filename, "", false)) { 93ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** diffProgram returned true!\n"; 94032091d7f62774443c282915964189ea3d8930dePatrick Jenkins debugMiscompilation(); 95032091d7f62774443c282915964189ea3d8930dePatrick Jenkins return true; 967f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner } else { 97ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n*** diff'd output matches!\n"; 98032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } 99032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } catch (ToolExecutionError &TEE) { 10065f57c233cd4499e2e8b52a503201e64edfd6a9eDan Gohman errs() << TEE.what(); 101032091d7f62774443c282915964189ea3d8930dePatrick Jenkins debugCodeGeneratorCrash(); 102032091d7f62774443c282915964189ea3d8930dePatrick Jenkins return true; 103032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } 104032091d7f62774443c282915964189ea3d8930dePatrick Jenkins 105032091d7f62774443c282915964189ea3d8930dePatrick Jenkins sys::Path(Filename).eraseFromDisk(); 106032091d7f62774443c282915964189ea3d8930dePatrick Jenkins 107ac95cc79ac0b899d566cc29c0f646f39c2fa35c0Dan Gohman outs() << "\n\n"; 108032091d7f62774443c282915964189ea3d8930dePatrick Jenkins num++; 109032091d7f62774443c282915964189ea3d8930dePatrick Jenkins } //end while 110032091d7f62774443c282915964189ea3d8930dePatrick Jenkins 1117f27570ae0cb716927f946f4e73a55f60d99b3e2Chris Lattner // Unreachable. 112032091d7f62774443c282915964189ea3d8930dePatrick Jenkins} 113