oat_file.h revision ec2cdf4286921131a5f9b3ed12060657ec40f636
12faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes/* 22faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * Copyright (C) 2011 The Android Open Source Project 32faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * 42faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * Licensed under the Apache License, Version 2.0 (the "License"); 52faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * you may not use this file except in compliance with the License. 62faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * You may obtain a copy of the License at 72faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * 82faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * http://www.apache.org/licenses/LICENSE-2.0 92faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * 102faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * Unless required by applicable law or agreed to in writing, software 112faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * distributed under the License is distributed on an "AS IS" BASIS, 122faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 132faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * See the License for the specific language governing permissions and 142faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes * limitations under the License. 152faa5f1271587cda765f26bcf2951065300a01ffElliott Hughes */ 16e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 17fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#ifndef ART_RUNTIME_OAT_FILE_H_ 18fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#define ART_RUNTIME_OAT_FILE_H_ 19e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 203f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko#include <list> 21700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom#include <string> 22e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom#include <vector> 23e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 24aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko#include "base/array_ref.h" 253f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko#include "base/mutex.h" 26539690a351d8c325707368729aafa2b4fa134d4cVladimir Marko#include "base/stringpiece.h" 2797d7e1cd7f733cb33a0e238bec6d7ed525638cd1Vladimir Marko#include "compiler_filter.h" 282dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers#include "dex_file.h" 29120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier#include "dex_file_layout.h" 30f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko#include "index_bss_mapping.h" 3198d1cc8033251c93786e2fa8c59a2e555a9493beMingyao Yang#include "mirror/class.h" 322dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers#include "oat.h" 33700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom#include "os.h" 349aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr#include "type_lookup_table.h" 359aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr#include "utf.h" 366bc4374e3fa00e3ee5e832e1761c43e0b8a71558Nicolas Geoffray#include "utils.h" 37e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 38e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstromnamespace art { 39e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 40ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstromclass BitVector; 41700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstromclass ElfFile; 42120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartierclass DexLayoutSections; 43aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Markotemplate <class MirrorType> class GcRoot; 44700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstromclass MemMap; 4507b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhlerclass OatDexFile; 46513061a792b22c417c938d31c19581390709561cAndreas Gampeclass OatHeader; 47513061a792b22c417c938d31c19581390709561cAndreas Gampeclass OatMethodOffsets; 48513061a792b22c417c938d31c19581390709561cAndreas Gampeclass OatQuickMethodHeader; 4997d7e1cd7f733cb33a0e238bec6d7ed525638cd1Vladimir Markoclass VdexFile; 50700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom 515351da0225d027a19420153615634a1c78966bcaMathieu Chartiernamespace gc { 525351da0225d027a19420153615634a1c78966bcaMathieu Chartiernamespace collector { 535351da0225d027a19420153615634a1c78966bcaMathieu Chartierclass DummyOatFile; 545351da0225d027a19420153615634a1c78966bcaMathieu Chartier} // namespace collector 555351da0225d027a19420153615634a1c78966bcaMathieu Chartier} // namespace gc 565351da0225d027a19420153615634a1c78966bcaMathieu Chartier 577b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil// Runtime representation of the OAT file format which holds compiler output. 587b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil// The class opens an OAT file from storage and maps it to memory, typically with 597b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil// dlopen and provides access to its internal data structures (see OatWriter for 607b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil// for more details about the OAT format). 617b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil// In the process of loading OAT, the class also loads the associated VDEX file 627b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil// with the input DEX files (see VdexFile for details about the VDEX format). 637b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil// The raw DEX data are accessible transparently through the OatDexFile objects. 647b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil 65049cff0ed5e28aa17a17e456efe3121b6d58910fAndreas Gampeclass OatFile { 66e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom public: 67f0192c86a58b2f43378c9a2113007538dd38ddbfJeff Hao // Special classpath that skips shared library check. 68f0192c86a58b2f43378c9a2113007538dd38ddbfJeff Hao static constexpr const char* kSpecialSharedLibrary = "&"; 69f0192c86a58b2f43378c9a2113007538dd38ddbfJeff Hao 7007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler typedef art::OatDexFile OatDexFile; 7107b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 7284d7605f93f1e6e86a16e02017e305c90e93117aAlex Light // Opens an oat file contained within the given elf file. This is always opened as 7384d7605f93f1e6e86a16e02017e305c90e93117aAlex Light // non-executable at the moment. 74c93b3be140f6a57a572f2a4cdaf46aba87235a02David Brazdil static OatFile* OpenWithElfFile(ElfFile* elf_file, 75c93b3be140f6a57a572f2a4cdaf46aba87235a02David Brazdil VdexFile* vdex_file, 76c93b3be140f6a57a572f2a4cdaf46aba87235a02David Brazdil const std::string& location, 77e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler const char* abs_dex_location, 78b1d8c314b55bb2df2b2bb72a3daaf5db65b7ebc7Igor Murashkin std::string* error_msg); 792cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // Open an oat file. Returns null on failure. Requested base can 80e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom // optionally be used to request where the file should be loaded. 81e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // See the ResolveRelativeEncodedDexLocation for a description of how the 82e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // abs_dex_location argument is used. 83e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom static OatFile* Open(const std::string& filename, 84a004aa933a58428489e42d77f707c2b063b73747Brian Carlstrom const std::string& location, 8513735955f39b3b304c37d2b2840663c131262c18Ian Rogers uint8_t* requested_base, 8646774767fcf7780d1455e755729198648d08742eIgor Murashkin uint8_t* oat_file_begin, 878d31bbd3d6536de12bc20e3d29cfe03fe848f9daIan Rogers bool executable, 880b4cbd0c2a75b47ae09d21e5d73d2b1709cb5b9eMathieu Chartier bool low_4gb, 89e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler const char* abs_dex_location, 90b1d8c314b55bb2df2b2bb72a3daaf5db65b7ebc7Igor Murashkin std::string* error_msg); 91e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 92b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera // Similar to OatFile::Open(const std::string...), but accepts input vdex and 93b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera // odex files as file descriptors. 94b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera static OatFile* Open(int vdex_fd, 95b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera int oat_fd, 96b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera const std::string& oat_location, 97b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera uint8_t* requested_base, 98b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera uint8_t* oat_file_begin, 99b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera bool executable, 100b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera bool low_4gb, 101b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera const char* abs_dex_location, 102b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera std::string* error_msg); 103b22dea05178034a40b84953a661f3ea613395d16Shubham Ajmera 104700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom // Open an oat file from an already opened File. 105265091e581c9f643b37e7966890911f09e223269Brian Carlstrom // Does not use dlopen underneath so cannot be used for runtime use 106265091e581c9f643b37e7966890911f09e223269Brian Carlstrom // where relocations may be required. Currently used from 107265091e581c9f643b37e7966890911f09e223269Brian Carlstrom // ImageWriter which wants to open a writable version from an existing 108265091e581c9f643b37e7966890911f09e223269Brian Carlstrom // file descriptor for patching. 109b1d8c314b55bb2df2b2bb72a3daaf5db65b7ebc7Igor Murashkin static OatFile* OpenWritable(File* file, const std::string& location, 110e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler const char* abs_dex_location, 111b1d8c314b55bb2df2b2bb72a3daaf5db65b7ebc7Igor Murashkin std::string* error_msg); 11258cc1cb66c1a96ffba4a314edb2c5b4e8b235d5bNicolas Geoffray // Open an oat file from an already opened File. Maps it PROT_READ, MAP_PRIVATE. 113b1d8c314b55bb2df2b2bb72a3daaf5db65b7ebc7Igor Murashkin static OatFile* OpenReadable(File* file, const std::string& location, 114e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler const char* abs_dex_location, 115b1d8c314b55bb2df2b2bb72a3daaf5db65b7ebc7Igor Murashkin std::string* error_msg); 116700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom 11758cc1cb66c1a96ffba4a314edb2c5b4e8b235d5bNicolas Geoffray // Return the debug info offset of the code item `item` located in `dex_file`. 11858cc1cb66c1a96ffba4a314edb2c5b4e8b235d5bNicolas Geoffray static uint32_t GetDebugInfoOffset(const DexFile& dex_file, 11958cc1cb66c1a96ffba4a314edb2c5b4e8b235d5bNicolas Geoffray const DexFile::CodeItem* item); 12058cc1cb66c1a96ffba4a314edb2c5b4e8b235d5bNicolas Geoffray 121049cff0ed5e28aa17a17e456efe3121b6d58910fAndreas Gampe virtual ~OatFile(); 122e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 1239dcc4572949f6a8231a1b4ed859676ba6f411726Alex Light bool IsExecutable() const { 1249dcc4572949f6a8231a1b4ed859676ba6f411726Alex Light return is_executable_; 1259dcc4572949f6a8231a1b4ed859676ba6f411726Alex Light } 1269dcc4572949f6a8231a1b4ed859676ba6f411726Alex Light 1277ba649636c4475c3992fa15a57acd2546d69ff38Andreas Gampe bool IsPic() const; 1287ba649636c4475c3992fa15a57acd2546d69ff38Andreas Gampe 1290de1133ba600f299b3d67938f650720d9f859eb2Sebastien Hertz // Indicates whether the oat file was compiled with full debugging capability. 1300de1133ba600f299b3d67938f650720d9f859eb2Sebastien Hertz bool IsDebuggable() const; 1310de1133ba600f299b3d67938f650720d9f859eb2Sebastien Hertz 13229d38e77c553c6cf71fc4dafe2d22b4e3f814872Andreas Gampe CompilerFilter::Filter GetCompilerFilter() const; 133b077e15d2d11b7c81aacbcd4a46c2b1e9c9ba20dCalin Juravle 13444e5efa4ae79cf76c65f37fc41c1fa0ed431ec4aCalin Juravle std::string GetClassLoaderContext() const; 13544e5efa4ae79cf76c65f37fc41c1fa0ed431ec4aCalin Juravle 136e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom const std::string& GetLocation() const { 137e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom return location_; 138e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom } 139e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 140e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom const OatHeader& GetOatHeader() const; 141e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 14207b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler class OatMethod FINAL { 1433320cf46afd082398aa401b246e6f301cebdf64dBrian Carlstrom public: 144e401d146407d61eeb99f8d6176b2ac13c4df1e33Mathieu Chartier void LinkMethod(ArtMethod* method) const; 145ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom 146c04c800e7bda94abfadc8c2d30f58c50b261b612Nicolas Geoffray uint32_t GetCodeOffset() const; 147ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom 148c04c800e7bda94abfadc8c2d30f58c50b261b612Nicolas Geoffray const void* GetQuickCode() const; 1492cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom 1502cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // Returns size of quick code. 151ef7d42fca18c16fbaf103822ad16f23246e2905dIan Rogers uint32_t GetQuickCodeSize() const; 1522cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom uint32_t GetQuickCodeSizeOffset() const; 1532cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom 1542cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // Returns OatQuickMethodHeader for debugging. Most callers should 1552cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // use more specific methods such as GetQuickCodeSize. 1562cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom const OatQuickMethodHeader* GetOatQuickMethodHeader() const; 1572cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom uint32_t GetOatQuickMethodHeaderOffset() const; 1580c717dd1c56bd29cf860d0feda8e629dab2cadb3Logan Chien 1597624d25dad2d1ba25969ae704fccf68649103ae5Vladimir Marko size_t GetFrameSizeInBytes() const; 1607624d25dad2d1ba25969ae704fccf68649103ae5Vladimir Marko uint32_t GetCoreSpillMask() const; 1617624d25dad2d1ba25969ae704fccf68649103ae5Vladimir Marko uint32_t GetFpSpillMask() const; 1622cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom 1638a630577ed2d9e9571c3434c505e5de223b23c07Vladimir Marko const uint8_t* GetVmapTable() const; 1642cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom uint32_t GetVmapTableOffset() const; 1652cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom uint32_t GetVmapTableOffsetOffset() const; 1668a630577ed2d9e9571c3434c505e5de223b23c07Vladimir Marko 167ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom // Create an OatMethod with offsets relative to the given base address 168957ca1cd025104fccb0b08928f955f9bdb4ab91cMathieu Chartier OatMethod(const uint8_t* base, const uint32_t code_offset) 169957ca1cd025104fccb0b08928f955f9bdb4ab91cMathieu Chartier : begin_(base), code_offset_(code_offset) { 17097b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers } 171758a801b66c134361a7b43f7e83f85d1fb800c4cAndreas Gampe OatMethod(const OatMethod&) = default; 17297b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers ~OatMethod() {} 1733320cf46afd082398aa401b246e6f301cebdf64dBrian Carlstrom 174758a801b66c134361a7b43f7e83f85d1fb800c4cAndreas Gampe OatMethod& operator=(const OatMethod&) = default; 175758a801b66c134361a7b43f7e83f85d1fb800c4cAndreas Gampe 17697b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers // A representation of an invalid OatMethod, used when an OatMethod or OatClass can't be found. 17797b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers // See ClassLinker::FindOatMethodFor. 17897b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers static const OatMethod Invalid() { 179957ca1cd025104fccb0b08928f955f9bdb4ab91cMathieu Chartier return OatMethod(nullptr, -1); 18097b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers } 1814fcdc94d22a4608e355aa8df36240181149d10e8Nicolas Geoffray 182ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom private: 183ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom template<class T> 184ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom T GetOatPointer(uint32_t offset) const { 185ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom if (offset == 0) { 1862cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier return nullptr; 187ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom } 18830fab40ee5a07af6b8c3b6b0e9438071695a57f4Ian Rogers return reinterpret_cast<T>(begin_ + offset); 189ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom } 1903320cf46afd082398aa401b246e6f301cebdf64dBrian Carlstrom 191e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier const uint8_t* begin_; 192e5f13e57ff8fa36342beb33830b3ec5942a61ccaMathieu Chartier uint32_t code_offset_; 193ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom 194ae826983f7903bc0a6bbbe8426bf393fb2f6d747Brian Carlstrom friend class OatClass; 1953320cf46afd082398aa401b246e6f301cebdf64dBrian Carlstrom }; 1963320cf46afd082398aa401b246e6f301cebdf64dBrian Carlstrom 19707b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler class OatClass FINAL { 198e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom public: 199ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom mirror::Class::Status GetStatus() const { 200ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom return status_; 201ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom } 202ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom 203ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom OatClassType GetType() const { 204ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom return type_; 205ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom } 2060755ec5ea1dce0b549fc1adefeb52d89f119ebecBrian Carlstrom 207eb8167a4f4d27fce0530f6724ab8032610cd146bMathieu Chartier // Get the OatMethod entry based on its index into the class 2082cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // defintion. Direct methods come first, followed by virtual 2092cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // methods. Note that runtime created methods such as miranda 210e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom // methods are not included. 211aded5f7ab991f3c1132851599d3bc60ff6707eedBrian Carlstrom const OatMethod GetOatMethod(uint32_t method_index) const; 212e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 2132cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // Return a pointer to the OatMethodOffsets for the requested 2142cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // method_index, or null if none is present. Note that most 2152cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // callers should use GetOatMethod. 2162cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom const OatMethodOffsets* GetOatMethodOffsets(uint32_t method_index) const; 2172cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom 2182cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // Return the offset from the start of the OatFile to the 2192cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // OatMethodOffsets for the requested method_index, or 0 if none 2202cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom // is present. Note that most callers should use GetOatMethod. 2212cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom uint32_t GetOatMethodOffsetsOffset(uint32_t method_index) const; 2222cbaccb67e22c0b313a9785bfc65bcb4b25d0676Brian Carlstrom 22397b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers // A representation of an invalid OatClass, used when an OatClass can't be found. 22497d7e1cd7f733cb33a0e238bec6d7ed525638cd1Vladimir Marko // See FindOatClass(). 22597b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers static OatClass Invalid() { 22672ab684871f870aead76b23cb67deb046107b380Vladimir Marko return OatClass(/* oat_file */ nullptr, 22772ab684871f870aead76b23cb67deb046107b380Vladimir Marko mirror::Class::kStatusErrorUnresolved, 22872ab684871f870aead76b23cb67deb046107b380Vladimir Marko kOatClassNoneCompiled, 22972ab684871f870aead76b23cb67deb046107b380Vladimir Marko /* bitmap_size */ 0, 23072ab684871f870aead76b23cb67deb046107b380Vladimir Marko /* bitmap_pointer */ nullptr, 23172ab684871f870aead76b23cb67deb046107b380Vladimir Marko /* methods_pointer */ nullptr); 23297b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers } 2334fcdc94d22a4608e355aa8df36240181149d10e8Nicolas Geoffray 234e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom private: 2350755ec5ea1dce0b549fc1adefeb52d89f119ebecBrian Carlstrom OatClass(const OatFile* oat_file, 2362dd0e2cea360bc9206eb88ecc40d259e796c239dIan Rogers mirror::Class::Status status, 237ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom OatClassType type, 238ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom uint32_t bitmap_size, 239ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom const uint32_t* bitmap_pointer, 2400755ec5ea1dce0b549fc1adefeb52d89f119ebecBrian Carlstrom const OatMethodOffsets* methods_pointer); 2413320cf46afd082398aa401b246e6f301cebdf64dBrian Carlstrom 24297b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers const OatFile* const oat_file_; 243ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom 24497b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers const mirror::Class::Status status_; 245ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom 24697b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers const OatClassType type_; 247ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom 24897b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers const uint32_t* const bitmap_; 249ba150c37d582eeeb8c11ba5245edc281cf31793cBrian Carlstrom 25097b52f89e5e0b52a08d4b9a3953d0973a3cf5636Ian Rogers const OatMethodOffsets* const methods_pointer_; 251e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 25207b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler friend class art::OatDexFile; 253e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom }; 2549a37efc6e1a8dd9fe6978f209fb493510267c528Richard Uhler 2559a37efc6e1a8dd9fe6978f209fb493510267c528Richard Uhler // Get the OatDexFile for the given dex_location within this oat file. 2569a37efc6e1a8dd9fe6978f209fb493510267c528Richard Uhler // If dex_location_checksum is non-null, the OatDexFile will only be 2579a37efc6e1a8dd9fe6978f209fb493510267c528Richard Uhler // returned if it has a matching checksum. 2589a37efc6e1a8dd9fe6978f209fb493510267c528Richard Uhler // If error_msg is non-null and no OatDexFile is returned, error_msg will 2599a37efc6e1a8dd9fe6978f209fb493510267c528Richard Uhler // be updated with a description of why no OatDexFile was returned. 2608d31bbd3d6536de12bc20e3d29cfe03fe848f9daIan Rogers const OatDexFile* GetOatDexFile(const char* dex_location, 261756ee4e090bc1e1812b41fb7b4661df601a32ef9Brian Carlstrom const uint32_t* const dex_location_checksum, 2629a37efc6e1a8dd9fe6978f209fb493510267c528Richard Uhler /*out*/std::string* error_msg = nullptr) const 26390443477f9a0061581c420775ce3b7eeae7468bcMathieu Chartier REQUIRES(!secondary_lookup_lock_); 2648d31bbd3d6536de12bc20e3d29cfe03fe848f9daIan Rogers 265aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko const std::vector<const OatDexFile*>& GetOatDexFiles() const { 266aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko return oat_dex_files_storage_; 267aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko } 268e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 26930fab40ee5a07af6b8c3b6b0e9438071695a57f4Ian Rogers size_t Size() const { 27030fab40ee5a07af6b8c3b6b0e9438071695a57f4Ian Rogers return End() - Begin(); 271e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom } 272e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 2736ea1a0e2168c8d9b6d97c075c73a72d84080f45bMingyao Yang bool Contains(const void* p) const { 2746ea1a0e2168c8d9b6d97c075c73a72d84080f45bMingyao Yang return p >= Begin() && p < End(); 2756ea1a0e2168c8d9b6d97c075c73a72d84080f45bMingyao Yang } 2766ea1a0e2168c8d9b6d97c075c73a72d84080f45bMingyao Yang 2775c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko size_t BssSize() const { 2785c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko return BssEnd() - BssBegin(); 2795c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko } 2805c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko 281ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky size_t VdexSize() const { 282ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky return VdexEnd() - VdexBegin(); 283ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky } 284ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky 2850eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko size_t BssMethodsOffset() const { 2860eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko // Note: This is used only for symbolizer and needs to return a valid .bss offset. 2870eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko return (bss_methods_ != nullptr) ? bss_methods_ - BssBegin() : BssRootsOffset(); 2880eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko } 2890eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko 290aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko size_t BssRootsOffset() const { 2910eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko // Note: This is used only for symbolizer and needs to return a valid .bss offset. 2920eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko return (bss_roots_ != nullptr) ? bss_roots_ - BssBegin() : BssSize(); 293aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko } 294aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko 2957b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil size_t DexSize() const { 2967b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil return DexEnd() - DexBegin(); 2977b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil } 2987b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil 29913735955f39b3b304c37d2b2840663c131262c18Ian Rogers const uint8_t* Begin() const; 30013735955f39b3b304c37d2b2840663c131262c18Ian Rogers const uint8_t* End() const; 30153cb16b98acf3cf6f3a1e2204ad4958ecf1b5a3cAlex Light 3025c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko const uint8_t* BssBegin() const; 3035c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko const uint8_t* BssEnd() const; 3045c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko 305ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky const uint8_t* VdexBegin() const; 306ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky const uint8_t* VdexEnd() const; 307ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky 3087b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil const uint8_t* DexBegin() const; 3097b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil const uint8_t* DexEnd() const; 3107b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil 3110eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko ArrayRef<ArtMethod*> GetBssMethods() const; 312aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko ArrayRef<GcRoot<mirror::Object>> GetBssGcRoots() const; 313aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko 314e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // Returns the absolute dex location for the encoded relative dex location. 315e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // 3162cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // If not null, abs_dex_location is used to resolve the absolute dex 317e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // location of relative dex locations encoded in the oat file. 318e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // For example, given absolute location "/data/app/foo/base.apk", encoded 319a308a327884920cbb1e3e62964c4b5a01c29af8cCalin Juravle // dex locations "base.apk", "base.apk!classes2.dex", etc. would be resolved 320a308a327884920cbb1e3e62964c4b5a01c29af8cCalin Juravle // to "/data/app/foo/base.apk", "/data/app/foo/base.apk!classes2.dex", etc. 321e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // Relative encoded dex locations that don't match the given abs_dex_location 322e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler // are left unchanged. 323e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler static std::string ResolveRelativeEncodedDexLocation( 324e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler const char* abs_dex_location, const std::string& rel_dex_location); 325e5fed03772144595c0904faf3d6974cc55214c8cRichard Uhler 32697d7e1cd7f733cb33a0e238bec6d7ed525638cd1Vladimir Marko // Finds the associated oat class for a dex_file and descriptor. Returns an invalid OatClass on 32797d7e1cd7f733cb33a0e238bec6d7ed525638cd1Vladimir Marko // error and sets found to false. 32897d7e1cd7f733cb33a0e238bec6d7ed525638cd1Vladimir Marko static OatClass FindOatClass(const DexFile& dex_file, uint16_t class_def_idx, bool* found); 32997d7e1cd7f733cb33a0e238bec6d7ed525638cd1Vladimir Marko 3304acefd33064d37b41ca55c3c9355345a20e5f9c2Nicolas Geoffray VdexFile* GetVdexFile() const { 3314acefd33064d37b41ca55c3c9355345a20e5f9c2Nicolas Geoffray return vdex_.get(); 3324acefd33064d37b41ca55c3c9355345a20e5f9c2Nicolas Geoffray } 3334acefd33064d37b41ca55c3c9355345a20e5f9c2Nicolas Geoffray 334ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray // Whether the OatFile embeds the Dex code. 335ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray bool ContainsDexCode() const { 336ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray return uncompressed_dex_files_ == nullptr; 337ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray } 338ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray 339049cff0ed5e28aa17a17e456efe3121b6d58910fAndreas Gampe protected: 340049cff0ed5e28aa17a17e456efe3121b6d58910fAndreas Gampe OatFile(const std::string& filename, bool executable); 341e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 342049cff0ed5e28aa17a17e456efe3121b6d58910fAndreas Gampe private: 343e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom // The oat file name. 344e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom // 345e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom // The image will embed this to link its associated oat file. 346e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom const std::string location_; 347e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 3487b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil // Pointer to the Vdex file with the Dex files for this Oat file. 3497b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil std::unique_ptr<VdexFile> vdex_; 3507b49e6cade09bc65b3b5f22d45fc9d0a7184e4f2David Brazdil 351700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom // Pointer to OatHeader. 35213735955f39b3b304c37d2b2840663c131262c18Ian Rogers const uint8_t* begin_; 353700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom 354700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom // Pointer to end of oat region for bounds checking. 35513735955f39b3b304c37d2b2840663c131262c18Ian Rogers const uint8_t* end_; 356700c8d31733534a3d978b75a03f6f7e177dc7e81Brian Carlstrom 3572cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // Pointer to the .bss section, if present, otherwise null. 35806d7aaa75f3d6d21fe904d54208b28e486673d97Vladimir Marko uint8_t* bss_begin_; 3595c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko 3602cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // Pointer to the end of the .bss section, if present, otherwise null. 36106d7aaa75f3d6d21fe904d54208b28e486673d97Vladimir Marko uint8_t* bss_end_; 3625c42c29b89286e5efa4a4613132b09051ce5945bVladimir Marko 3630eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko // Pointer to the beginning of the ArtMethod*s in .bss section, if present, otherwise null. 3640eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko uint8_t* bss_methods_; 3650eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko 366aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko // Pointer to the beginning of the GC roots in .bss section, if present, otherwise null. 367aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko uint8_t* bss_roots_; 368aad75c6d5bfab2dc8e30fc99fafe8cd2dc8b74d8Vladimir Marko 3699dcc4572949f6a8231a1b4ed859676ba6f411726Alex Light // Was this oat_file loaded executable? 3709dcc4572949f6a8231a1b4ed859676ba6f411726Alex Light const bool is_executable_; 3719dcc4572949f6a8231a1b4ed859676ba6f411726Alex Light 372ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky // Pointer to the .vdex section, if present, otherwise null. 373ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky uint8_t* vdex_begin_; 374ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky 375ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky // Pointer to the end of the .vdex section, if present, otherwise null. 376ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky uint8_t* vdex_end_; 377ec2cdf4286921131a5f9b3ed12060657ec40f636David Srbecky 378aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko // Owning storage for the OatDexFile objects. 379aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko std::vector<const OatDexFile*> oat_dex_files_storage_; 380aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko 3813f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // NOTE: We use a StringPiece as the key type to avoid a memory allocation on every 3823f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // lookup with a const char* key. The StringPiece doesn't own its backing storage, 3833f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // therefore we're using the OatDexFile::dex_file_location_ as the backing storage 3843f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // for keys in oat_dex_files_ and the string_cache_ entries for the backing storage 3853f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // of keys in secondary_oat_dex_files_ and oat_dex_files_by_canonical_location_. 386bad0267eaab9d6a522d05469ff90501deefdb88bMathieu Chartier typedef AllocationTrackingSafeMap<StringPiece, const OatDexFile*, kAllocatorTagOatFile> Table; 3873f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko 388aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko // Map each location and canonical location (if different) retrieved from the 389aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko // oat file to its OatDexFile. This map doesn't change after it's constructed in Setup() 390aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko // and therefore doesn't need any locking and provides the cheapest dex file lookup 3912cebb24bfc3247d3e9be138a3350106737455918Mathieu Chartier // for GetOatDexFile() for a very frequent use case. Never contains a null value. 392aa4497db59f1eeec954f2ba5da6d458fcdf9b3a4Vladimir Marko Table oat_dex_files_; 3933f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko 3943f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // Lock guarding all members needed for secondary lookup in GetOatDexFile(). 3953f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko mutable Mutex secondary_lookup_lock_ DEFAULT_MUTEX_ACQUIRED_AFTER; 3963f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko 3973f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // If the primary oat_dex_files_ lookup fails, use a secondary map. This map stores 3983f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // the results of all previous secondary lookups, whether successful (non-null) or 3993f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // failed (null). If it doesn't contain an entry we need to calculate the canonical 4003f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // location and use oat_dex_files_by_canonical_location_. 4013f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko mutable Table secondary_oat_dex_files_ GUARDED_BY(secondary_lookup_lock_); 4023f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko 4033f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // Cache of strings. Contains the backing storage for keys in the secondary_oat_dex_files_ 4043f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // and the lazily initialized oat_dex_files_by_canonical_location_. 4053f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // NOTE: We're keeping references to contained strings in form of StringPiece and adding 4063f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // new strings to the end. The adding of a new element must not touch any previously stored 4073f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko // elements. std::list<> and std::deque<> satisfy this requirement, std::vector<> doesn't. 4083f5838d7d0b9fc63db0ccc35c2ea05ed29264986Vladimir Marko mutable std::list<std::string> string_cache_ GUARDED_BY(secondary_lookup_lock_); 409e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 410ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray // Cache of dex files mapped directly from a location, in case the OatFile does 411ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray // not embed the dex code. 412ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray std::unique_ptr<std::vector<std::unique_ptr<const DexFile>>> uncompressed_dex_files_; 413ae7e83817e546848ef6b2949dd9065b153e14316Nicolas Geoffray 4145351da0225d027a19420153615634a1c78966bcaMathieu Chartier friend class gc::collector::DummyOatFile; // For modifying begin_ and end_. 415e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom friend class OatClass; 41607b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler friend class art::OatDexFile; 417e3c845cdb5884e770287a5c0c65c8bb64733c388Elliott Hughes friend class OatDumper; // For GetBase and GetLimit 418049cff0ed5e28aa17a17e456efe3121b6d58910fAndreas Gampe friend class OatFileBase; 419e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom DISALLOW_COPY_AND_ASSIGN(OatFile); 420e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom}; 421e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 42207b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler// OatDexFile should be an inner class of OatFile. Unfortunately, C++ doesn't 42307b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler// support forward declarations of inner classes, and we want to 42407b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler// forward-declare OatDexFile so that we can store an opaque pointer to an 42507b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler// OatDexFile in DexFile. 42607b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhlerclass OatDexFile FINAL { 42707b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler public: 42807b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler // Opens the DexFile referred to by this OatDexFile from within the containing OatFile. 429b1d8c314b55bb2df2b2bb72a3daaf5db65b7ebc7Igor Murashkin std::unique_ptr<const DexFile> OpenDexFile(std::string* error_msg) const; 43007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 4311b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier // May return null if the OatDexFile only contains a type lookup table. This case only happens 4321b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier // for the compiler to speed up compilation. 43307b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const OatFile* GetOatFile() const { 4341b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier // Avoid pulling in runtime.h in the header file. 4351b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier if (kIsDebugBuild && oat_file_ == nullptr) { 4361b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier AssertAotCompiler(); 4371b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier } 43807b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler return oat_file_; 43907b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler } 44007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 44107b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler // Returns the size of the DexFile refered to by this OatDexFile. 44207b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler size_t FileSize() const; 44307b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 44407b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler // Returns original path of DexFile that was the source of this OatDexFile. 44507b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const std::string& GetDexFileLocation() const { 44607b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler return dex_file_location_; 44707b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler } 44807b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 44907b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler // Returns the canonical location of DexFile that was the source of this OatDexFile. 45007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const std::string& GetCanonicalDexFileLocation() const { 45107b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler return canonical_dex_file_location_; 45207b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler } 45307b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 45407b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler // Returns checksum of original DexFile that was the source of this OatDexFile; 45507b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler uint32_t GetDexFileLocationChecksum() const { 45607b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler return dex_file_location_checksum_; 45707b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler } 45807b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 45907b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler // Returns the OatClass for the class specified by the given DexFile class_def_index. 46007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler OatFile::OatClass GetOatClass(uint16_t class_def_index) const; 46107b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 46207b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler // Returns the offset to the OatClass information. Most callers should use GetOatClass. 46307b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler uint32_t GetOatClassOffset(uint16_t class_def_index) const; 46407b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 465d9786b0e5be23ea0258405165098b4216579209cArtem Udovichenko const uint8_t* GetLookupTableData() const { 466d9786b0e5be23ea0258405165098b4216579209cArtem Udovichenko return lookup_table_data_; 467d9786b0e5be23ea0258405165098b4216579209cArtem Udovichenko } 468d9786b0e5be23ea0258405165098b4216579209cArtem Udovichenko 469f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* GetMethodBssMapping() const { 4700eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko return method_bss_mapping_; 4710eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko } 4720eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko 473f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* GetTypeBssMapping() const { 474f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko return type_bss_mapping_; 475f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko } 476f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko 477f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* GetStringBssMapping() const { 478f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko return string_bss_mapping_; 479f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko } 480f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko 4812ba8895b4257d0e32a7b269bc2e7f6a3ec39a86aAndreas Gampe const uint8_t* GetDexFilePointer() const { 4822ba8895b4257d0e32a7b269bc2e7f6a3ec39a86aAndreas Gampe return dex_file_pointer_; 4832ba8895b4257d0e32a7b269bc2e7f6a3ec39a86aAndreas Gampe } 4842ba8895b4257d0e32a7b269bc2e7f6a3ec39a86aAndreas Gampe 4859aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr // Looks up a class definition by its class descriptor. Hash must be 4869aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr // ComputeModifiedUtf8Hash(descriptor). 4879aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr static const DexFile::ClassDef* FindClassDef(const DexFile& dex_file, 4889aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr const char* descriptor, 4899aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr size_t hash); 4909aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr 491120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier // Madvise the dex file based on the state we are moving to. 492120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier static void MadviseDexFile(const DexFile& dex_file, MadviseState state); 493120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier 4949aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr TypeLookupTable* GetTypeLookupTable() const { 4959aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr return lookup_table_.get(); 4969aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr } 4979aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr 49807b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler ~OatDexFile(); 49907b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 5001b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier // Create only with a type lookup table, used by the compiler to speed up compilation. 5011b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier explicit OatDexFile(std::unique_ptr<TypeLookupTable>&& lookup_table); 5021b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier 503120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier // Return the dex layout sections. 504120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier const DexLayoutSections* GetDexLayoutSections() const { 505120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier return dex_layout_sections_; 506120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier } 507120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier 50807b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler private: 50907b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler OatDexFile(const OatFile* oat_file, 51007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const std::string& dex_file_location, 51107b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const std::string& canonical_dex_file_location, 51207b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler uint32_t dex_file_checksum, 51307b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const uint8_t* dex_file_pointer, 514d9786b0e5be23ea0258405165098b4216579209cArtem Udovichenko const uint8_t* lookup_table_data, 515f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* method_bss_mapping, 516f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* type_bss_mapping, 517f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* string_bss_mapping, 51809d0943f5efe92c1f3a6b9dbdf255adb0f960a22Vladimir Marko const uint32_t* oat_class_offsets_pointer, 519120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier const DexLayoutSections* dex_layout_sections); 52007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 5211b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier static void AssertAotCompiler(); 5221b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier 5231b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier const OatFile* const oat_file_ = nullptr; 52407b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const std::string dex_file_location_; 52507b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler const std::string canonical_dex_file_location_; 5261b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier const uint32_t dex_file_location_checksum_ = 0u; 5271b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier const uint8_t* const dex_file_pointer_ = nullptr; 5280eb882bfc5d260e8014c26adfda11602065aa5d8Vladimir Marko const uint8_t* const lookup_table_data_ = nullptr; 529f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* const method_bss_mapping_ = nullptr; 530f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* const type_bss_mapping_ = nullptr; 531f3c52b42a035902245d00a619fed0275afb063d2Vladimir Marko const IndexBssMapping* const string_bss_mapping_ = nullptr; 5321b868498a176705b867e2572cc1bcbd58dbd62d6Mathieu Chartier const uint32_t* const oat_class_offsets_pointer_ = 0u; 5339aa352e92b6ca0f2250cb7f54dfbf4b1be714c19David Sehr mutable std::unique_ptr<TypeLookupTable> lookup_table_; 534120aa286ab6adf3e76a31bc61fb4e583e5158d71Mathieu Chartier const DexLayoutSections* const dex_layout_sections_ = nullptr; 53507b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 53607b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler friend class OatFile; 537049cff0ed5e28aa17a17e456efe3121b6d58910fAndreas Gampe friend class OatFileBase; 53807b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler DISALLOW_COPY_AND_ASSIGN(OatDexFile); 53907b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler}; 54007b3c2351bb527ea91c084dc19434600af9ae66bRichard Uhler 541e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom} // namespace art 542e24fa61603a60ade3797e4a0c8b3fccb346cb048Brian Carlstrom 543fc0e3219edc9a5bf81b166e82fd5db2796eb6a0dBrian Carlstrom#endif // ART_RUNTIME_OAT_FILE_H_ 544