blob: bec69946e3bc20438dd72b010b5df56778b17a76 [file] [log] [blame]
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001/*
2 * Copyright (C) 2012 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the
13 * distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
Elliott Hughes650be4e2013-03-05 18:47:58 -080029#include "linker_phdr.h"
30
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020031#include <errno.h>
Elliott Hughes05fc1d72015-01-28 18:02:33 -080032#include <string.h>
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020033#include <sys/mman.h>
Elliott Hughes99d54652018-08-22 10:36:23 -070034#include <sys/prctl.h>
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +000035#include <sys/types.h>
36#include <sys/stat.h>
37#include <unistd.h>
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020038
Mitch Phillipse8139f52022-11-23 15:18:01 -080039#include "android-base/unique_fd.h"
Elliott Hughes650be4e2013-03-05 18:47:58 -080040#include "linker.h"
Mitch Phillipse8139f52022-11-23 15:18:01 -080041#include "linker_debug.h"
Elliott Hughes4cc5a602016-11-15 16:54:16 -080042#include "linker_dlwarning.h"
Dimitry Ivanov48ec2882016-08-04 11:50:36 -070043#include "linker_globals.h"
Mitch Phillipse8139f52022-11-23 15:18:01 -080044#include "linker_main.h"
Dmitriy Ivanov3c524812015-11-20 17:28:12 -080045#include "linker_utils.h"
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020046
Evgenii Stepanov0a3637d2016-07-06 13:20:59 -070047#include "private/CFIShadow.h" // For kLibraryAlignment
Dimitry Ivanov1b84afc2016-01-27 18:12:03 -080048
Elliott Hughesb5140262014-12-02 16:16:29 -080049static int GetTargetElfMachine() {
50#if defined(__arm__)
51 return EM_ARM;
52#elif defined(__aarch64__)
53 return EM_AARCH64;
54#elif defined(__i386__)
55 return EM_386;
Elliott Hughes43462702022-10-10 19:21:44 +000056#elif defined(__riscv)
57 return EM_RISCV;
Elliott Hughesb5140262014-12-02 16:16:29 -080058#elif defined(__x86_64__)
59 return EM_X86_64;
60#endif
61}
62
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020063/**
64 TECHNICAL NOTE ON ELF LOADING.
65
66 An ELF file's program header table contains one or more PT_LOAD
67 segments, which corresponds to portions of the file that need to
68 be mapped into the process' address space.
69
70 Each loadable segment has the following important properties:
71
72 p_offset -> segment file offset
73 p_filesz -> segment file size
74 p_memsz -> segment memory size (always >= p_filesz)
75 p_vaddr -> segment's virtual address
76 p_flags -> segment flags (e.g. readable, writable, executable)
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -070077 p_align -> segment's in-memory and in-file alignment
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020078
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -070079 We will ignore the p_paddr field of ElfW(Phdr) for now.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020080
81 The loadable segments can be seen as a list of [p_vaddr ... p_vaddr+p_memsz)
82 ranges of virtual addresses. A few rules apply:
83
84 - the virtual address ranges should not overlap.
85
86 - if a segment's p_filesz is smaller than its p_memsz, the extra bytes
87 between them should always be initialized to 0.
88
89 - ranges do not necessarily start or end at page boundaries. Two distinct
90 segments can have their start and end on the same page. In this case, the
91 page inherits the mapping flags of the latter segment.
92
93 Finally, the real load addrs of each segment is not p_vaddr. Instead the
94 loader decides where to load the first segment, then will load all others
95 relative to the first one to respect the initial range layout.
96
97 For example, consider the following list:
98
99 [ offset:0, filesz:0x4000, memsz:0x4000, vaddr:0x30000 ],
100 [ offset:0x4000, filesz:0x2000, memsz:0x8000, vaddr:0x40000 ],
101
102 This corresponds to two segments that cover these virtual address ranges:
103
104 0x30000...0x34000
105 0x40000...0x48000
106
107 If the loader decides to load the first segment at address 0xa0000000
108 then the segments' load address ranges will be:
109
110 0xa0030000...0xa0034000
111 0xa0040000...0xa0048000
112
113 In other words, all segments must be loaded at an address that has the same
114 constant offset from their p_vaddr value. This offset is computed as the
115 difference between the first segment's load address, and its p_vaddr value.
116
117 However, in practice, segments do _not_ start at page boundaries. Since we
118 can only memory-map at page boundaries, this means that the bias is
119 computed as:
120
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700121 load_bias = phdr0_load_address - page_start(phdr0->p_vaddr)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200122
123 (NOTE: The value must be used as a 32-bit unsigned integer, to deal with
124 possible wrap around UINT32_MAX for possible large p_vaddr values).
125
126 And that the phdr0_load_address must start at a page boundary, with
127 the segment's real content starting at:
128
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700129 phdr0_load_address + page_offset(phdr0->p_vaddr)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200130
131 Note that ELF requires the following condition to make the mmap()-ing work:
132
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700133 page_offset(phdr0->p_vaddr) == page_offset(phdr0->p_offset)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200134
135 The load_bias must be added to any p_vaddr value read from the ELF file to
136 determine the corresponding memory address.
137
138 **/
139
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800140#define MAYBE_MAP_FLAG(x, from, to) (((x) & (from)) ? (to) : 0)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200141#define PFLAGS_TO_PROT(x) (MAYBE_MAP_FLAG((x), PF_X, PROT_EXEC) | \
142 MAYBE_MAP_FLAG((x), PF_R, PROT_READ) | \
143 MAYBE_MAP_FLAG((x), PF_W, PROT_WRITE))
144
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700145// Default PMD size for x86_64 and aarch64 (2MB).
146static constexpr size_t kPmdSize = (1UL << 21);
147
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700148ElfReader::ElfReader()
149 : did_read_(false), did_load_(false), fd_(-1), file_offset_(0), file_size_(0), phdr_num_(0),
150 phdr_table_(nullptr), shdr_table_(nullptr), shdr_num_(0), dynamic_(nullptr), strtab_(nullptr),
Dimitry Ivanovf45b0e92016-01-15 11:13:35 -0800151 strtab_size_(0), load_start_(nullptr), load_size_(0), load_bias_(0), loaded_phdr_(nullptr),
152 mapped_by_caller_(false) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700153}
154
155bool ElfReader::Read(const char* name, int fd, off64_t file_offset, off64_t file_size) {
Jiyong Park02586a22017-05-20 01:01:24 +0900156 if (did_read_) {
157 return true;
158 }
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700159 name_ = name;
160 fd_ = fd;
161 file_offset_ = file_offset;
162 file_size_ = file_size;
163
164 if (ReadElfHeader() &&
165 VerifyElfHeader() &&
166 ReadProgramHeaders() &&
167 ReadSectionHeaders() &&
168 ReadDynamicSection()) {
169 did_read_ = true;
170 }
171
172 return did_read_;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200173}
174
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400175bool ElfReader::Load(address_space_params* address_space) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700176 CHECK(did_read_);
Jiyong Park02586a22017-05-20 01:01:24 +0900177 if (did_load_) {
178 return true;
179 }
huangchaochaobdc37962022-12-27 19:38:41 +0800180 bool reserveSuccess = ReserveAddressSpace(address_space);
181 if (reserveSuccess && LoadSegments() && FindPhdr() &&
Tamas Petz8d55d182020-02-24 14:15:25 +0100182 FindGnuPropertySection()) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700183 did_load_ = true;
Tamas Petz8d55d182020-02-24 14:15:25 +0100184#if defined(__aarch64__)
185 // For Armv8.5-A loaded executable segments may require PROT_BTI.
186 if (note_gnu_property_.IsBTICompatible()) {
187 did_load_ = (phdr_table_protect_segments(phdr_table_, phdr_num_, load_bias_,
188 &note_gnu_property_) == 0);
189 }
190#endif
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700191 }
huangchaochaobdc37962022-12-27 19:38:41 +0800192 if (reserveSuccess && !did_load_) {
193 if (load_start_ != nullptr && load_size_ != 0) {
194 if (!mapped_by_caller_) {
195 munmap(load_start_, load_size_);
196 }
197 }
198 }
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700199
200 return did_load_;
201}
202
203const char* ElfReader::get_string(ElfW(Word) index) const {
204 CHECK(strtab_ != nullptr);
205 CHECK(index < strtab_size_);
206
207 return strtab_ + index;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800208}
209
210bool ElfReader::ReadElfHeader() {
Dmitriy Ivanova6c12792014-10-21 12:09:18 -0700211 ssize_t rc = TEMP_FAILURE_RETRY(pread64(fd_, &header_, sizeof(header_), file_offset_));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800212 if (rc < 0) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700213 DL_ERR("can't read file \"%s\": %s", name_.c_str(), strerror(errno));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800214 return false;
215 }
Dmitriy Ivanova6c12792014-10-21 12:09:18 -0700216
Elliott Hughes650be4e2013-03-05 18:47:58 -0800217 if (rc != sizeof(header_)) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700218 DL_ERR("\"%s\" is too small to be an ELF executable: only found %zd bytes", name_.c_str(),
Elliott Hughesc6200592013-09-30 18:43:46 -0700219 static_cast<size_t>(rc));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800220 return false;
221 }
222 return true;
223}
224
Elliott Hughes72007ee2017-04-19 17:44:57 -0700225static const char* EM_to_string(int em) {
226 if (em == EM_386) return "EM_386";
227 if (em == EM_AARCH64) return "EM_AARCH64";
228 if (em == EM_ARM) return "EM_ARM";
Ulya Trafimovichb973c752022-11-15 14:39:44 +0000229 if (em == EM_RISCV) return "EM_RISCV";
Elliott Hughes72007ee2017-04-19 17:44:57 -0700230 if (em == EM_X86_64) return "EM_X86_64";
231 return "EM_???";
232}
233
Elliott Hughes650be4e2013-03-05 18:47:58 -0800234bool ElfReader::VerifyElfHeader() {
Elliott Hughes625993d2014-07-15 16:53:13 -0700235 if (memcmp(header_.e_ident, ELFMAG, SELFMAG) != 0) {
Elliott Hughesa8971512018-06-27 14:39:06 -0700236 DL_ERR("\"%s\" has bad ELF magic: %02x%02x%02x%02x", name_.c_str(),
237 header_.e_ident[0], header_.e_ident[1], header_.e_ident[2], header_.e_ident[3]);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800238 return false;
239 }
240
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700241 // Try to give a clear diagnostic for ELF class mismatches, since they're
242 // an easy mistake to make during the 32-bit/64-bit transition period.
243 int elf_class = header_.e_ident[EI_CLASS];
244#if defined(__LP64__)
245 if (elf_class != ELFCLASS64) {
246 if (elf_class == ELFCLASS32) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700247 DL_ERR("\"%s\" is 32-bit instead of 64-bit", name_.c_str());
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700248 } else {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700249 DL_ERR("\"%s\" has unknown ELF class: %d", name_.c_str(), elf_class);
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700250 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800251 return false;
252 }
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700253#else
254 if (elf_class != ELFCLASS32) {
255 if (elf_class == ELFCLASS64) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700256 DL_ERR("\"%s\" is 64-bit instead of 32-bit", name_.c_str());
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700257 } else {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700258 DL_ERR("\"%s\" has unknown ELF class: %d", name_.c_str(), elf_class);
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700259 }
260 return false;
261 }
262#endif
263
Elliott Hughes650be4e2013-03-05 18:47:58 -0800264 if (header_.e_ident[EI_DATA] != ELFDATA2LSB) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700265 DL_ERR("\"%s\" not little-endian: %d", name_.c_str(), header_.e_ident[EI_DATA]);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800266 return false;
267 }
268
269 if (header_.e_type != ET_DYN) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700270 DL_ERR("\"%s\" has unexpected e_type: %d", name_.c_str(), header_.e_type);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800271 return false;
272 }
273
274 if (header_.e_version != EV_CURRENT) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700275 DL_ERR("\"%s\" has unexpected e_version: %d", name_.c_str(), header_.e_version);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800276 return false;
277 }
278
Elliott Hughesb5140262014-12-02 16:16:29 -0800279 if (header_.e_machine != GetTargetElfMachine()) {
Elliott Hughesd16cfac2018-09-17 15:50:09 -0700280 DL_ERR("\"%s\" is for %s (%d) instead of %s (%d)",
281 name_.c_str(),
282 EM_to_string(header_.e_machine), header_.e_machine,
283 EM_to_string(GetTargetElfMachine()), GetTargetElfMachine());
Elliott Hughes650be4e2013-03-05 18:47:58 -0800284 return false;
285 }
286
Dimitry Ivanovc73eec12016-07-22 12:50:59 -0700287 if (header_.e_shentsize != sizeof(ElfW(Shdr))) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800288 // Fail if app is targeting Android O or above
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800289 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800290 DL_ERR_AND_LOG("\"%s\" has unsupported e_shentsize: 0x%x (expected 0x%zx)",
291 name_.c_str(), header_.e_shentsize, sizeof(ElfW(Shdr)));
292 return false;
293 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800294 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800295 "invalid-elf-header_section-headers-enforced-for-api-level-26",
296 "\"%s\" has unsupported e_shentsize 0x%x (expected 0x%zx)",
297 name_.c_str(), header_.e_shentsize, sizeof(ElfW(Shdr)));
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800298 add_dlwarning(name_.c_str(), "has invalid ELF header");
Dimitry Ivanovc73eec12016-07-22 12:50:59 -0700299 }
300
301 if (header_.e_shstrndx == 0) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800302 // Fail if app is targeting Android O or above
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800303 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800304 DL_ERR_AND_LOG("\"%s\" has invalid e_shstrndx", name_.c_str());
305 return false;
306 }
307
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800308 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800309 "invalid-elf-header_section-headers-enforced-for-api-level-26",
310 "\"%s\" has invalid e_shstrndx", name_.c_str());
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800311 add_dlwarning(name_.c_str(), "has invalid ELF header");
Dimitry Ivanovc73eec12016-07-22 12:50:59 -0700312 }
313
Elliott Hughes650be4e2013-03-05 18:47:58 -0800314 return true;
315}
316
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700317bool ElfReader::CheckFileRange(ElfW(Addr) offset, size_t size, size_t alignment) {
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800318 off64_t range_start;
319 off64_t range_end;
320
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700321 // Only header can be located at the 0 offset... This function called to
322 // check DYNSYM and DYNAMIC sections and phdr/shdr - none of them can be
Dimitry Ivanovebe5af72016-07-14 11:15:44 -0700323 // at offset 0.
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700324
325 return offset > 0 &&
326 safe_add(&range_start, file_offset_, offset) &&
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800327 safe_add(&range_end, range_start, size) &&
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700328 (range_start < file_size_) &&
329 (range_end <= file_size_) &&
330 ((offset % alignment) == 0);
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800331}
332
Elliott Hughes650be4e2013-03-05 18:47:58 -0800333// Loads the program header table from an ELF file into a read-only private
334// anonymous mmap-ed block.
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700335bool ElfReader::ReadProgramHeaders() {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800336 phdr_num_ = header_.e_phnum;
337
338 // Like the kernel, we only accept program header tables that
339 // are smaller than 64KiB.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800340 if (phdr_num_ < 1 || phdr_num_ > 65536/sizeof(ElfW(Phdr))) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700341 DL_ERR("\"%s\" has invalid e_phnum: %zd", name_.c_str(), phdr_num_);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800342 return false;
343 }
344
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800345 // Boundary checks
346 size_t size = phdr_num_ * sizeof(ElfW(Phdr));
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700347 if (!CheckFileRange(header_.e_phoff, size, alignof(ElfW(Phdr)))) {
348 DL_ERR_AND_LOG("\"%s\" has invalid phdr offset/size: %zu/%zu",
349 name_.c_str(),
350 static_cast<size_t>(header_.e_phoff),
351 size);
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800352 return false;
353 }
354
355 if (!phdr_fragment_.Map(fd_, file_offset_, header_.e_phoff, size)) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700356 DL_ERR("\"%s\" phdr mmap failed: %s", name_.c_str(), strerror(errno));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800357 return false;
358 }
359
Dmitriy Ivanovcf1cbbe2015-10-19 16:57:46 -0700360 phdr_table_ = static_cast<ElfW(Phdr)*>(phdr_fragment_.data());
Elliott Hughes650be4e2013-03-05 18:47:58 -0800361 return true;
362}
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200363
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700364bool ElfReader::ReadSectionHeaders() {
365 shdr_num_ = header_.e_shnum;
366
Dmitriy Ivanovb76123f2015-11-20 10:42:02 -0800367 if (shdr_num_ == 0) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700368 DL_ERR_AND_LOG("\"%s\" has no section headers", name_.c_str());
Dmitriy Ivanovb76123f2015-11-20 10:42:02 -0800369 return false;
370 }
371
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800372 size_t size = shdr_num_ * sizeof(ElfW(Shdr));
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700373 if (!CheckFileRange(header_.e_shoff, size, alignof(const ElfW(Shdr)))) {
374 DL_ERR_AND_LOG("\"%s\" has invalid shdr offset/size: %zu/%zu",
375 name_.c_str(),
376 static_cast<size_t>(header_.e_shoff),
377 size);
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800378 return false;
379 }
380
381 if (!shdr_fragment_.Map(fd_, file_offset_, header_.e_shoff, size)) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700382 DL_ERR("\"%s\" shdr mmap failed: %s", name_.c_str(), strerror(errno));
383 return false;
384 }
385
386 shdr_table_ = static_cast<const ElfW(Shdr)*>(shdr_fragment_.data());
387 return true;
388}
389
390bool ElfReader::ReadDynamicSection() {
391 // 1. Find .dynamic section (in section headers)
392 const ElfW(Shdr)* dynamic_shdr = nullptr;
393 for (size_t i = 0; i < shdr_num_; ++i) {
394 if (shdr_table_[i].sh_type == SHT_DYNAMIC) {
395 dynamic_shdr = &shdr_table_ [i];
396 break;
397 }
398 }
399
400 if (dynamic_shdr == nullptr) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700401 DL_ERR_AND_LOG("\"%s\" .dynamic section header was not found", name_.c_str());
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700402 return false;
403 }
404
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700405 // Make sure dynamic_shdr offset and size matches PT_DYNAMIC phdr
406 size_t pt_dynamic_offset = 0;
407 size_t pt_dynamic_filesz = 0;
408 for (size_t i = 0; i < phdr_num_; ++i) {
409 const ElfW(Phdr)* phdr = &phdr_table_[i];
410 if (phdr->p_type == PT_DYNAMIC) {
411 pt_dynamic_offset = phdr->p_offset;
412 pt_dynamic_filesz = phdr->p_filesz;
413 }
414 }
415
416 if (pt_dynamic_offset != dynamic_shdr->sh_offset) {
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800417 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800418 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid offset: 0x%zx, "
419 "expected to match PT_DYNAMIC offset: 0x%zx",
420 name_.c_str(),
421 static_cast<size_t>(dynamic_shdr->sh_offset),
422 pt_dynamic_offset);
423 return false;
424 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800425 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800426 "invalid-elf-header_section-headers-enforced-for-api-level-26",
427 "\"%s\" .dynamic section has invalid offset: 0x%zx "
428 "(expected to match PT_DYNAMIC offset 0x%zx)",
429 name_.c_str(),
430 static_cast<size_t>(dynamic_shdr->sh_offset),
431 pt_dynamic_offset);
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800432 add_dlwarning(name_.c_str(), "invalid .dynamic section");
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700433 }
434
435 if (pt_dynamic_filesz != dynamic_shdr->sh_size) {
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800436 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800437 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid size: 0x%zx, "
438 "expected to match PT_DYNAMIC filesz: 0x%zx",
439 name_.c_str(),
440 static_cast<size_t>(dynamic_shdr->sh_size),
441 pt_dynamic_filesz);
442 return false;
443 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800444 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800445 "invalid-elf-header_section-headers-enforced-for-api-level-26",
446 "\"%s\" .dynamic section has invalid size: 0x%zx "
447 "(expected to match PT_DYNAMIC filesz 0x%zx)",
448 name_.c_str(),
449 static_cast<size_t>(dynamic_shdr->sh_size),
450 pt_dynamic_filesz);
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800451 add_dlwarning(name_.c_str(), "invalid .dynamic section");
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700452 }
453
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700454 if (dynamic_shdr->sh_link >= shdr_num_) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700455 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid sh_link: %d",
456 name_.c_str(),
457 dynamic_shdr->sh_link);
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700458 return false;
459 }
460
461 const ElfW(Shdr)* strtab_shdr = &shdr_table_[dynamic_shdr->sh_link];
462
463 if (strtab_shdr->sh_type != SHT_STRTAB) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700464 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid link(%d) sh_type: %d (expected SHT_STRTAB)",
465 name_.c_str(), dynamic_shdr->sh_link, strtab_shdr->sh_type);
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700466 return false;
467 }
468
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700469 if (!CheckFileRange(dynamic_shdr->sh_offset, dynamic_shdr->sh_size, alignof(const ElfW(Dyn)))) {
470 DL_ERR_AND_LOG("\"%s\" has invalid offset/size of .dynamic section", name_.c_str());
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800471 return false;
472 }
473
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700474 if (!dynamic_fragment_.Map(fd_, file_offset_, dynamic_shdr->sh_offset, dynamic_shdr->sh_size)) {
475 DL_ERR("\"%s\" dynamic section mmap failed: %s", name_.c_str(), strerror(errno));
476 return false;
477 }
478
479 dynamic_ = static_cast<const ElfW(Dyn)*>(dynamic_fragment_.data());
480
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700481 if (!CheckFileRange(strtab_shdr->sh_offset, strtab_shdr->sh_size, alignof(const char))) {
482 DL_ERR_AND_LOG("\"%s\" has invalid offset/size of the .strtab section linked from .dynamic section",
483 name_.c_str());
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800484 return false;
485 }
486
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700487 if (!strtab_fragment_.Map(fd_, file_offset_, strtab_shdr->sh_offset, strtab_shdr->sh_size)) {
488 DL_ERR("\"%s\" strtab section mmap failed: %s", name_.c_str(), strerror(errno));
489 return false;
490 }
491
492 strtab_ = static_cast<const char*>(strtab_fragment_.data());
493 strtab_size_ = strtab_fragment_.size();
494 return true;
495}
496
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800497/* Returns the size of the extent of all the possibly non-contiguous
498 * loadable segments in an ELF program header table. This corresponds
499 * to the page-aligned size in bytes that needs to be reserved in the
500 * process' address space. If there are no loadable segments, 0 is
501 * returned.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200502 *
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700503 * If out_min_vaddr or out_max_vaddr are not null, they will be
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800504 * set to the minimum and maximum addresses of pages to be reserved,
505 * or 0 if there is nothing to load.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200506 */
Elliott Hughes0266ae52014-02-10 17:46:57 -0800507size_t phdr_table_get_load_size(const ElfW(Phdr)* phdr_table, size_t phdr_count,
508 ElfW(Addr)* out_min_vaddr,
509 ElfW(Addr)* out_max_vaddr) {
510 ElfW(Addr) min_vaddr = UINTPTR_MAX;
511 ElfW(Addr) max_vaddr = 0;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200512
Elliott Hughes0266ae52014-02-10 17:46:57 -0800513 bool found_pt_load = false;
514 for (size_t i = 0; i < phdr_count; ++i) {
515 const ElfW(Phdr)* phdr = &phdr_table[i];
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200516
Elliott Hughes0266ae52014-02-10 17:46:57 -0800517 if (phdr->p_type != PT_LOAD) {
518 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200519 }
Elliott Hughes0266ae52014-02-10 17:46:57 -0800520 found_pt_load = true;
521
522 if (phdr->p_vaddr < min_vaddr) {
523 min_vaddr = phdr->p_vaddr;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200524 }
525
Elliott Hughes0266ae52014-02-10 17:46:57 -0800526 if (phdr->p_vaddr + phdr->p_memsz > max_vaddr) {
527 max_vaddr = phdr->p_vaddr + phdr->p_memsz;
528 }
529 }
530 if (!found_pt_load) {
531 min_vaddr = 0;
532 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200533
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700534 min_vaddr = page_start(min_vaddr);
535 max_vaddr = page_end(max_vaddr);
Elliott Hughes0266ae52014-02-10 17:46:57 -0800536
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700537 if (out_min_vaddr != nullptr) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800538 *out_min_vaddr = min_vaddr;
539 }
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700540 if (out_max_vaddr != nullptr) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800541 *out_max_vaddr = max_vaddr;
542 }
543 return max_vaddr - min_vaddr;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200544}
545
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700546// Returns the maximum p_align associated with a loadable segment in the ELF
547// program header table. Used to determine whether the file should be loaded at
548// a specific virtual address alignment for use with huge pages.
549size_t phdr_table_get_maximum_alignment(const ElfW(Phdr)* phdr_table, size_t phdr_count) {
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700550 size_t maximum_alignment = page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700551
552 for (size_t i = 0; i < phdr_count; ++i) {
553 const ElfW(Phdr)* phdr = &phdr_table[i];
554
555 // p_align must be 0, 1, or a positive, integral power of two.
556 if (phdr->p_type != PT_LOAD || ((phdr->p_align & (phdr->p_align - 1)) != 0)) {
557 continue;
558 }
559
560 if (phdr->p_align > maximum_alignment) {
561 maximum_alignment = phdr->p_align;
562 }
563 }
564
565#if defined(__LP64__)
566 return maximum_alignment;
567#else
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700568 return page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700569#endif
570}
571
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700572// Reserve a virtual address range such that if it's limits were extended to the next 2**align
573// boundary, it would not overlap with any existing mappings.
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700574static void* ReserveWithAlignmentPadding(size_t size, size_t mapping_align, size_t start_align,
575 void** out_gap_start, size_t* out_gap_size) {
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700576 int mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS;
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700577 // Reserve enough space to properly align the library's start address.
578 mapping_align = std::max(mapping_align, start_align);
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700579 if (mapping_align == page_size()) {
Elliott Hughes8178c412018-11-05 13:34:36 -0800580 void* mmap_ptr = mmap(nullptr, size, PROT_NONE, mmap_flags, -1, 0);
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700581 if (mmap_ptr == MAP_FAILED) {
582 return nullptr;
583 }
584 return mmap_ptr;
585 }
586
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700587 // Minimum alignment of shared library gap. For efficiency, this should match the second level
588 // page size of the platform.
589#if defined(__LP64__)
590 constexpr size_t kGapAlignment = 1ul << 21; // 2MB
591#else
592 constexpr size_t kGapAlignment = 0;
593#endif
594 // Maximum gap size, in the units of kGapAlignment.
595 constexpr size_t kMaxGapUnits = 32;
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700596 // Allocate enough space so that the end of the desired region aligned up is still inside the
597 // mapping.
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700598 size_t mmap_size = align_up(size, mapping_align) + mapping_align - page_size();
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700599 uint8_t* mmap_ptr =
600 reinterpret_cast<uint8_t*>(mmap(nullptr, mmap_size, PROT_NONE, mmap_flags, -1, 0));
601 if (mmap_ptr == MAP_FAILED) {
602 return nullptr;
603 }
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700604 size_t gap_size = 0;
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700605 size_t first_byte = reinterpret_cast<size_t>(align_up(mmap_ptr, mapping_align));
606 size_t last_byte = reinterpret_cast<size_t>(align_down(mmap_ptr + mmap_size, mapping_align) - 1);
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700607 if (kGapAlignment && first_byte / kGapAlignment != last_byte / kGapAlignment) {
608 // This library crosses a 2MB boundary and will fragment a new huge page.
609 // Lets take advantage of that and insert a random number of inaccessible huge pages before that
610 // to improve address randomization and make it harder to locate this library code by probing.
611 munmap(mmap_ptr, mmap_size);
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700612 mapping_align = std::max(mapping_align, kGapAlignment);
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700613 gap_size =
614 kGapAlignment * (is_first_stage_init() ? 1 : arc4random_uniform(kMaxGapUnits - 1) + 1);
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700615 mmap_size = align_up(size + gap_size, mapping_align) + mapping_align - page_size();
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700616 mmap_ptr = reinterpret_cast<uint8_t*>(mmap(nullptr, mmap_size, PROT_NONE, mmap_flags, -1, 0));
617 if (mmap_ptr == MAP_FAILED) {
618 return nullptr;
619 }
620 }
621
622 uint8_t *gap_end, *gap_start;
623 if (gap_size) {
624 gap_end = align_down(mmap_ptr + mmap_size, kGapAlignment);
625 gap_start = gap_end - gap_size;
626 } else {
627 gap_start = gap_end = mmap_ptr + mmap_size;
628 }
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700629
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700630 uint8_t* first = align_up(mmap_ptr, mapping_align);
631 uint8_t* last = align_down(gap_start, mapping_align) - size;
Jiyong Park31cd08f2018-06-01 19:18:56 +0900632
Tom Cherry66bc4282018-11-08 13:40:52 -0800633 // arc4random* is not available in first stage init because /dev/urandom hasn't yet been
Jiyong Park31cd08f2018-06-01 19:18:56 +0900634 // created. Don't randomize then.
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700635 size_t n = is_first_stage_init() ? 0 : arc4random_uniform((last - first) / start_align + 1);
636 uint8_t* start = first + n * start_align;
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700637 // Unmap the extra space around the allocation.
638 // Keep it mapped PROT_NONE on 64-bit targets where address space is plentiful to make it harder
639 // to defeat ASLR by probing for readable memory mappings.
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700640 munmap(mmap_ptr, start - mmap_ptr);
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700641 munmap(start + size, gap_start - (start + size));
642 if (gap_end != mmap_ptr + mmap_size) {
643 munmap(gap_end, mmap_ptr + mmap_size - gap_end);
644 }
645 *out_gap_start = gap_start;
646 *out_gap_size = gap_size;
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700647 return start;
648}
649
Elliott Hughes650be4e2013-03-05 18:47:58 -0800650// Reserve a virtual address range big enough to hold all loadable
651// segments of a program header table. This is done by creating a
652// private anonymous mmap() with PROT_NONE.
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400653bool ElfReader::ReserveAddressSpace(address_space_params* address_space) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800654 ElfW(Addr) min_vaddr;
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800655 load_size_ = phdr_table_get_load_size(phdr_table_, phdr_num_, &min_vaddr);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800656 if (load_size_ == 0) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700657 DL_ERR("\"%s\" has no loadable segments", name_.c_str());
Elliott Hughes650be4e2013-03-05 18:47:58 -0800658 return false;
659 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200660
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800661 uint8_t* addr = reinterpret_cast<uint8_t*>(min_vaddr);
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000662 void* start;
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000663
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400664 if (load_size_ > address_space->reserved_size) {
665 if (address_space->must_use_address) {
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000666 DL_ERR("reserved address space %zd smaller than %zd bytes needed for \"%s\"",
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400667 load_size_ - address_space->reserved_size, load_size_, name_.c_str());
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000668 return false;
669 }
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700670 size_t start_alignment = page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700671 if (get_transparent_hugepages_supported() && get_application_target_sdk_version() >= 31) {
672 size_t maximum_alignment = phdr_table_get_maximum_alignment(phdr_table_, phdr_num_);
673 // Limit alignment to PMD size as other alignments reduce the number of
674 // bits available for ASLR for no benefit.
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700675 start_alignment = maximum_alignment == kPmdSize ? kPmdSize : page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700676 }
677 start = ReserveWithAlignmentPadding(load_size_, kLibraryAlignment, start_alignment, &gap_start_,
678 &gap_size_);
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700679 if (start == nullptr) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700680 DL_ERR("couldn't reserve %zd bytes of address space for \"%s\"", load_size_, name_.c_str());
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000681 return false;
682 }
683 } else {
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400684 start = address_space->start_addr;
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700685 gap_start_ = nullptr;
686 gap_size_ = 0;
Dimitry Ivanovf45b0e92016-01-15 11:13:35 -0800687 mapped_by_caller_ = true;
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400688
689 // Update the reserved address space to subtract the space used by this library.
690 address_space->start_addr = reinterpret_cast<uint8_t*>(address_space->start_addr) + load_size_;
691 address_space->reserved_size -= load_size_;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800692 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200693
Elliott Hughes650be4e2013-03-05 18:47:58 -0800694 load_start_ = start;
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800695 load_bias_ = reinterpret_cast<uint8_t*>(start) - addr;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800696 return true;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200697}
698
Elliott Hughes650be4e2013-03-05 18:47:58 -0800699bool ElfReader::LoadSegments() {
700 for (size_t i = 0; i < phdr_num_; ++i) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800701 const ElfW(Phdr)* phdr = &phdr_table_[i];
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200702
Elliott Hughes650be4e2013-03-05 18:47:58 -0800703 if (phdr->p_type != PT_LOAD) {
704 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200705 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800706
707 // Segment addresses in memory.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800708 ElfW(Addr) seg_start = phdr->p_vaddr + load_bias_;
709 ElfW(Addr) seg_end = seg_start + phdr->p_memsz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800710
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700711 ElfW(Addr) seg_page_start = page_start(seg_start);
712 ElfW(Addr) seg_page_end = page_end(seg_end);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800713
Elliott Hughes0266ae52014-02-10 17:46:57 -0800714 ElfW(Addr) seg_file_end = seg_start + phdr->p_filesz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800715
716 // File offsets.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800717 ElfW(Addr) file_start = phdr->p_offset;
718 ElfW(Addr) file_end = file_start + phdr->p_filesz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800719
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700720 ElfW(Addr) file_page_start = page_start(file_start);
Elliott Hughes0266ae52014-02-10 17:46:57 -0800721 ElfW(Addr) file_length = file_end - file_page_start;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800722
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700723 if (file_size_ <= 0) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700724 DL_ERR("\"%s\" invalid file size: %" PRId64, name_.c_str(), file_size_);
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700725 return false;
726 }
727
skvalex93ce3542015-08-20 01:06:42 +0300728 if (file_end > static_cast<size_t>(file_size_)) {
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700729 DL_ERR("invalid ELF file \"%s\" load segment[%zd]:"
730 " p_offset (%p) + p_filesz (%p) ( = %p) past end of file (0x%" PRIx64 ")",
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700731 name_.c_str(), i, reinterpret_cast<void*>(phdr->p_offset),
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700732 reinterpret_cast<void*>(phdr->p_filesz),
733 reinterpret_cast<void*>(file_end), file_size_);
734 return false;
735 }
736
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700737 if (file_length != 0) {
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700738 int prot = PFLAGS_TO_PROT(phdr->p_flags);
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700739 if ((prot & (PROT_EXEC | PROT_WRITE)) == (PROT_EXEC | PROT_WRITE)) {
Elliott Hughes4cc5a602016-11-15 16:54:16 -0800740 // W + E PT_LOAD segments are not allowed in O.
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800741 if (get_application_target_sdk_version() >= 26) {
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800742 DL_ERR_AND_LOG("\"%s\": W+E load segments are not allowed", name_.c_str());
Elliott Hughes4cc5a602016-11-15 16:54:16 -0800743 return false;
744 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800745 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800746 "writable-and-executable-segments-enforced-for-api-level-26",
747 "\"%s\" has load segments that are both writable and executable",
748 name_.c_str());
Elliott Hughes4cc5a602016-11-15 16:54:16 -0800749 add_dlwarning(name_.c_str(), "W+E load segments");
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700750 }
751
Dmitriy Ivanov07e5bc12014-10-03 17:52:44 -0700752 void* seg_addr = mmap64(reinterpret_cast<void*>(seg_page_start),
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700753 file_length,
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700754 prot,
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700755 MAP_FIXED|MAP_PRIVATE,
756 fd_,
Dmitriy Ivanov07e5bc12014-10-03 17:52:44 -0700757 file_offset_ + file_page_start);
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700758 if (seg_addr == MAP_FAILED) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700759 DL_ERR("couldn't map \"%s\" segment %zd: %s", name_.c_str(), i, strerror(errno));
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700760 return false;
761 }
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700762
763 // Mark segments as huge page eligible if they meet the requirements
764 // (executable and PMD aligned).
765 if ((phdr->p_flags & PF_X) && phdr->p_align == kPmdSize &&
766 get_transparent_hugepages_supported()) {
767 madvise(seg_addr, file_length, MADV_HUGEPAGE);
768 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800769 }
770
771 // if the segment is writable, and does not end on a page boundary,
772 // zero-fill it until the page limit.
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700773 if ((phdr->p_flags & PF_W) != 0 && page_offset(seg_file_end) > 0) {
774 memset(reinterpret_cast<void*>(seg_file_end), 0, page_size() - page_offset(seg_file_end));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800775 }
776
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700777 seg_file_end = page_end(seg_file_end);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800778
779 // seg_file_end is now the first page address after the file
780 // content. If seg_end is larger, we need to zero anything
781 // between them. This is done by using a private anonymous
782 // map for all extra pages.
783 if (seg_page_end > seg_file_end) {
Dimitry Ivanov1b84afc2016-01-27 18:12:03 -0800784 size_t zeromap_size = seg_page_end - seg_file_end;
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800785 void* zeromap = mmap(reinterpret_cast<void*>(seg_file_end),
Dimitry Ivanov1b84afc2016-01-27 18:12:03 -0800786 zeromap_size,
Elliott Hughes650be4e2013-03-05 18:47:58 -0800787 PFLAGS_TO_PROT(phdr->p_flags),
788 MAP_FIXED|MAP_ANONYMOUS|MAP_PRIVATE,
789 -1,
790 0);
791 if (zeromap == MAP_FAILED) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700792 DL_ERR("couldn't zero fill \"%s\" gap: %s", name_.c_str(), strerror(errno));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800793 return false;
794 }
Dimitry Ivanov1b84afc2016-01-27 18:12:03 -0800795
796 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, zeromap, zeromap_size, ".bss");
Elliott Hughes650be4e2013-03-05 18:47:58 -0800797 }
798 }
799 return true;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200800}
801
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000802/* Used internally. Used to set the protection bits of all loaded segments
803 * with optional extra flags (i.e. really PROT_WRITE). Used by
804 * phdr_table_protect_segments and phdr_table_unprotect_segments.
805 */
806static int _phdr_table_set_load_prot(const ElfW(Phdr)* phdr_table, size_t phdr_count,
807 ElfW(Addr) load_bias, int extra_prot_flags) {
808 const ElfW(Phdr)* phdr = phdr_table;
809 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
810
811 for (; phdr < phdr_limit; phdr++) {
812 if (phdr->p_type != PT_LOAD || (phdr->p_flags & PF_W) != 0) {
813 continue;
814 }
815
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700816 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr) + load_bias;
817 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000818
Tamas Petz8d55d182020-02-24 14:15:25 +0100819 int prot = PFLAGS_TO_PROT(phdr->p_flags) | extra_prot_flags;
820 if ((prot & PROT_WRITE) != 0) {
Nick Kralevich8fdb3412015-04-01 16:57:50 -0700821 // make sure we're never simultaneously writable / executable
822 prot &= ~PROT_EXEC;
823 }
Tamas Petz8d55d182020-02-24 14:15:25 +0100824#if defined(__aarch64__)
825 if ((prot & PROT_EXEC) == 0) {
826 // Though it is not specified don't add PROT_BTI if segment is not
827 // executable.
828 prot &= ~PROT_BTI;
829 }
830#endif
Nick Kralevich8fdb3412015-04-01 16:57:50 -0700831
Tamas Petz8d55d182020-02-24 14:15:25 +0100832 int ret =
833 mprotect(reinterpret_cast<void*>(seg_page_start), seg_page_end - seg_page_start, prot);
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000834 if (ret < 0) {
835 return -1;
836 }
837 }
838 return 0;
839}
840
841/* Restore the original protection modes for all loadable segments.
842 * You should only call this after phdr_table_unprotect_segments and
843 * applying all relocations.
844 *
Tamas Petz8d55d182020-02-24 14:15:25 +0100845 * AArch64: also called from linker_main and ElfReader::Load to apply
846 * PROT_BTI for loaded main so and other so-s.
847 *
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000848 * Input:
849 * phdr_table -> program header table
850 * phdr_count -> number of entries in tables
851 * load_bias -> load bias
Tamas Petz8d55d182020-02-24 14:15:25 +0100852 * prop -> GnuPropertySection or nullptr
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000853 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +0000854 * 0 on success, -1 on failure (error code in errno).
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000855 */
Tamas Petz8d55d182020-02-24 14:15:25 +0100856int phdr_table_protect_segments(const ElfW(Phdr)* phdr_table, size_t phdr_count,
857 ElfW(Addr) load_bias, const GnuPropertySection* prop __unused) {
858 int prot = 0;
859#if defined(__aarch64__)
860 if ((prop != nullptr) && prop->IsBTICompatible()) {
861 prot |= PROT_BTI;
862 }
863#endif
864 return _phdr_table_set_load_prot(phdr_table, phdr_count, load_bias, prot);
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000865}
866
Mitch Phillipse8139f52022-11-23 15:18:01 -0800867static bool segment_needs_memtag_globals_remapping(const ElfW(Phdr) * phdr) {
868 // For now, MTE globals is only supported on writeable data segments.
869 return phdr->p_type == PT_LOAD && !(phdr->p_flags & PF_X) && (phdr->p_flags & PF_W);
870}
871
872/* When MTE globals are requested by the binary, and when the hardware supports
873 * it, remap the executable's PT_LOAD data pages to have PROT_MTE.
874 *
875 * Input:
876 * phdr_table -> program header table
877 * phdr_count -> number of entries in tables
878 * load_bias -> load bias
879 * Return:
880 * 0 on success, -1 on failure (error code in errno).
881 */
882int remap_memtag_globals_segments(const ElfW(Phdr) * phdr_table, size_t phdr_count,
883 ElfW(Addr) load_bias) {
884 for (const ElfW(Phdr)* phdr = phdr_table; phdr < phdr_table + phdr_count; phdr++) {
885 if (!segment_needs_memtag_globals_remapping(phdr)) {
886 continue;
887 }
888
889 uintptr_t seg_page_start = page_start(phdr->p_vaddr) + load_bias;
890 uintptr_t seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
891 size_t seg_page_aligned_size = seg_page_end - seg_page_start;
892
893 int prot = PFLAGS_TO_PROT(phdr->p_flags);
894 // For anonymous private mappings, it may be possible to simply mprotect()
895 // the PROT_MTE flag over the top. For file-based mappings, this will fail,
896 // and we'll need to fall back. We also allow PROT_WRITE here to allow
897 // writing memory tags (in `soinfo::tag_globals()`), and set these sections
898 // back to read-only after tags are applied (similar to RELRO).
899#if defined(__aarch64__)
900 prot |= PROT_MTE;
901#endif // defined(__aarch64__)
902 if (mprotect(reinterpret_cast<void*>(seg_page_start), seg_page_aligned_size,
903 prot | PROT_WRITE) == 0) {
904 continue;
905 }
906
907 void* mapping_copy = mmap(nullptr, seg_page_aligned_size, PROT_READ | PROT_WRITE,
908 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
909 linker_memcpy(mapping_copy, reinterpret_cast<void*>(seg_page_start), seg_page_aligned_size);
910
911 void* seg_addr = mmap(reinterpret_cast<void*>(seg_page_start), seg_page_aligned_size,
912 prot | PROT_WRITE, MAP_FIXED | MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
913 if (seg_addr == MAP_FAILED) return -1;
914
915 linker_memcpy(seg_addr, mapping_copy, seg_page_aligned_size);
916 munmap(mapping_copy, seg_page_aligned_size);
917 }
918
919 return 0;
920}
921
922void protect_memtag_globals_ro_segments(const ElfW(Phdr) * phdr_table, size_t phdr_count,
923 ElfW(Addr) load_bias) {
924 for (const ElfW(Phdr)* phdr = phdr_table; phdr < phdr_table + phdr_count; phdr++) {
925 int prot = PFLAGS_TO_PROT(phdr->p_flags);
926 if (!segment_needs_memtag_globals_remapping(phdr) || (prot & PROT_WRITE)) {
927 continue;
928 }
929
930#if defined(__aarch64__)
931 prot |= PROT_MTE;
932#endif // defined(__aarch64__)
933
934 uintptr_t seg_page_start = page_start(phdr->p_vaddr) + load_bias;
935 uintptr_t seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
936 size_t seg_page_aligned_size = seg_page_end - seg_page_start;
937 mprotect(reinterpret_cast<void*>(seg_page_start), seg_page_aligned_size, prot);
938 }
939}
940
941void name_memtag_globals_segments(const ElfW(Phdr) * phdr_table, size_t phdr_count,
942 ElfW(Addr) load_bias, const char* soname) {
943 for (const ElfW(Phdr)* phdr = phdr_table; phdr < phdr_table + phdr_count; phdr++) {
944 if (!segment_needs_memtag_globals_remapping(phdr)) {
945 continue;
946 }
947
948 uintptr_t seg_page_start = page_start(phdr->p_vaddr) + load_bias;
949 uintptr_t seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
950 size_t seg_page_aligned_size = seg_page_end - seg_page_start;
951
952 // For file-based mappings that we're now forcing to be anonymous mappings, set the VMA name to
953 // make debugging easier. The previous Android-kernel specific implementation captured the name
954 // by pointer from userspace, which meant we had to persist the name permanently in memory.
955 // Since Android13-5.10 (https://android-review.git.corp.google.com/c/kernel/common/+/1934723)
956 // though, we use the upstream-kernel implementation
957 // (https://github.com/torvalds/linux/commit/9a10064f5625d5572c3626c1516e0bebc6c9fe9b), which
958 // copies the name into kernel memory. It's a safe bet that any devices with Android 14 are
959 // using a kernel >= 5.10.
960 constexpr unsigned kVmaNameLimit = 80;
961 char vma_name[kVmaNameLimit];
962 async_safe_format_buffer(vma_name, kVmaNameLimit, "memtag:%s+0x%" PRIxPTR, soname,
963 page_start(phdr->p_vaddr));
964 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, reinterpret_cast<void*>(seg_page_start),
965 seg_page_aligned_size, vma_name);
966 }
967}
968
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000969/* Change the protection of all loaded segments in memory to writable.
970 * This is useful before performing relocations. Once completed, you
971 * will have to call phdr_table_protect_segments to restore the original
972 * protection flags on all segments.
973 *
974 * Note that some writable segments can also have their content turned
975 * to read-only by calling phdr_table_protect_gnu_relro. This is no
976 * performed here.
977 *
978 * Input:
979 * phdr_table -> program header table
980 * phdr_count -> number of entries in tables
981 * load_bias -> load bias
982 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +0000983 * 0 on success, -1 on failure (error code in errno).
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000984 */
985int phdr_table_unprotect_segments(const ElfW(Phdr)* phdr_table,
986 size_t phdr_count, ElfW(Addr) load_bias) {
987 return _phdr_table_set_load_prot(phdr_table, phdr_count, load_bias, PROT_WRITE);
988}
989
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200990/* Used internally by phdr_table_protect_gnu_relro and
991 * phdr_table_unprotect_gnu_relro.
992 */
Elliott Hughes0266ae52014-02-10 17:46:57 -0800993static int _phdr_table_set_gnu_relro_prot(const ElfW(Phdr)* phdr_table, size_t phdr_count,
994 ElfW(Addr) load_bias, int prot_flags) {
995 const ElfW(Phdr)* phdr = phdr_table;
996 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200997
Elliott Hughes0266ae52014-02-10 17:46:57 -0800998 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
999 if (phdr->p_type != PT_GNU_RELRO) {
1000 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001001 }
Elliott Hughes0266ae52014-02-10 17:46:57 -08001002
1003 // Tricky: what happens when the relro segment does not start
1004 // or end at page boundaries? We're going to be over-protective
1005 // here and put every page touched by the segment as read-only.
1006
1007 // This seems to match Ian Lance Taylor's description of the
1008 // feature at http://www.airs.com/blog/archives/189.
1009
1010 // Extract:
1011 // Note that the current dynamic linker code will only work
1012 // correctly if the PT_GNU_RELRO segment starts on a page
1013 // boundary. This is because the dynamic linker rounds the
1014 // p_vaddr field down to the previous page boundary. If
1015 // there is anything on the page which should not be read-only,
1016 // the program is likely to fail at runtime. So in effect the
1017 // linker must only emit a PT_GNU_RELRO segment if it ensures
1018 // that it starts on a page boundary.
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001019 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr) + load_bias;
1020 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
Elliott Hughes0266ae52014-02-10 17:46:57 -08001021
Elliott Hughesfaf05ba2014-02-11 16:59:37 -08001022 int ret = mprotect(reinterpret_cast<void*>(seg_page_start),
Elliott Hughes0266ae52014-02-10 17:46:57 -08001023 seg_page_end - seg_page_start,
1024 prot_flags);
1025 if (ret < 0) {
1026 return -1;
1027 }
1028 }
1029 return 0;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001030}
1031
1032/* Apply GNU relro protection if specified by the program header. This will
1033 * turn some of the pages of a writable PT_LOAD segment to read-only, as
1034 * specified by one or more PT_GNU_RELRO segments. This must be always
1035 * performed after relocations.
1036 *
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +02001037 * The areas typically covered are .got and .data.rel.ro, these are
1038 * read-only from the program's POV, but contain absolute addresses
1039 * that need to be relocated before use.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001040 *
1041 * Input:
1042 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -07001043 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001044 * load_bias -> load bias
1045 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001046 * 0 on success, -1 on failure (error code in errno).
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001047 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001048int phdr_table_protect_gnu_relro(const ElfW(Phdr)* phdr_table,
1049 size_t phdr_count, ElfW(Addr) load_bias) {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001050 return _phdr_table_set_gnu_relro_prot(phdr_table, phdr_count, load_bias, PROT_READ);
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001051}
1052
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001053/* Serialize the GNU relro segments to the given file descriptor. This can be
1054 * performed after relocations to allow another process to later share the
1055 * relocated segment, if it was loaded at the same address.
1056 *
1057 * Input:
1058 * phdr_table -> program header table
1059 * phdr_count -> number of entries in tables
1060 * load_bias -> load bias
1061 * fd -> writable file descriptor to use
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001062 * file_offset -> pointer to offset into file descriptor to use/update
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001063 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001064 * 0 on success, -1 on failure (error code in errno).
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001065 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001066int phdr_table_serialize_gnu_relro(const ElfW(Phdr)* phdr_table,
1067 size_t phdr_count,
1068 ElfW(Addr) load_bias,
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001069 int fd,
1070 size_t* file_offset) {
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001071 const ElfW(Phdr)* phdr = phdr_table;
1072 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001073
1074 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
1075 if (phdr->p_type != PT_GNU_RELRO) {
1076 continue;
1077 }
1078
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001079 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr) + load_bias;
1080 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001081 ssize_t size = seg_page_end - seg_page_start;
1082
1083 ssize_t written = TEMP_FAILURE_RETRY(write(fd, reinterpret_cast<void*>(seg_page_start), size));
1084 if (written != size) {
1085 return -1;
1086 }
1087 void* map = mmap(reinterpret_cast<void*>(seg_page_start), size, PROT_READ,
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001088 MAP_PRIVATE|MAP_FIXED, fd, *file_offset);
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001089 if (map == MAP_FAILED) {
1090 return -1;
1091 }
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001092 *file_offset += size;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001093 }
1094 return 0;
1095}
1096
1097/* Where possible, replace the GNU relro segments with mappings of the given
1098 * file descriptor. This can be performed after relocations to allow a file
1099 * previously created by phdr_table_serialize_gnu_relro in another process to
1100 * replace the dirty relocated pages, saving memory, if it was loaded at the
1101 * same address. We have to compare the data before we map over it, since some
1102 * parts of the relro segment may not be identical due to other libraries in
1103 * the process being loaded at different addresses.
1104 *
1105 * Input:
1106 * phdr_table -> program header table
1107 * phdr_count -> number of entries in tables
1108 * load_bias -> load bias
1109 * fd -> readable file descriptor to use
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001110 * file_offset -> pointer to offset into file descriptor to use/update
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001111 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001112 * 0 on success, -1 on failure (error code in errno).
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001113 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001114int phdr_table_map_gnu_relro(const ElfW(Phdr)* phdr_table,
1115 size_t phdr_count,
1116 ElfW(Addr) load_bias,
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001117 int fd,
1118 size_t* file_offset) {
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001119 // Map the file at a temporary location so we can compare its contents.
1120 struct stat file_stat;
1121 if (TEMP_FAILURE_RETRY(fstat(fd, &file_stat)) != 0) {
1122 return -1;
1123 }
1124 off_t file_size = file_stat.st_size;
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001125 void* temp_mapping = nullptr;
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +01001126 if (file_size > 0) {
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001127 temp_mapping = mmap(nullptr, file_size, PROT_READ, MAP_PRIVATE, fd, 0);
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +01001128 if (temp_mapping == MAP_FAILED) {
1129 return -1;
1130 }
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001131 }
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001132
1133 // Iterate over the relro segments and compare/remap the pages.
1134 const ElfW(Phdr)* phdr = phdr_table;
1135 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
1136
1137 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
1138 if (phdr->p_type != PT_GNU_RELRO) {
1139 continue;
1140 }
1141
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001142 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr) + load_bias;
1143 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001144
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001145 char* file_base = static_cast<char*>(temp_mapping) + *file_offset;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001146 char* mem_base = reinterpret_cast<char*>(seg_page_start);
1147 size_t match_offset = 0;
1148 size_t size = seg_page_end - seg_page_start;
1149
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001150 if (file_size - *file_offset < size) {
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +01001151 // File is too short to compare to this segment. The contents are likely
1152 // different as well (it's probably for a different library version) so
1153 // just don't bother checking.
1154 break;
1155 }
1156
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001157 while (match_offset < size) {
1158 // Skip over dissimilar pages.
1159 while (match_offset < size &&
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001160 memcmp(mem_base + match_offset, file_base + match_offset, page_size()) != 0) {
1161 match_offset += page_size();
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001162 }
1163
1164 // Count similar pages.
1165 size_t mismatch_offset = match_offset;
1166 while (mismatch_offset < size &&
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001167 memcmp(mem_base + mismatch_offset, file_base + mismatch_offset, page_size()) == 0) {
1168 mismatch_offset += page_size();
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001169 }
1170
1171 // Map over similar pages.
1172 if (mismatch_offset > match_offset) {
1173 void* map = mmap(mem_base + match_offset, mismatch_offset - match_offset,
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001174 PROT_READ, MAP_PRIVATE|MAP_FIXED, fd, *file_offset + match_offset);
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001175 if (map == MAP_FAILED) {
1176 munmap(temp_mapping, file_size);
1177 return -1;
1178 }
1179 }
1180
1181 match_offset = mismatch_offset;
1182 }
1183
1184 // Add to the base file offset in case there are multiple relro segments.
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001185 *file_offset += size;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001186 }
1187 munmap(temp_mapping, file_size);
1188 return 0;
1189}
1190
1191
Elliott Hughes4eeb1f12013-10-25 17:38:02 -07001192#if defined(__arm__)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001193
1194# ifndef PT_ARM_EXIDX
1195# define PT_ARM_EXIDX 0x70000001 /* .ARM.exidx segment */
1196# endif
1197
1198/* Return the address and size of the .ARM.exidx section in memory,
1199 * if present.
1200 *
1201 * Input:
1202 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -07001203 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001204 * load_bias -> load bias
1205 * Output:
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001206 * arm_exidx -> address of table in memory (null on failure).
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001207 * arm_exidx_count -> number of items in table (0 on failure).
1208 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001209 * 0 on success, -1 on failure (_no_ error code in errno)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001210 */
Elliott Hughes0266ae52014-02-10 17:46:57 -08001211int phdr_table_get_arm_exidx(const ElfW(Phdr)* phdr_table, size_t phdr_count,
1212 ElfW(Addr) load_bias,
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -08001213 ElfW(Addr)** arm_exidx, size_t* arm_exidx_count) {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001214 const ElfW(Phdr)* phdr = phdr_table;
1215 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001216
Elliott Hughes0266ae52014-02-10 17:46:57 -08001217 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
1218 if (phdr->p_type != PT_ARM_EXIDX) {
1219 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001220 }
Elliott Hughes0266ae52014-02-10 17:46:57 -08001221
1222 *arm_exidx = reinterpret_cast<ElfW(Addr)*>(load_bias + phdr->p_vaddr);
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -08001223 *arm_exidx_count = phdr->p_memsz / 8;
Elliott Hughes0266ae52014-02-10 17:46:57 -08001224 return 0;
1225 }
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001226 *arm_exidx = nullptr;
Elliott Hughes0266ae52014-02-10 17:46:57 -08001227 *arm_exidx_count = 0;
1228 return -1;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001229}
Elliott Hughes4eeb1f12013-10-25 17:38:02 -07001230#endif
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001231
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +02001232/* Return the address and size of the ELF file's .dynamic section in memory,
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001233 * or null if missing.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001234 *
1235 * Input:
1236 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -07001237 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001238 * load_bias -> load bias
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +02001239 * Output:
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001240 * dynamic -> address of table in memory (null on failure).
Ningsheng Jiane93be992014-09-16 15:22:10 +08001241 * dynamic_flags -> protection flags for section (unset on failure)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001242 * Return:
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +02001243 * void
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001244 */
Elliott Hughes0266ae52014-02-10 17:46:57 -08001245void phdr_table_get_dynamic_section(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Ningsheng Jiane93be992014-09-16 15:22:10 +08001246 ElfW(Addr) load_bias, ElfW(Dyn)** dynamic,
1247 ElfW(Word)* dynamic_flags) {
Dmitriy Ivanov498eb182014-09-05 14:57:59 -07001248 *dynamic = nullptr;
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001249 for (size_t i = 0; i<phdr_count; ++i) {
1250 const ElfW(Phdr)& phdr = phdr_table[i];
1251 if (phdr.p_type == PT_DYNAMIC) {
1252 *dynamic = reinterpret_cast<ElfW(Dyn)*>(load_bias + phdr.p_vaddr);
Ningsheng Jiane93be992014-09-16 15:22:10 +08001253 if (dynamic_flags) {
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001254 *dynamic_flags = phdr.p_flags;
Ningsheng Jiane93be992014-09-16 15:22:10 +08001255 }
Dmitriy Ivanov14669a92014-09-05 16:42:53 -07001256 return;
1257 }
Elliott Hughes0266ae52014-02-10 17:46:57 -08001258 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001259}
1260
Evgenii Stepanovd640b222015-07-10 17:54:01 -07001261/* Return the program interpreter string, or nullptr if missing.
1262 *
1263 * Input:
1264 * phdr_table -> program header table
1265 * phdr_count -> number of entries in tables
1266 * load_bias -> load bias
1267 * Return:
1268 * pointer to the program interpreter string.
1269 */
Tamas Petz8d55d182020-02-24 14:15:25 +01001270const char* phdr_table_get_interpreter_name(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Evgenii Stepanovd640b222015-07-10 17:54:01 -07001271 ElfW(Addr) load_bias) {
1272 for (size_t i = 0; i<phdr_count; ++i) {
1273 const ElfW(Phdr)& phdr = phdr_table[i];
1274 if (phdr.p_type == PT_INTERP) {
1275 return reinterpret_cast<const char*>(load_bias + phdr.p_vaddr);
1276 }
1277 }
1278 return nullptr;
1279}
1280
Robert Grosse4544d9f2014-10-15 14:32:19 -07001281// Sets loaded_phdr_ to the address of the program header table as it appears
1282// in the loaded segments in memory. This is in contrast with phdr_table_,
1283// which is temporary and will be released before the library is relocated.
Elliott Hughes650be4e2013-03-05 18:47:58 -08001284bool ElfReader::FindPhdr() {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001285 const ElfW(Phdr)* phdr_limit = phdr_table_ + phdr_num_;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001286
Elliott Hughes650be4e2013-03-05 18:47:58 -08001287 // If there is a PT_PHDR, use it directly.
Elliott Hughes0266ae52014-02-10 17:46:57 -08001288 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -08001289 if (phdr->p_type == PT_PHDR) {
1290 return CheckPhdr(load_bias_ + phdr->p_vaddr);
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001291 }
Elliott Hughes650be4e2013-03-05 18:47:58 -08001292 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001293
Elliott Hughes650be4e2013-03-05 18:47:58 -08001294 // Otherwise, check the first loadable segment. If its file offset
1295 // is 0, it starts with the ELF header, and we can trivially find the
1296 // loaded program header from it.
Elliott Hughes0266ae52014-02-10 17:46:57 -08001297 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -08001298 if (phdr->p_type == PT_LOAD) {
1299 if (phdr->p_offset == 0) {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001300 ElfW(Addr) elf_addr = load_bias_ + phdr->p_vaddr;
Elliott Hughesfaf05ba2014-02-11 16:59:37 -08001301 const ElfW(Ehdr)* ehdr = reinterpret_cast<const ElfW(Ehdr)*>(elf_addr);
Elliott Hughes0266ae52014-02-10 17:46:57 -08001302 ElfW(Addr) offset = ehdr->e_phoff;
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -08001303 return CheckPhdr(reinterpret_cast<ElfW(Addr)>(ehdr) + offset);
Elliott Hughes650be4e2013-03-05 18:47:58 -08001304 }
1305 break;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001306 }
Elliott Hughes650be4e2013-03-05 18:47:58 -08001307 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001308
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -07001309 DL_ERR("can't find loaded phdr for \"%s\"", name_.c_str());
Elliott Hughes650be4e2013-03-05 18:47:58 -08001310 return false;
1311}
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001312
Tamas Petz8d55d182020-02-24 14:15:25 +01001313// Tries to find .note.gnu.property section.
1314// It is not considered an error if such section is missing.
1315bool ElfReader::FindGnuPropertySection() {
1316#if defined(__aarch64__)
1317 note_gnu_property_ = GnuPropertySection(phdr_table_, phdr_num_, load_start(), name_.c_str());
1318#endif
1319 return true;
1320}
1321
Elliott Hughes650be4e2013-03-05 18:47:58 -08001322// Ensures that our program header is actually within a loadable
1323// segment. This should help catch badly-formed ELF files that
1324// would cause the linker to crash later when trying to access it.
Elliott Hughes0266ae52014-02-10 17:46:57 -08001325bool ElfReader::CheckPhdr(ElfW(Addr) loaded) {
1326 const ElfW(Phdr)* phdr_limit = phdr_table_ + phdr_num_;
1327 ElfW(Addr) loaded_end = loaded + (phdr_num_ * sizeof(ElfW(Phdr)));
Dmitriy Ivanovcf1cbbe2015-10-19 16:57:46 -07001328 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -08001329 if (phdr->p_type != PT_LOAD) {
1330 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001331 }
Elliott Hughes0266ae52014-02-10 17:46:57 -08001332 ElfW(Addr) seg_start = phdr->p_vaddr + load_bias_;
1333 ElfW(Addr) seg_end = phdr->p_filesz + seg_start;
Elliott Hughes650be4e2013-03-05 18:47:58 -08001334 if (seg_start <= loaded && loaded_end <= seg_end) {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001335 loaded_phdr_ = reinterpret_cast<const ElfW(Phdr)*>(loaded);
Elliott Hughes650be4e2013-03-05 18:47:58 -08001336 return true;
1337 }
1338 }
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -07001339 DL_ERR("\"%s\" loaded phdr %p not in loadable segment",
1340 name_.c_str(), reinterpret_cast<void*>(loaded));
Elliott Hughes650be4e2013-03-05 18:47:58 -08001341 return false;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001342}