Source.cpp revision a630078b32eb37a8de91ae09e26babf235d4fc9f
1d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao/* 2d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * Copyright 2012, The Android Open Source Project 3d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * 4d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * Licensed under the Apache License, Version 2.0 (the "License"); 5d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * you may not use this file except in compliance with the License. 6d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * You may obtain a copy of the License at 7d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * 8d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * http://www.apache.org/licenses/LICENSE-2.0 9d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * 10d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * Unless required by applicable law or agreed to in writing, software 11d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * distributed under the License is distributed on an "AS IS" BASIS, 12d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * See the License for the specific language governing permissions and 14d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao * limitations under the License. 15d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao */ 16d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 17c72c4ddfcd79c74f70713da91a69569451b5c19eZonr Chang#include "bcc/Source.h" 18d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 19d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao#include <new> 20d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 21c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray#include <llvm/ADT/OwningPtr.h> 22d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao#include <llvm/Bitcode/ReaderWriter.h> 23b730e239619a546d93e5926ea92d698ab77ec7f6Stephen Hines#include <llvm/IR/LLVMContext.h> 24b730e239619a546d93e5926ea92d698ab77ec7f6Stephen Hines#include <llvm/IR/Module.h> 25c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray#include <llvm/IR/Verifier.h> 26c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray#include <llvm/Linker/Linker.h> 27d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao#include <llvm/Support/MemoryBuffer.h> 28c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray#include "llvm/Support/raw_ostream.h" 29d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao#include <llvm/Support/system_error.h> 30d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 31c72c4ddfcd79c74f70713da91a69569451b5c19eZonr Chang#include "bcc/BCCContext.h" 32ef73a242762bcd8113b9b65ceccbe7d909b5acbcZonr Chang#include "bcc/Support/Log.h" 33c72c4ddfcd79c74f70713da91a69569451b5c19eZonr Chang 34d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao#include "BCCContextImpl.h" 35d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 36d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liaonamespace { 37d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 38d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao// Helper function to load the bitcode. This uses "bitcode lazy load" feature to 39d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao// reduce the startup time. On success, return the LLVM module object created 40d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao// and take the ownership of input memory buffer (i.e., pInput). On error, 41d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao// return NULL and will NOT take the ownership of pInput. 42d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liaostatic inline llvm::Module *helper_load_bitcode(llvm::LLVMContext &pContext, 43d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::MemoryBuffer *pInput) { 44c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray llvm::ErrorOr<llvm::Module *> moduleOrError = llvm::getLazyBitcodeModule(pInput, pContext); 45c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray if (llvm::error_code ec = moduleOrError.getError()) { 46d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ALOGE("Unable to parse the given bitcode file `%s'! (%s)", 47c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray pInput->getBufferIdentifier(), ec.message().c_str()); 48d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 49d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 50c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray return moduleOrError.get(); 51d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 52d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 53d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} // end anonymous namespace 54d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 55d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liaonamespace bcc { 56d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 5706731a6150ae8014d37258d5f32ef8bc14a3db63Stephen Hinesvoid Source::setModule(llvm::Module *pModule) { 5806731a6150ae8014d37258d5f32ef8bc14a3db63Stephen Hines if (!mNoDelete && (mModule != pModule)) delete mModule; 5906731a6150ae8014d37258d5f32ef8bc14a3db63Stephen Hines mModule = pModule; 6006731a6150ae8014d37258d5f32ef8bc14a3db63Stephen Hines} 6106731a6150ae8014d37258d5f32ef8bc14a3db63Stephen Hines 62d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei LiaoSource *Source::CreateFromBuffer(BCCContext &pContext, 63d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao const char *pName, 64d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao const char *pBitcode, 65d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao size_t pBitcodeSize) { 66d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::StringRef input_data(pBitcode, pBitcodeSize); 67d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::MemoryBuffer *input_memory = 68c996b870ae40603b477a8d7a50f461b82389aaf1Shih-wei Liao llvm::MemoryBuffer::getMemBuffer(input_data, "", false); 69d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 70d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (input_memory == NULL) { 71d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ALOGE("Unable to load bitcode `%s' from buffer!", pName); 72d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return NULL; 73d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 74d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 75d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::Module *module = helper_load_bitcode(pContext.mImpl->mLLVMContext, 76d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao input_memory); 77d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (module == NULL) { 78d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao delete input_memory; 79d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return NULL; 80d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 81d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 82d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao Source *result = CreateFromModule(pContext, *module, /* pNoDelete */false); 83d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (result == NULL) { 84d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao delete module; 85d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 86d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 87d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return result; 88d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 89d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 90d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei LiaoSource *Source::CreateFromFile(BCCContext &pContext, const std::string &pPath) { 91a630078b32eb37a8de91ae09e26babf235d4fc9fStephen Hines std::unique_ptr<llvm::MemoryBuffer> input_data; 92d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 93d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::error_code ec = llvm::MemoryBuffer::getFile(pPath, input_data); 94d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (ec != llvm::error_code::success()) { 95d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ALOGE("Failed to load bitcode from path %s! (%s)", pPath.c_str(), 96d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ec.message().c_str()); 97d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return NULL; 98d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 99d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 100a630078b32eb37a8de91ae09e26babf235d4fc9fStephen Hines llvm::MemoryBuffer *input_memory = input_data.release(); 101d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::Module *module = helper_load_bitcode(pContext.mImpl->mLLVMContext, 102d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao input_memory); 103d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (module == NULL) { 104d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao delete input_memory; 1056202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao return NULL; 1066202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao } 1076202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao 1086202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao Source *result = CreateFromModule(pContext, *module, /* pNoDelete */false); 1096202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao if (result == NULL) { 1106202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao delete module; 1116202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao } 1126202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao 1136202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao return result; 1146202dda52b7898340aac05e73adebc4fb9199f4dShih-wei Liao} 115d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 116d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei LiaoSource *Source::CreateFromModule(BCCContext &pContext, llvm::Module &pModule, 117d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao bool pNoDelete) { 118b316f58fd790ad302b72f569af3e89734ae09db7Tobias Grosser std::string ErrorInfo; 119c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray llvm::raw_string_ostream ErrorStream(ErrorInfo); 120c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray if (llvm::verifyModule(pModule, &ErrorStream)) { 121b316f58fd790ad302b72f569af3e89734ae09db7Tobias Grosser ALOGE("Bitcode of RenderScript module does not pass verification: `%s'!", 122c2074caf075818abb6d3689ad924ca09f4a5ba1fTim Murray ErrorStream.str().c_str()); 123b316f58fd790ad302b72f569af3e89734ae09db7Tobias Grosser return NULL; 124b316f58fd790ad302b72f569af3e89734ae09db7Tobias Grosser } 125b316f58fd790ad302b72f569af3e89734ae09db7Tobias Grosser 126d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao Source *result = new (std::nothrow) Source(pContext, pModule, pNoDelete); 127d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (result == NULL) { 128d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ALOGE("Out of memory during Source object allocation for `%s'!", 129d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao pModule.getModuleIdentifier().c_str()); 130d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 131d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return result; 132d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 133d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 134d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei LiaoSource::Source(BCCContext &pContext, llvm::Module &pModule, bool pNoDelete) 135d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao : mContext(pContext), mModule(&pModule), mNoDelete(pNoDelete) { 136d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao pContext.addSource(*this); 137d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 138d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 139d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei LiaoSource::~Source() { 140d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao mContext.removeSource(*this); 141d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (!mNoDelete) 142d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao delete mModule; 143d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 144d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 145d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liaobool Source::merge(Source &pSource, bool pPreserveSource) { 146d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao std::string error; 147d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::Linker::LinkerMode mode = 148d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ((pPreserveSource) ? llvm::Linker::PreserveSource : 149d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::Linker::DestroySource); 150d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 151d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (llvm::Linker::LinkModules(mModule, &pSource.getModule(), 152d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao mode, &error) != 0) { 153d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ALOGE("Failed to link source `%s' with `%s' (%s)!", 154d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao getIdentifier().c_str(), 155d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao pSource.getIdentifier().c_str(), 156d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao error.c_str()); 157d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return false; 158d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 159d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 160d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (!pPreserveSource) { 161d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao pSource.mNoDelete = true; 162d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao delete &pSource; 163d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 164d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 165d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return true; 166d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 167d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 168d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei LiaoSource *Source::CreateEmpty(BCCContext &pContext, const std::string &pName) { 169d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao // Create an empty module 170d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao llvm::Module *module = 171d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao new (std::nothrow) llvm::Module(pName, pContext.mImpl->mLLVMContext); 172d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 173d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (module == NULL) { 174d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao ALOGE("Out of memory when creating empty LLVM module `%s'!", pName.c_str()); 175d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return NULL; 176d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 177d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 178d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao Source *result = CreateFromModule(pContext, *module, /* pNoDelete */false); 179d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao if (result == NULL) { 180d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao delete module; 181d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao } 182d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 183d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return result; 184d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 185d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 186d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liaoconst std::string &Source::getIdentifier() const { 187d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao return mModule->getModuleIdentifier(); 188d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} 189d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao 190d2a5a0eab7a1273797029702652e50b2ed9e6a6dShih-wei Liao} // namespace bcc 191