1 /* 2 * Copyright (C) 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 #ifndef ART_DEX2OAT_LINKER_ELF_WRITER_H_ 18 #define ART_DEX2OAT_LINKER_ELF_WRITER_H_ 19 20 #include <stdint.h> 21 22 #include <cstddef> 23 #include <string> 24 #include <vector> 25 26 #include "base/array_ref.h" 27 #include "base/macros.h" 28 #include "base/mutex.h" 29 #include "base/os.h" 30 #include "debug/debug_info.h" 31 #include "thread_pool.h" 32 33 namespace art { 34 35 class ElfFile; 36 class OutputStream; 37 38 namespace debug { 39 struct MethodDebugInfo; 40 } // namespace debug 41 42 namespace linker { 43 44 class ElfWriter { 45 public: 46 // Looks up information about location of oat file in elf file container. 47 // Used for ImageWriter to perform memory layout. 48 static void GetOatElfInformation(File* file, 49 size_t* oat_loaded_size, 50 size_t* oat_data_offset); 51 52 // Returns runtime oat_data runtime address for an opened ElfFile. 53 static uintptr_t GetOatDataAddress(ElfFile* elf_file); 54 ~ElfWriter()55 virtual ~ElfWriter() {} 56 57 virtual void Start() = 0; 58 // Prepares memory layout of the whole ELF file, and creates dynamic symbols 59 // which point to specific areas of interest (usually section begin and end). 60 // This is needed as multi-image needs to know the memory layout of all ELF 61 // files, before starting to write them. 62 // This method must be called before calling GetLoadedSize(). 63 virtual void PrepareDynamicSection(size_t rodata_size, 64 size_t text_size, 65 size_t data_img_rel_ro_size, 66 size_t data_img_rel_ro_app_image_offset, 67 size_t bss_size, 68 size_t bss_methods_offset, 69 size_t bss_roots_offset, 70 size_t dex_section_size) = 0; 71 virtual std::unique_ptr<ThreadPool> PrepareDebugInfo(const debug::DebugInfo& debug_info) = 0; 72 virtual OutputStream* StartRoData() = 0; 73 virtual void EndRoData(OutputStream* rodata) = 0; 74 virtual OutputStream* StartText() = 0; 75 virtual void EndText(OutputStream* text) = 0; 76 virtual OutputStream* StartDataImgRelRo() = 0; 77 virtual void EndDataImgRelRo(OutputStream* data_img_rel_ro) = 0; 78 virtual void WriteDynamicSection() = 0; 79 virtual void WriteDebugInfo(const debug::DebugInfo& debug_info) = 0; 80 virtual bool StripDebugInfo() = 0; 81 virtual bool End() = 0; 82 83 // Get the ELF writer's stream. This stream can be used for writing data directly 84 // to a section after the section has been finished. When that's done, the user 85 // should Seek() back to the position where the stream was before this operation. 86 virtual OutputStream* GetStream() = 0; 87 88 // Get the size that the loaded ELF file will occupy in memory. 89 virtual size_t GetLoadedSize() = 0; 90 91 protected: 92 ElfWriter() = default; 93 }; 94 95 } // namespace linker 96 } // namespace art 97 98 #endif // ART_DEX2OAT_LINKER_ELF_WRITER_H_ 99