Compiler.cpp revision 5db508c73e6177eb306bac4725616b7c001587c4
1/* 2 * Copyright 2010-2012, The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#include "bcc/Compiler.h" 18 19#include <llvm/Analysis/Passes.h> 20#include <llvm/CodeGen/RegAllocRegistry.h> 21#include <llvm/IR/Module.h> 22#include <llvm/PassManager.h> 23#include <llvm/Support/TargetRegistry.h> 24#include <llvm/Support/raw_ostream.h> 25#include <llvm/IR/DataLayout.h> 26#include <llvm/Target/TargetSubtargetInfo.h> 27#include <llvm/Target/TargetMachine.h> 28#include <llvm/Transforms/IPO.h> 29#include <llvm/Transforms/IPO/PassManagerBuilder.h> 30#include <llvm/Transforms/Scalar.h> 31 32#include "bcc/Assert.h" 33#include "bcc/Renderscript/RSExecutable.h" 34#include "bcc/Renderscript/RSScript.h" 35#include "bcc/Renderscript/RSTransforms.h" 36#include "bcc/Script.h" 37#include "bcc/Source.h" 38#include "bcc/Support/CompilerConfig.h" 39#include "bcc/Support/Log.h" 40#include "bcc/Support/OutputFile.h" 41#include "bcinfo/MetadataExtractor.h" 42 43#include <string> 44 45using namespace bcc; 46 47const char *Compiler::GetErrorString(enum ErrorCode pErrCode) { 48 switch (pErrCode) { 49 case kSuccess: 50 return "Successfully compiled."; 51 case kInvalidConfigNoTarget: 52 return "Invalid compiler config supplied (getTarget() returns nullptr.) " 53 "(missing call to CompilerConfig::initialize()?)"; 54 case kErrCreateTargetMachine: 55 return "Failed to create llvm::TargetMachine."; 56 case kErrSwitchTargetMachine: 57 return "Failed to switch llvm::TargetMachine."; 58 case kErrNoTargetMachine: 59 return "Failed to compile the script since there's no available " 60 "TargetMachine. (missing call to Compiler::config()?)"; 61 case kErrDataLayoutNoMemory: 62 return "Out of memory when create DataLayout during compilation."; 63 case kErrMaterialization: 64 return "Failed to materialize the module."; 65 case kErrInvalidOutputFileState: 66 return "Supplied output file was invalid (in the error state.)"; 67 case kErrPrepareOutput: 68 return "Failed to prepare file for output."; 69 case kPrepareCodeGenPass: 70 return "Failed to construct pass list for code-generation."; 71 case kErrCustomPasses: 72 return "Error occurred while adding custom passes."; 73 case kErrInvalidSource: 74 return "Error loading input bitcode"; 75 case kIllegalGlobalFunction: 76 return "Use of undefined external function"; 77 } 78 79 // This assert should never be reached as the compiler verifies that the 80 // above switch coveres all enum values. 81 assert(false && "Unknown error code encountered"); 82 return ""; 83} 84 85//===----------------------------------------------------------------------===// 86// Instance Methods 87//===----------------------------------------------------------------------===// 88Compiler::Compiler() : mTarget(nullptr), mEnableOpt(true) { 89 return; 90} 91 92Compiler::Compiler(const CompilerConfig &pConfig) : mTarget(nullptr), 93 mEnableOpt(true) { 94 const std::string &triple = pConfig.getTriple(); 95 96 enum ErrorCode err = config(pConfig); 97 if (err != kSuccess) { 98 ALOGE("%s (%s, features: %s)", GetErrorString(err), 99 triple.c_str(), pConfig.getFeatureString().c_str()); 100 return; 101 } 102 103 return; 104} 105 106enum Compiler::ErrorCode Compiler::config(const CompilerConfig &pConfig) { 107 if (pConfig.getTarget() == nullptr) { 108 return kInvalidConfigNoTarget; 109 } 110 111 llvm::TargetMachine *new_target = 112 (pConfig.getTarget())->createTargetMachine(pConfig.getTriple(), 113 pConfig.getCPU(), 114 pConfig.getFeatureString(), 115 pConfig.getTargetOptions(), 116 pConfig.getRelocationModel(), 117 pConfig.getCodeModel(), 118 pConfig.getOptimizationLevel()); 119 120 if (new_target == nullptr) { 121 return ((mTarget != nullptr) ? kErrSwitchTargetMachine : 122 kErrCreateTargetMachine); 123 } 124 125 // Replace the old TargetMachine. 126 delete mTarget; 127 mTarget = new_target; 128 129 // Adjust register allocation policy according to the optimization level. 130 // createFastRegisterAllocator: fast but bad quality 131 // createLinearScanRegisterAllocator: not so fast but good quality 132 if ((pConfig.getOptimizationLevel() == llvm::CodeGenOpt::None)) { 133 llvm::RegisterRegAlloc::setDefault(llvm::createFastRegisterAllocator); 134 } else { 135 llvm::RegisterRegAlloc::setDefault(llvm::createGreedyRegisterAllocator); 136 } 137 138 return kSuccess; 139} 140 141Compiler::~Compiler() { 142 delete mTarget; 143} 144 145 146enum Compiler::ErrorCode Compiler::runPasses(Script &pScript, 147 llvm::raw_ostream &pResult) { 148 // Pass manager for link-time optimization 149 llvm::PassManager passes; 150 151 // Empty MCContext. 152 llvm::MCContext *mc_context = nullptr; 153 154 mTarget->addAnalysisPasses(passes); 155 156 // Prepare DataLayout target data from Module 157 llvm::DataLayoutPass *data_layout_pass = 158 new (std::nothrow) llvm::DataLayoutPass(); 159 160 if (data_layout_pass == nullptr) { 161 return kErrDataLayoutNoMemory; 162 } 163 164 // Add DataLayout to the pass manager. 165 passes.add(data_layout_pass); 166 167 // Add our custom passes. 168 if (!addCustomPasses(pScript, passes)) { 169 return kErrCustomPasses; 170 } 171 172 if (mTarget->getOptLevel() == llvm::CodeGenOpt::None) { 173 passes.add(llvm::createGlobalOptimizerPass()); 174 passes.add(llvm::createConstantMergePass()); 175 176 } else { 177 // FIXME: Figure out which passes should be executed. 178 llvm::PassManagerBuilder Builder; 179 Builder.Inliner = llvm::createFunctionInliningPass(); 180 Builder.populateLTOPassManager(passes, mTarget); 181 } 182 183 // Add our pass to check for illegal function calls. 184 // This has to come after LTO, since we don't want to examine functions that 185 // are never actually called. 186 passes.add(createRSScreenFunctionsPass()); 187 188 // Add passes to the pass manager to emit machine code through MC layer. 189 if (mTarget->addPassesToEmitMC(passes, mc_context, pResult, 190 /* DisableVerify */false)) { 191 return kPrepareCodeGenPass; 192 } 193 194 // Execute the passes. 195 passes.run(pScript.getSource().getModule()); 196 197 return kSuccess; 198} 199 200enum Compiler::ErrorCode Compiler::compile(Script &pScript, 201 llvm::raw_ostream &pResult, 202 llvm::raw_ostream *IRStream) { 203 llvm::Module &module = pScript.getSource().getModule(); 204 enum ErrorCode err; 205 206 if (mTarget == nullptr) { 207 return kErrNoTargetMachine; 208 } 209 210 const std::string &triple = module.getTargetTriple(); 211 const llvm::DataLayout *dl = getTargetMachine().getSubtargetImpl()->getDataLayout(); 212 unsigned int pointerSize = dl->getPointerSizeInBits(); 213 if (triple == "armv7-none-linux-gnueabi") { 214 if (pointerSize != 32) { 215 return kErrInvalidSource; 216 } 217 } else if (triple == "aarch64-none-linux-gnueabi") { 218 if (pointerSize != 64) { 219 return kErrInvalidSource; 220 } 221 } else { 222 return kErrInvalidSource; 223 } 224 225 // Materialize the bitcode module. 226 if (module.getMaterializer() != nullptr) { 227 // A module with non-null materializer means that it is a lazy-load module. 228 // Materialize it now via invoking MaterializeAllPermanently(). This 229 // function returns false when the materialization is successful. 230 std::error_code ec = module.materializeAllPermanently(); 231 if (ec) { 232 ALOGE("Failed to materialize the module `%s'! (%s)", 233 module.getModuleIdentifier().c_str(), ec.message().c_str()); 234 return kErrMaterialization; 235 } 236 } 237 238 if ((err = runPasses(pScript, pResult)) != kSuccess) { 239 return err; 240 } 241 242 if (IRStream) { 243 *IRStream << module; 244 } 245 246 return kSuccess; 247} 248 249enum Compiler::ErrorCode Compiler::compile(Script &pScript, 250 OutputFile &pResult, 251 llvm::raw_ostream *IRStream) { 252 // Check the state of the specified output file. 253 if (pResult.hasError()) { 254 return kErrInvalidOutputFileState; 255 } 256 257 // Open the output file decorated in llvm::raw_ostream. 258 llvm::raw_ostream *out = pResult.dup(); 259 if (out == nullptr) { 260 return kErrPrepareOutput; 261 } 262 263 // Delegate the request. 264 enum Compiler::ErrorCode err = compile(pScript, *out, IRStream); 265 266 // Close the output before return. 267 delete out; 268 269 return err; 270} 271 272bool Compiler::addInternalizeSymbolsPass(Script &pScript, llvm::PassManager &pPM) { 273 // Add a pass to internalize the symbols that don't need to have global 274 // visibility. 275 RSScript &script = static_cast<RSScript &>(pScript); 276 llvm::Module &module = script.getSource().getModule(); 277 bcinfo::MetadataExtractor me(&module); 278 if (!me.extract()) { 279 bccAssert(false && "Could not extract metadata for module!"); 280 return false; 281 } 282 283 // The vector contains the symbols that should not be internalized. 284 std::vector<const char *> export_symbols; 285 286 // Special RS functions should always be global symbols. 287 const char **special_functions = RSExecutable::SpecialFunctionNames; 288 while (*special_functions != nullptr) { 289 export_symbols.push_back(*special_functions); 290 special_functions++; 291 } 292 293 // Visibility of symbols appeared in rs_export_var and rs_export_func should 294 // also be preserved. 295 size_t exportVarCount = me.getExportVarCount(); 296 size_t exportFuncCount = me.getExportFuncCount(); 297 size_t exportForEachCount = me.getExportForEachSignatureCount(); 298 const char **exportVarNameList = me.getExportVarNameList(); 299 const char **exportFuncNameList = me.getExportFuncNameList(); 300 const char **exportForEachNameList = me.getExportForEachNameList(); 301 size_t i; 302 303 for (i = 0; i < exportVarCount; ++i) { 304 export_symbols.push_back(exportVarNameList[i]); 305 } 306 307 for (i = 0; i < exportFuncCount; ++i) { 308 export_symbols.push_back(exportFuncNameList[i]); 309 } 310 311 // Expanded foreach functions should not be internalized, too. 312 // expanded_foreach_funcs keeps the .expand version of the kernel names 313 // around until createInternalizePass() is finished making its own 314 // copy of the visible symbols. 315 std::vector<std::string> expanded_foreach_funcs; 316 for (i = 0; i < exportForEachCount; ++i) { 317 expanded_foreach_funcs.push_back( 318 std::string(exportForEachNameList[i]) + ".expand"); 319 } 320 321 for (i = 0; i < exportForEachCount; i++) { 322 export_symbols.push_back(expanded_foreach_funcs[i].c_str()); 323 } 324 325 pPM.add(llvm::createInternalizePass(export_symbols)); 326 327 return true; 328} 329 330bool Compiler::addInvokeHelperPass(llvm::PassManager &pPM) { 331 llvm::Triple arch(getTargetMachine().getTargetTriple()); 332 if (arch.isArch64Bit()) { 333 pPM.add(createRSInvokeHelperPass()); 334 } 335 return true; 336} 337 338bool Compiler::addExpandForEachPass(Script &pScript, llvm::PassManager &pPM) { 339 // Script passed to RSCompiler must be a RSScript. 340 RSScript &script = static_cast<RSScript &>(pScript); 341 342 // Expand ForEach on CPU path to reduce launch overhead. 343 bool pEnableStepOpt = true; 344 pPM.add(createRSForEachExpandPass(pEnableStepOpt)); 345 if (script.getEmbedInfo()) 346 pPM.add(createRSEmbedInfoPass()); 347 348 return true; 349} 350 351bool Compiler::addCustomPasses(Script &pScript, llvm::PassManager &pPM) { 352 if (!addInvokeHelperPass(pPM)) 353 return false; 354 355 if (!addExpandForEachPass(pScript, pPM)) 356 return false; 357 358 if (!addInternalizeSymbolsPass(pScript, pPM)) 359 return false; 360 361 return true; 362} 363