1932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines/* 27cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines * Copyright 2011-2012, The Android Open Source Project 3932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * 4932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * Licensed under the Apache License, Version 2.0 (the "License"); 5932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * you may not use this file except in compliance with the License. 6932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * You may obtain a copy of the License at 7932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * 8932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * http://www.apache.org/licenses/LICENSE-2.0 9932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * 10932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * Unless required by applicable law or agreed to in writing, software 11932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * distributed under the License is distributed on an "AS IS" BASIS, 12932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * See the License for the specific language governing permissions and 14932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * limitations under the License. 15932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines */ 16932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 17932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "bcinfo/BitcodeTranslator.h" 18932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 197cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines#include "bcinfo/BitcodeWrapper.h" 207cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines 21932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "BitReader_2_7/BitReader_2_7.h" 22c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien#include "BitReader_3_0/BitReader_3_0.h" 23932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 24932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#define LOG_TAG "bcinfo" 25932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include <cutils/log.h> 26932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 27932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "llvm/ADT/OwningPtr.h" 28932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "llvm/Bitcode/BitstreamWriter.h" 29932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "llvm/Bitcode/ReaderWriter.h" 30932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "llvm/LLVMContext.h" 31932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "llvm/Module.h" 32932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include "llvm/Support/MemoryBuffer.h" 33c73b5214fa71ef6e3378fa121bb8b6312d2e6d3bShih-wei Liao#include "llvm/Support/raw_ostream.h" 34932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 35932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines#include <cstdlib> 36932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 37932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hinesnamespace bcinfo { 38932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 39932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines/** 40932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * Define minimum and maximum target API versions. These correspond to the 41932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * same API levels used by the standard Android SDK. 42932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * 43c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * LLVM 2.7 44c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 11 - Honeycomb 45c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 12 - Honeycomb MR1 46c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 13 - Honeycomb MR2 47c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 48c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * LLVM 3.0 49c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 14 - Ice Cream Sandwich 50c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 15 - Ice Cream Sandwich MR1 51c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 52c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * LLVM 3.1 53c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien * 16 - Ice Cream Sandwich MR2 54932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines */ 55932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hinesstatic const unsigned int kMinimumAPIVersion = 11; 56932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hinesstatic const unsigned int kMaximumAPIVersion = BCINFO_API_VERSION; 57932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hinesstatic const unsigned int kCurrentAPIVersion = 10000; 58932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 59932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines/** 60932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * The minimum version which does not require translation (i.e. is already 61932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines * compatible with LLVM's default bitcode reader). 62932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines */ 63c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chienstatic const unsigned int kMinimumUntranslatedVersion = 16; 64c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chienstatic const unsigned int kMinimumCompatibleVersion_LLVM_3_0 = 14; 65c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chienstatic const unsigned int kMinimumCompatibleVersion_LLVM_2_7 = 11; 66932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 67932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 68932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen HinesBitcodeTranslator::BitcodeTranslator(const char *bitcode, size_t bitcodeSize, 69932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines unsigned int version) 70932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines : mBitcode(bitcode), mBitcodeSize(bitcodeSize), mTranslatedBitcode(NULL), 71932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines mTranslatedBitcodeSize(0), mVersion(version) { 72932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines return; 73932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines} 74932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 75932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 76932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen HinesBitcodeTranslator::~BitcodeTranslator() { 77932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines if (mVersion < kMinimumUntranslatedVersion) { 78932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines // We didn't actually do a translation in the alternate case, so deleting 79932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines // the bitcode would be improper. 80932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines delete [] mTranslatedBitcode; 81932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines } 82932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines mTranslatedBitcode = NULL; 83932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines return; 84932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines} 85932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 86932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 87932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hinesbool BitcodeTranslator::translate() { 88932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines if (!mBitcode || !mBitcodeSize) { 8910c1412e6cb35cfc90abb5e36ba1340a8c55f44eSteve Block ALOGE("Invalid/empty bitcode"); 90932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines return false; 91932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines } 92932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 937cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines BitcodeWrapper BCWrapper(mBitcode, mBitcodeSize); 947cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines if (BCWrapper.getTargetAPI() != mVersion) { 957cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines ALOGE("Bitcode wrapper (%u) and translator (%u) disagree about target API", 967cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines BCWrapper.getTargetAPI(), mVersion); 977cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines } 987cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines 99932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines if ((mVersion != kCurrentAPIVersion) && 100932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines ((mVersion < kMinimumAPIVersion) || 101932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines (mVersion > kMaximumAPIVersion))) { 10210c1412e6cb35cfc90abb5e36ba1340a8c55f44eSteve Block ALOGE("Invalid API version: %u is out of range ('%u' - '%u')", mVersion, 103932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines kMinimumAPIVersion, kMaximumAPIVersion); 104932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines return false; 105932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines } 106932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 107932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines // We currently don't need to transcode any API version higher than 14 or 108932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines // the current API version (i.e. 10000) 109932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines if (mVersion >= kMinimumUntranslatedVersion) { 110932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines mTranslatedBitcode = mBitcode; 111932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines mTranslatedBitcodeSize = mBitcodeSize; 112932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines return true; 113932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines } 114932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 115932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines // Do the actual transcoding by invoking a 2.7-era bitcode reader that can 116932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines // then write the bitcode back out in a more modern (acceptable) version. 117932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines llvm::OwningPtr<llvm::LLVMContext> mContext(new llvm::LLVMContext()); 118932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines llvm::OwningPtr<llvm::MemoryBuffer> MEM( 119932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines llvm::MemoryBuffer::getMemBuffer( 120e708ffe612f4566bea20334d2c9dac34db508e6eStephen Hines llvm::StringRef(mBitcode, mBitcodeSize), "", false)); 121932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines std::string error; 122932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 123932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines // Module ownership is handled by the context, so we don't need to free it. 124c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien llvm::Module *module = NULL; 125c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien 126c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien if (mVersion >= kMinimumCompatibleVersion_LLVM_3_0) { 127c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien module = llvm_3_0::ParseBitcodeFile(MEM.get(), *mContext, &error); 128c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien } else if (mVersion >= kMinimumCompatibleVersion_LLVM_2_7) { 129c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien module = llvm_2_7::ParseBitcodeFile(MEM.get(), *mContext, &error); 130c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien } else { 13110c1412e6cb35cfc90abb5e36ba1340a8c55f44eSteve Block ALOGE("No compatible bitcode reader for API version %d", mVersion); 132c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien return false; 133c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien } 134c7d67a701663191bcdab2416c11b69fae16d49fbLogan Chien 135932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines if (!module) { 13610c1412e6cb35cfc90abb5e36ba1340a8c55f44eSteve Block ALOGE("Could not parse bitcode file"); 13710c1412e6cb35cfc90abb5e36ba1340a8c55f44eSteve Block ALOGE("%s", error.c_str()); 138932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines return false; 139932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines } 140932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 141c73b5214fa71ef6e3378fa121bb8b6312d2e6d3bShih-wei Liao std::string Buffer; 142c73b5214fa71ef6e3378fa121bb8b6312d2e6d3bShih-wei Liao 143c73b5214fa71ef6e3378fa121bb8b6312d2e6d3bShih-wei Liao llvm::raw_string_ostream OS(Buffer); 144c73b5214fa71ef6e3378fa121bb8b6312d2e6d3bShih-wei Liao llvm::WriteBitcodeToFile(module, OS); 145c73b5214fa71ef6e3378fa121bb8b6312d2e6d3bShih-wei Liao OS.flush(); 146932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 1477cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines AndroidBitcodeWrapper wrapper; 1487cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines size_t actualWrapperLen = writeAndroidBitcodeWrapper( 1497cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines &wrapper, Buffer.size(), BCWrapper.getTargetAPI(), 1507cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines BCWrapper.getCompilerVersion(), BCWrapper.getOptimizationLevel()); 1517cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines if (!actualWrapperLen) { 1527cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines ALOGE("Couldn't produce bitcode wrapper!"); 1537cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines return false; 1547cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines } 1557cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines 1567cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines mTranslatedBitcodeSize = actualWrapperLen + Buffer.size(); 1577cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines char *c = new char[mTranslatedBitcodeSize]; 1587cd4c49d575478b2380f129dcd376a4e5e37939cStephen Hines memcpy(c, &wrapper, actualWrapperLen); 159e9c850f5d85f3aa31b6e841478ea52e82d76c261Stephen Hines memcpy(c + actualWrapperLen, Buffer.c_str(), Buffer.size()); 160932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 161932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines mTranslatedBitcode = c; 162932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 163932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines return true; 164932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines} 165932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 166932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines} // namespace bcinfo 167932bc6e35bcef7adff05d890a9dcc7212426fb6aStephen Hines 168