slang_backend.cpp revision 68fc02ca4a7235e2981be5eee4ad968a9d3928c0
125a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio/* 225a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * Copyright 2010, The Android Open Source Project 325a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * 425a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * Licensed under the Apache License, Version 2.0 (the "License"); 525a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * you may not use this file except in compliance with the License. 625a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * You may obtain a copy of the License at 725a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * 825a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * http://www.apache.org/licenses/LICENSE-2.0 925a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * 1025a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * Unless required by applicable law or agreed to in writing, software 1125a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * distributed under the License is distributed on an "AS IS" BASIS, 1225a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1325a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * See the License for the specific language governing permissions and 1425a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio * limitations under the License. 1525a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio */ 1625a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio 1725a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio#include "slang_backend.h" 1825a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio 1925a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio#include "llvm/Module.h" 2025a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio#include "llvm/Metadata.h" 2125a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio#include "llvm/LLVMContext.h" 2225a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio 2325a5526e6987046891ccc07ffef682a8574c16fbFabrice Di Meglio#include "llvm/Target/TargetData.h" 24#include "llvm/Target/TargetMachine.h" 25#include "llvm/Target/TargetOptions.h" 26#include "llvm/Target/TargetRegistry.h" 27#include "llvm/Target/SubtargetFeature.h" 28 29#include "llvm/CodeGen/RegAllocRegistry.h" 30#include "llvm/CodeGen/SchedulerRegistry.h" 31 32#include "llvm/Assembly/PrintModulePass.h" 33#include "llvm/Bitcode/ReaderWriter.h" 34 35#include "clang/AST/Decl.h" 36#include "clang/AST/DeclGroup.h" 37#include "clang/AST/ASTContext.h" 38 39#include "clang/Basic/TargetInfo.h" 40#include "clang/Basic/Diagnostic.h" 41#include "clang/Basic/TargetOptions.h" 42 43#include "clang/Frontend/CodeGenOptions.h" 44#include "clang/Frontend/FrontendDiagnostic.h" 45 46#include "clang/CodeGen/ModuleBuilder.h" 47 48#include "slang.h" 49 50using namespace slang; 51 52void Backend::CreateFunctionPasses() { 53 if (!mPerFunctionPasses) { 54 mPerFunctionPasses = new llvm::FunctionPassManager(mpModule); 55 mPerFunctionPasses->add(new llvm::TargetData(mpModule)); 56 57 llvm::createStandardFunctionPasses(mPerFunctionPasses, 58 mCodeGenOpts.OptimizationLevel); 59 } 60 return; 61} 62 63void Backend::CreateModulePasses() { 64 if (!mPerModulePasses) { 65 mPerModulePasses = new llvm::PassManager(); 66 mPerModulePasses->add(new llvm::TargetData(mpModule)); 67 68 llvm::createStandardModulePasses(mPerModulePasses, 69 mCodeGenOpts.OptimizationLevel, 70 mCodeGenOpts.OptimizeSize, 71 mCodeGenOpts.UnitAtATime, 72 mCodeGenOpts.UnrollLoops, 73 /* SimplifyLibCalls = */true, 74 /* HaveExceptions = */false, 75 /* InliningPass = */NULL); 76 } 77 return; 78} 79 80bool Backend::CreateCodeGenPasses() { 81 if ((mOT != Slang::OT_Assembly) && (mOT != Slang::OT_Object)) 82 return true; 83 84 // Now we add passes for code emitting 85 if (mCodeGenPasses) { 86 return true; 87 } else { 88 mCodeGenPasses = new llvm::FunctionPassManager(mpModule); 89 mCodeGenPasses->add(new llvm::TargetData(mpModule)); 90 } 91 92 // Create the TargetMachine for generating code. 93 std::string Triple = mpModule->getTargetTriple(); 94 95 std::string Error; 96 const llvm::Target* TargetInfo = 97 llvm::TargetRegistry::lookupTarget(Triple, Error); 98 if (TargetInfo == NULL) { 99 mDiags.Report(clang::diag::err_fe_unable_to_create_target) << Error; 100 return false; 101 } 102 103 llvm::NoFramePointerElim = mCodeGenOpts.DisableFPElim; 104 105 // Use hardware FPU. 106 // 107 // FIXME: Need to detect the CPU capability and decide whether to use softfp. 108 // To use softfp, change following 2 lines to 109 // 110 // llvm::FloatABIType = llvm::FloatABI::Soft; 111 // llvm::UseSoftFloat = true; 112 llvm::FloatABIType = llvm::FloatABI::Hard; 113 llvm::UseSoftFloat = false; 114 115 // BCC needs all unknown symbols resolved at compilation time. So we don't 116 // need any relocation model. 117 llvm::TargetMachine::setRelocationModel(llvm::Reloc::Static); 118 119 120 // This is set for the linker (specify how large of the virtual addresses we 121 // can access for all unknown symbols.) 122 if (mpModule->getPointerSize() == llvm::Module::Pointer32) 123 llvm::TargetMachine::setCodeModel(llvm::CodeModel::Small); 124 else 125 // The target may have pointer size greater than 32 (e.g. x86_64 126 // architecture) may need large data address model 127 llvm::TargetMachine::setCodeModel(llvm::CodeModel::Medium); 128 129 // Setup feature string 130 std::string FeaturesStr; 131 if (mTargetOpts.CPU.size() || mTargetOpts.Features.size()) { 132 llvm::SubtargetFeatures Features; 133 134 Features.setCPU(mTargetOpts.CPU); 135 136 for (std::vector<std::string>::const_iterator 137 I = mTargetOpts.Features.begin(), E = mTargetOpts.Features.end(); 138 I != E; 139 I++) 140 Features.AddFeature(*I); 141 142 FeaturesStr = Features.getString(); 143 } 144 llvm::TargetMachine *TM = 145 TargetInfo->createTargetMachine(Triple, FeaturesStr); 146 147 // Register scheduler 148 llvm::RegisterScheduler::setDefault(llvm::createDefaultScheduler); 149 150 // Register allocation policy: 151 // createFastRegisterAllocator: fast but bad quality 152 // createLinearScanRegisterAllocator: not so fast but good quality 153 llvm::RegisterRegAlloc::setDefault((mCodeGenOpts.OptimizationLevel == 0) ? 154 llvm::createFastRegisterAllocator : 155 llvm::createLinearScanRegisterAllocator); 156 157 llvm::CodeGenOpt::Level OptLevel = llvm::CodeGenOpt::Default; 158 if (mCodeGenOpts.OptimizationLevel == 0) 159 OptLevel = llvm::CodeGenOpt::None; 160 else if (mCodeGenOpts.OptimizationLevel == 3) 161 OptLevel = llvm::CodeGenOpt::Aggressive; 162 163 llvm::TargetMachine::CodeGenFileType CGFT = 164 llvm::TargetMachine::CGFT_AssemblyFile; 165 if (mOT == Slang::OT_Object) 166 CGFT = llvm::TargetMachine::CGFT_ObjectFile; 167 if (TM->addPassesToEmitFile(*mCodeGenPasses, FormattedOutStream, 168 CGFT, OptLevel)) { 169 mDiags.Report(clang::diag::err_fe_unable_to_interface_with_target); 170 return false; 171 } 172 173 return true; 174} 175 176Backend::Backend(clang::Diagnostic &Diags, 177 const clang::CodeGenOptions &CodeGenOpts, 178 const clang::TargetOptions &TargetOpts, 179 const PragmaList &Pragmas, 180 llvm::raw_ostream *OS, 181 Slang::OutputType OT) 182 : ASTConsumer(), 183 mCodeGenOpts(CodeGenOpts), 184 mTargetOpts(TargetOpts), 185 mpModule(NULL), 186 mpOS(OS), 187 mOT(OT), 188 mGen(NULL), 189 mPerFunctionPasses(NULL), 190 mPerModulePasses(NULL), 191 mCodeGenPasses(NULL), 192 mLLVMContext(llvm::getGlobalContext()), 193 mDiags(Diags), 194 mPragmas(Pragmas) { 195 FormattedOutStream.setStream(*mpOS, 196 llvm::formatted_raw_ostream::PRESERVE_STREAM); 197 mGen = CreateLLVMCodeGen(mDiags, "", mCodeGenOpts, mLLVMContext); 198 return; 199} 200 201void Backend::Initialize(clang::ASTContext &Ctx) { 202 mGen->Initialize(Ctx); 203 204 mpModule = mGen->GetModule(); 205 206 return; 207} 208 209void Backend::HandleTopLevelDecl(clang::DeclGroupRef D) { 210 mGen->HandleTopLevelDecl(D); 211 return; 212} 213 214void Backend::HandleTranslationUnit(clang::ASTContext &Ctx) { 215 HandleTranslationUnitPre(Ctx); 216 217 mGen->HandleTranslationUnit(Ctx); 218 219 // Here, we complete a translation unit (whole translation unit is now in LLVM 220 // IR). Now, interact with LLVM backend to generate actual machine code (asm 221 // or machine code, whatever.) 222 223 // Silently ignore if we weren't initialized for some reason. 224 if (!mpModule) 225 return; 226 227 llvm::Module *M = mGen->ReleaseModule(); 228 if (!M) { 229 // The module has been released by IR gen on failures, do not double free. 230 mpModule = NULL; 231 return; 232 } 233 234 assert(mpModule == M && "Unexpected module change during LLVM IR generation"); 235 236 // Insert #pragma information into metadata section of module 237 if (!mPragmas.empty()) { 238 llvm::NamedMDNode *PragmaMetadata = 239 mpModule->getOrInsertNamedMetadata(Slang::PragmaMetadataName); 240 for (PragmaList::const_iterator I = mPragmas.begin(), E = mPragmas.end(); 241 I != E; 242 I++) { 243 llvm::SmallVector<llvm::Value*, 2> Pragma; 244 // Name goes first 245 Pragma.push_back(llvm::MDString::get(mLLVMContext, I->first)); 246 // And then value 247 Pragma.push_back(llvm::MDString::get(mLLVMContext, I->second)); 248 // Create MDNode and insert into PragmaMetadata 249 PragmaMetadata->addOperand( 250 llvm::MDNode::get(mLLVMContext, Pragma.data(), Pragma.size())); 251 } 252 } 253 254 HandleTranslationUnitPost(mpModule); 255 256 // Create passes for optimization and code emission 257 258 // Create and run per-function passes 259 CreateFunctionPasses(); 260 if (mPerFunctionPasses) { 261 mPerFunctionPasses->doInitialization(); 262 263 for (llvm::Module::iterator I = mpModule->begin(), E = mpModule->end(); 264 I != E; 265 I++) 266 if (!I->isDeclaration()) 267 mPerFunctionPasses->run(*I); 268 269 mPerFunctionPasses->doFinalization(); 270 } 271 272 // Create and run module passes 273 CreateModulePasses(); 274 if (mPerModulePasses) 275 mPerModulePasses->run(*mpModule); 276 277 switch (mOT) { 278 case Slang::OT_Assembly: 279 case Slang::OT_Object: { 280 if (!CreateCodeGenPasses()) 281 return; 282 283 mCodeGenPasses->doInitialization(); 284 285 for (llvm::Module::iterator I = mpModule->begin(), E = mpModule->end(); 286 I != E; 287 I++) 288 if (!I->isDeclaration()) 289 mCodeGenPasses->run(*I); 290 291 mCodeGenPasses->doFinalization(); 292 break; 293 } 294 case Slang::OT_LLVMAssembly: { 295 llvm::PassManager *LLEmitPM = new llvm::PassManager(); 296 LLEmitPM->add(llvm::createPrintModulePass(&FormattedOutStream)); 297 LLEmitPM->run(*mpModule); 298 break; 299 } 300 case Slang::OT_Bitcode: { 301 llvm::PassManager *BCEmitPM = new llvm::PassManager(); 302 BCEmitPM->add(llvm::createBitcodeWriterPass(FormattedOutStream)); 303 BCEmitPM->run(*mpModule); 304 break; 305 } 306 case Slang::OT_Nothing: { 307 return; 308 } 309 default: { 310 assert(false && "Unknown output type"); 311 } 312 } 313 314 FormattedOutStream.flush(); 315 316 return; 317} 318 319void Backend::HandleTagDeclDefinition(clang::TagDecl *D) { 320 mGen->HandleTagDeclDefinition(D); 321 return; 322} 323 324void Backend::CompleteTentativeDefinition(clang::VarDecl *D) { 325 mGen->CompleteTentativeDefinition(D); 326 return; 327} 328 329Backend::~Backend() { 330 delete mpModule; 331 delete mGen; 332 delete mPerFunctionPasses; 333 delete mPerModulePasses; 334 delete mCodeGenPasses; 335 return; 336} 337