blob: 1188c97658eae50f551c219c1afed7fa17d1cc88 [file] [log] [blame]
Brian Carlstrom700c8d32012-11-05 10:42:02 -08001/*
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
Brian Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_ELF_FILE_H_
18#define ART_RUNTIME_ELF_FILE_H_
Brian Carlstrom700c8d32012-11-05 10:42:02 -080019
Ian Rogersd4c4d952014-10-16 20:31:53 -070020#include <memory>
Tong Shen62d1ca32014-09-03 17:24:56 -070021#include <string>
Brian Carlstrom700c8d32012-11-05 10:42:02 -080022
Ian Rogersd4c4d952014-10-16 20:31:53 -070023#include "base/macros.h"
24// Explicitly include our own elf.h to avoid Linux and other dependencies.
25#include "./elf.h"
26#include "os.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080027
28namespace art {
David Srbecky533c2072015-04-22 12:20:22 +010029template <typename ElfTypes>
Ian Rogersd4c4d952014-10-16 20:31:53 -070030class ElfFileImpl;
31
32// Explicitly instantiated in elf_file.cc
David Srbecky533c2072015-04-22 12:20:22 +010033typedef ElfFileImpl<ElfTypes32> ElfFileImpl32;
34typedef ElfFileImpl<ElfTypes64> ElfFileImpl64;
Brian Carlstrom700c8d32012-11-05 10:42:02 -080035
36// Used for compile time and runtime for ElfFile access. Because of
37// the need for use at runtime, cannot directly use LLVM classes such as
38// ELFObjectFile.
39class ElfFile {
40 public:
Igor Murashkin46774762014-10-22 11:37:02 -070041 static ElfFile* Open(File* file, bool writable, bool program_header_only, std::string* error_msg,
42 uint8_t* requested_base = nullptr); // TODO: move arg to before error_msg.
Alex Light3470ab42014-06-18 10:35:45 -070043 // Open with specific mmap flags, Always maps in the whole file, not just the
44 // program header sections.
45 static ElfFile* Open(File* file, int mmap_prot, int mmap_flags, std::string* error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -080046 ~ElfFile();
47
48 // Load segments into memory based on PT_LOAD program headers
Ian Rogers8d31bbd2013-10-13 10:44:14 -070049 bool Load(bool executable, std::string* error_msg);
Brian Carlstrom700c8d32012-11-05 10:42:02 -080050
Ian Rogers13735952014-10-08 12:43:28 -070051 const uint8_t* FindDynamicSymbolAddress(const std::string& symbol_name) const;
Tong Shen62d1ca32014-09-03 17:24:56 -070052
53 size_t Size() const;
54
Igor Murashkin46774762014-10-22 11:37:02 -070055 // The start of the memory map address range for this ELF file.
Ian Rogers13735952014-10-08 12:43:28 -070056 uint8_t* Begin() const;
Tong Shen62d1ca32014-09-03 17:24:56 -070057
Igor Murashkin46774762014-10-22 11:37:02 -070058 // The end of the memory map address range for this ELF file.
Ian Rogers13735952014-10-08 12:43:28 -070059 uint8_t* End() const;
Tong Shen62d1ca32014-09-03 17:24:56 -070060
61 const File& GetFile() const;
62
Alex Light0eb76d22015-08-11 18:03:47 -070063 bool GetSectionOffsetAndSize(const char* section_name, uint64_t* offset, uint64_t* size) const;
Tong Shen62d1ca32014-09-03 17:24:56 -070064
65 uint64_t FindSymbolAddress(unsigned section_type,
66 const std::string& symbol_name,
67 bool build_map);
68
Vladimir Marko3fc99032015-05-13 19:06:30 +010069 bool GetLoadedSize(size_t* size, std::string* error_msg) const;
Tong Shen62d1ca32014-09-03 17:24:56 -070070
71 // Strip an ELF file of unneeded debugging information.
72 // Returns true on success, false on failure.
73 static bool Strip(File* file, std::string* error_msg);
74
75 // Fixup an ELF file so that that oat header will be loaded at oat_begin.
76 // Returns true on success, false on failure.
Andreas Gampe3c54b002015-04-07 16:09:30 -070077 static bool Fixup(File* file, uint64_t oat_data_begin);
Tong Shen62d1ca32014-09-03 17:24:56 -070078
Andreas Gampe3c54b002015-04-07 16:09:30 -070079 bool Fixup(uint64_t base_address);
Tong Shen62d1ca32014-09-03 17:24:56 -070080
Ian Rogersd4c4d952014-10-16 20:31:53 -070081 bool Is64Bit() const {
82 return elf64_.get() != nullptr;
83 }
84
85 ElfFileImpl32* GetImpl32() const {
86 return elf32_.get();
87 }
88
89 ElfFileImpl64* GetImpl64() const {
90 return elf64_.get();
91 }
Yevgeny Roubane3ea8382014-08-08 16:29:38 +070092
Brian Carlstrom700c8d32012-11-05 10:42:02 -080093 private:
Tong Shen62d1ca32014-09-03 17:24:56 -070094 explicit ElfFile(ElfFileImpl32* elf32);
95 explicit ElfFile(ElfFileImpl64* elf64);
Brian Carlstrom700c8d32012-11-05 10:42:02 -080096
Ian Rogersd4c4d952014-10-16 20:31:53 -070097 const std::unique_ptr<ElfFileImpl32> elf32_;
98 const std::unique_ptr<ElfFileImpl64> elf64_;
99
100 DISALLOW_COPY_AND_ASSIGN(ElfFile);
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800101};
102
103} // namespace art
104
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700105#endif // ART_RUNTIME_ELF_FILE_H_