blob: 6c501bcfae93c6b9ef56a8a126fc531dac68b879 [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
Elliott Hughes650be4e2013-03-05 18:47:58 -080039#include "linker.h"
Elliott Hughes4cc5a602016-11-15 16:54:16 -080040#include "linker_dlwarning.h"
Dimitry Ivanov48ec2882016-08-04 11:50:36 -070041#include "linker_globals.h"
Evgenii Stepanov6bbb75a2023-12-06 18:54:45 +000042#include "linker_debug.h"
Dmitriy Ivanov3c524812015-11-20 17:28:12 -080043#include "linker_utils.h"
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020044
Kalesh Singh377f0b92024-01-31 20:23:39 -080045#include "private/bionic_asm_note.h"
Evgenii Stepanov0a3637d2016-07-06 13:20:59 -070046#include "private/CFIShadow.h" // For kLibraryAlignment
Kalesh Singh377f0b92024-01-31 20:23:39 -080047#include "private/elf_note.h"
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
Kalesh Singh1dd68582024-02-01 00:14:36 -0800145static const size_t kPageSize = page_size();
146
147/*
148 * Generic PMD size calculation:
149 * - Each page table (PT) is of size 1 page.
150 * - Each page table entry (PTE) is of size 64 bits.
151 * - Each PTE locates one physical page frame (PFN) of size 1 page.
152 * - A PMD entry locates 1 page table (PT)
153 *
154 * PMD size = Num entries in a PT * page_size
155 */
156static const size_t kPmdSize = (kPageSize / sizeof(uint64_t)) * kPageSize;
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700157
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700158ElfReader::ElfReader()
159 : did_read_(false), did_load_(false), fd_(-1), file_offset_(0), file_size_(0), phdr_num_(0),
160 phdr_table_(nullptr), shdr_table_(nullptr), shdr_num_(0), dynamic_(nullptr), strtab_(nullptr),
Dimitry Ivanovf45b0e92016-01-15 11:13:35 -0800161 strtab_size_(0), load_start_(nullptr), load_size_(0), load_bias_(0), loaded_phdr_(nullptr),
162 mapped_by_caller_(false) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700163}
164
165bool ElfReader::Read(const char* name, int fd, off64_t file_offset, off64_t file_size) {
Jiyong Park02586a22017-05-20 01:01:24 +0900166 if (did_read_) {
167 return true;
168 }
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700169 name_ = name;
170 fd_ = fd;
171 file_offset_ = file_offset;
172 file_size_ = file_size;
173
174 if (ReadElfHeader() &&
175 VerifyElfHeader() &&
176 ReadProgramHeaders() &&
177 ReadSectionHeaders() &&
Kalesh Singh377f0b92024-01-31 20:23:39 -0800178 ReadDynamicSection() &&
179 ReadPadSegmentNote()) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700180 did_read_ = true;
181 }
182
183 return did_read_;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200184}
185
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400186bool ElfReader::Load(address_space_params* address_space) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700187 CHECK(did_read_);
Jiyong Park02586a22017-05-20 01:01:24 +0900188 if (did_load_) {
189 return true;
190 }
huangchaochaobdc37962022-12-27 19:38:41 +0800191 bool reserveSuccess = ReserveAddressSpace(address_space);
192 if (reserveSuccess && LoadSegments() && FindPhdr() &&
Tamas Petz8d55d182020-02-24 14:15:25 +0100193 FindGnuPropertySection()) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700194 did_load_ = true;
Tamas Petz8d55d182020-02-24 14:15:25 +0100195#if defined(__aarch64__)
196 // For Armv8.5-A loaded executable segments may require PROT_BTI.
197 if (note_gnu_property_.IsBTICompatible()) {
198 did_load_ = (phdr_table_protect_segments(phdr_table_, phdr_num_, load_bias_,
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700199 should_pad_segments_, &note_gnu_property_) == 0);
Tamas Petz8d55d182020-02-24 14:15:25 +0100200 }
201#endif
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700202 }
huangchaochaobdc37962022-12-27 19:38:41 +0800203 if (reserveSuccess && !did_load_) {
204 if (load_start_ != nullptr && load_size_ != 0) {
205 if (!mapped_by_caller_) {
206 munmap(load_start_, load_size_);
207 }
208 }
209 }
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700210
211 return did_load_;
212}
213
214const char* ElfReader::get_string(ElfW(Word) index) const {
215 CHECK(strtab_ != nullptr);
216 CHECK(index < strtab_size_);
217
218 return strtab_ + index;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800219}
220
221bool ElfReader::ReadElfHeader() {
Dmitriy Ivanova6c12792014-10-21 12:09:18 -0700222 ssize_t rc = TEMP_FAILURE_RETRY(pread64(fd_, &header_, sizeof(header_), file_offset_));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800223 if (rc < 0) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700224 DL_ERR("can't read file \"%s\": %s", name_.c_str(), strerror(errno));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800225 return false;
226 }
Dmitriy Ivanova6c12792014-10-21 12:09:18 -0700227
Elliott Hughes650be4e2013-03-05 18:47:58 -0800228 if (rc != sizeof(header_)) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700229 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 -0700230 static_cast<size_t>(rc));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800231 return false;
232 }
233 return true;
234}
235
Elliott Hughes72007ee2017-04-19 17:44:57 -0700236static const char* EM_to_string(int em) {
237 if (em == EM_386) return "EM_386";
238 if (em == EM_AARCH64) return "EM_AARCH64";
239 if (em == EM_ARM) return "EM_ARM";
Ulya Trafimovichb973c752022-11-15 14:39:44 +0000240 if (em == EM_RISCV) return "EM_RISCV";
Elliott Hughes72007ee2017-04-19 17:44:57 -0700241 if (em == EM_X86_64) return "EM_X86_64";
242 return "EM_???";
243}
244
Elliott Hughes650be4e2013-03-05 18:47:58 -0800245bool ElfReader::VerifyElfHeader() {
Elliott Hughes625993d2014-07-15 16:53:13 -0700246 if (memcmp(header_.e_ident, ELFMAG, SELFMAG) != 0) {
Elliott Hughesa8971512018-06-27 14:39:06 -0700247 DL_ERR("\"%s\" has bad ELF magic: %02x%02x%02x%02x", name_.c_str(),
248 header_.e_ident[0], header_.e_ident[1], header_.e_ident[2], header_.e_ident[3]);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800249 return false;
250 }
251
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700252 // Try to give a clear diagnostic for ELF class mismatches, since they're
253 // an easy mistake to make during the 32-bit/64-bit transition period.
254 int elf_class = header_.e_ident[EI_CLASS];
255#if defined(__LP64__)
256 if (elf_class != ELFCLASS64) {
257 if (elf_class == ELFCLASS32) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700258 DL_ERR("\"%s\" is 32-bit instead of 64-bit", name_.c_str());
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700259 } else {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700260 DL_ERR("\"%s\" has unknown ELF class: %d", name_.c_str(), elf_class);
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700261 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800262 return false;
263 }
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700264#else
265 if (elf_class != ELFCLASS32) {
266 if (elf_class == ELFCLASS64) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700267 DL_ERR("\"%s\" is 64-bit instead of 32-bit", name_.c_str());
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700268 } else {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700269 DL_ERR("\"%s\" has unknown ELF class: %d", name_.c_str(), elf_class);
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700270 }
271 return false;
272 }
273#endif
274
Elliott Hughes650be4e2013-03-05 18:47:58 -0800275 if (header_.e_ident[EI_DATA] != ELFDATA2LSB) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700276 DL_ERR("\"%s\" not little-endian: %d", name_.c_str(), header_.e_ident[EI_DATA]);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800277 return false;
278 }
279
280 if (header_.e_type != ET_DYN) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700281 DL_ERR("\"%s\" has unexpected e_type: %d", name_.c_str(), header_.e_type);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800282 return false;
283 }
284
285 if (header_.e_version != EV_CURRENT) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700286 DL_ERR("\"%s\" has unexpected e_version: %d", name_.c_str(), header_.e_version);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800287 return false;
288 }
289
Elliott Hughesb5140262014-12-02 16:16:29 -0800290 if (header_.e_machine != GetTargetElfMachine()) {
Elliott Hughesd16cfac2018-09-17 15:50:09 -0700291 DL_ERR("\"%s\" is for %s (%d) instead of %s (%d)",
292 name_.c_str(),
293 EM_to_string(header_.e_machine), header_.e_machine,
294 EM_to_string(GetTargetElfMachine()), GetTargetElfMachine());
Elliott Hughes650be4e2013-03-05 18:47:58 -0800295 return false;
296 }
297
Dimitry Ivanovc73eec12016-07-22 12:50:59 -0700298 if (header_.e_shentsize != sizeof(ElfW(Shdr))) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800299 // Fail if app is targeting Android O or above
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800300 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800301 DL_ERR_AND_LOG("\"%s\" has unsupported e_shentsize: 0x%x (expected 0x%zx)",
302 name_.c_str(), header_.e_shentsize, sizeof(ElfW(Shdr)));
303 return false;
304 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800305 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800306 "invalid-elf-header_section-headers-enforced-for-api-level-26",
307 "\"%s\" has unsupported e_shentsize 0x%x (expected 0x%zx)",
308 name_.c_str(), header_.e_shentsize, sizeof(ElfW(Shdr)));
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800309 add_dlwarning(name_.c_str(), "has invalid ELF header");
Dimitry Ivanovc73eec12016-07-22 12:50:59 -0700310 }
311
312 if (header_.e_shstrndx == 0) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800313 // Fail if app is targeting Android O or above
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800314 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800315 DL_ERR_AND_LOG("\"%s\" has invalid e_shstrndx", name_.c_str());
316 return false;
317 }
318
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800319 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800320 "invalid-elf-header_section-headers-enforced-for-api-level-26",
321 "\"%s\" has invalid e_shstrndx", name_.c_str());
Dimitry Ivanov12b91872016-11-16 12:29:37 -0800322 add_dlwarning(name_.c_str(), "has invalid ELF header");
Dimitry Ivanovc73eec12016-07-22 12:50:59 -0700323 }
324
Elliott Hughes650be4e2013-03-05 18:47:58 -0800325 return true;
326}
327
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700328bool ElfReader::CheckFileRange(ElfW(Addr) offset, size_t size, size_t alignment) {
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800329 off64_t range_start;
330 off64_t range_end;
331
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700332 // Only header can be located at the 0 offset... This function called to
333 // check DYNSYM and DYNAMIC sections and phdr/shdr - none of them can be
Dimitry Ivanovebe5af72016-07-14 11:15:44 -0700334 // at offset 0.
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700335
336 return offset > 0 &&
337 safe_add(&range_start, file_offset_, offset) &&
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800338 safe_add(&range_end, range_start, size) &&
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700339 (range_start < file_size_) &&
340 (range_end <= file_size_) &&
341 ((offset % alignment) == 0);
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800342}
343
Elliott Hughes650be4e2013-03-05 18:47:58 -0800344// Loads the program header table from an ELF file into a read-only private
345// anonymous mmap-ed block.
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700346bool ElfReader::ReadProgramHeaders() {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800347 phdr_num_ = header_.e_phnum;
348
349 // Like the kernel, we only accept program header tables that
350 // are smaller than 64KiB.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800351 if (phdr_num_ < 1 || phdr_num_ > 65536/sizeof(ElfW(Phdr))) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700352 DL_ERR("\"%s\" has invalid e_phnum: %zd", name_.c_str(), phdr_num_);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800353 return false;
354 }
355
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800356 // Boundary checks
357 size_t size = phdr_num_ * sizeof(ElfW(Phdr));
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700358 if (!CheckFileRange(header_.e_phoff, size, alignof(ElfW(Phdr)))) {
359 DL_ERR_AND_LOG("\"%s\" has invalid phdr offset/size: %zu/%zu",
360 name_.c_str(),
361 static_cast<size_t>(header_.e_phoff),
362 size);
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800363 return false;
364 }
365
366 if (!phdr_fragment_.Map(fd_, file_offset_, header_.e_phoff, size)) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700367 DL_ERR("\"%s\" phdr mmap failed: %s", name_.c_str(), strerror(errno));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800368 return false;
369 }
370
Dmitriy Ivanovcf1cbbe2015-10-19 16:57:46 -0700371 phdr_table_ = static_cast<ElfW(Phdr)*>(phdr_fragment_.data());
Elliott Hughes650be4e2013-03-05 18:47:58 -0800372 return true;
373}
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200374
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700375bool ElfReader::ReadSectionHeaders() {
376 shdr_num_ = header_.e_shnum;
377
Dmitriy Ivanovb76123f2015-11-20 10:42:02 -0800378 if (shdr_num_ == 0) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700379 DL_ERR_AND_LOG("\"%s\" has no section headers", name_.c_str());
Dmitriy Ivanovb76123f2015-11-20 10:42:02 -0800380 return false;
381 }
382
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800383 size_t size = shdr_num_ * sizeof(ElfW(Shdr));
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700384 if (!CheckFileRange(header_.e_shoff, size, alignof(const ElfW(Shdr)))) {
385 DL_ERR_AND_LOG("\"%s\" has invalid shdr offset/size: %zu/%zu",
386 name_.c_str(),
387 static_cast<size_t>(header_.e_shoff),
388 size);
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800389 return false;
390 }
391
392 if (!shdr_fragment_.Map(fd_, file_offset_, header_.e_shoff, size)) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700393 DL_ERR("\"%s\" shdr mmap failed: %s", name_.c_str(), strerror(errno));
394 return false;
395 }
396
397 shdr_table_ = static_cast<const ElfW(Shdr)*>(shdr_fragment_.data());
398 return true;
399}
400
401bool ElfReader::ReadDynamicSection() {
402 // 1. Find .dynamic section (in section headers)
403 const ElfW(Shdr)* dynamic_shdr = nullptr;
404 for (size_t i = 0; i < shdr_num_; ++i) {
405 if (shdr_table_[i].sh_type == SHT_DYNAMIC) {
406 dynamic_shdr = &shdr_table_ [i];
407 break;
408 }
409 }
410
411 if (dynamic_shdr == nullptr) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700412 DL_ERR_AND_LOG("\"%s\" .dynamic section header was not found", name_.c_str());
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700413 return false;
414 }
415
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700416 // Make sure dynamic_shdr offset and size matches PT_DYNAMIC phdr
417 size_t pt_dynamic_offset = 0;
418 size_t pt_dynamic_filesz = 0;
419 for (size_t i = 0; i < phdr_num_; ++i) {
420 const ElfW(Phdr)* phdr = &phdr_table_[i];
421 if (phdr->p_type == PT_DYNAMIC) {
422 pt_dynamic_offset = phdr->p_offset;
423 pt_dynamic_filesz = phdr->p_filesz;
424 }
425 }
426
427 if (pt_dynamic_offset != dynamic_shdr->sh_offset) {
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800428 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800429 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid offset: 0x%zx, "
430 "expected to match PT_DYNAMIC offset: 0x%zx",
431 name_.c_str(),
432 static_cast<size_t>(dynamic_shdr->sh_offset),
433 pt_dynamic_offset);
434 return false;
435 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800436 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800437 "invalid-elf-header_section-headers-enforced-for-api-level-26",
438 "\"%s\" .dynamic section has invalid offset: 0x%zx "
439 "(expected to match PT_DYNAMIC offset 0x%zx)",
440 name_.c_str(),
441 static_cast<size_t>(dynamic_shdr->sh_offset),
442 pt_dynamic_offset);
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800443 add_dlwarning(name_.c_str(), "invalid .dynamic section");
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700444 }
445
446 if (pt_dynamic_filesz != dynamic_shdr->sh_size) {
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800447 if (get_application_target_sdk_version() >= 26) {
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800448 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid size: 0x%zx, "
449 "expected to match PT_DYNAMIC filesz: 0x%zx",
450 name_.c_str(),
451 static_cast<size_t>(dynamic_shdr->sh_size),
452 pt_dynamic_filesz);
453 return false;
454 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800455 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800456 "invalid-elf-header_section-headers-enforced-for-api-level-26",
457 "\"%s\" .dynamic section has invalid size: 0x%zx "
458 "(expected to match PT_DYNAMIC filesz 0x%zx)",
459 name_.c_str(),
460 static_cast<size_t>(dynamic_shdr->sh_size),
461 pt_dynamic_filesz);
Dimitry Ivanove30c17f2016-12-28 16:21:49 -0800462 add_dlwarning(name_.c_str(), "invalid .dynamic section");
Dimitry Ivanov0c9d30f2016-07-13 17:06:36 -0700463 }
464
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700465 if (dynamic_shdr->sh_link >= shdr_num_) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700466 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid sh_link: %d",
467 name_.c_str(),
468 dynamic_shdr->sh_link);
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700469 return false;
470 }
471
472 const ElfW(Shdr)* strtab_shdr = &shdr_table_[dynamic_shdr->sh_link];
473
474 if (strtab_shdr->sh_type != SHT_STRTAB) {
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700475 DL_ERR_AND_LOG("\"%s\" .dynamic section has invalid link(%d) sh_type: %d (expected SHT_STRTAB)",
476 name_.c_str(), dynamic_shdr->sh_link, strtab_shdr->sh_type);
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700477 return false;
478 }
479
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700480 if (!CheckFileRange(dynamic_shdr->sh_offset, dynamic_shdr->sh_size, alignof(const ElfW(Dyn)))) {
481 DL_ERR_AND_LOG("\"%s\" has invalid offset/size of .dynamic section", name_.c_str());
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800482 return false;
483 }
484
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700485 if (!dynamic_fragment_.Map(fd_, file_offset_, dynamic_shdr->sh_offset, dynamic_shdr->sh_size)) {
486 DL_ERR("\"%s\" dynamic section mmap failed: %s", name_.c_str(), strerror(errno));
487 return false;
488 }
489
490 dynamic_ = static_cast<const ElfW(Dyn)*>(dynamic_fragment_.data());
491
Dimitry Ivanovbd906752016-08-08 17:12:18 -0700492 if (!CheckFileRange(strtab_shdr->sh_offset, strtab_shdr->sh_size, alignof(const char))) {
493 DL_ERR_AND_LOG("\"%s\" has invalid offset/size of the .strtab section linked from .dynamic section",
494 name_.c_str());
Dmitriy Ivanov3c524812015-11-20 17:28:12 -0800495 return false;
496 }
497
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700498 if (!strtab_fragment_.Map(fd_, file_offset_, strtab_shdr->sh_offset, strtab_shdr->sh_size)) {
499 DL_ERR("\"%s\" strtab section mmap failed: %s", name_.c_str(), strerror(errno));
500 return false;
501 }
502
503 strtab_ = static_cast<const char*>(strtab_fragment_.data());
504 strtab_size_ = strtab_fragment_.size();
505 return true;
506}
507
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800508/* Returns the size of the extent of all the possibly non-contiguous
509 * loadable segments in an ELF program header table. This corresponds
510 * to the page-aligned size in bytes that needs to be reserved in the
511 * process' address space. If there are no loadable segments, 0 is
512 * returned.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200513 *
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700514 * If out_min_vaddr or out_max_vaddr are not null, they will be
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800515 * set to the minimum and maximum addresses of pages to be reserved,
516 * or 0 if there is nothing to load.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200517 */
Elliott Hughes0266ae52014-02-10 17:46:57 -0800518size_t phdr_table_get_load_size(const ElfW(Phdr)* phdr_table, size_t phdr_count,
519 ElfW(Addr)* out_min_vaddr,
520 ElfW(Addr)* out_max_vaddr) {
521 ElfW(Addr) min_vaddr = UINTPTR_MAX;
522 ElfW(Addr) max_vaddr = 0;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200523
Elliott Hughes0266ae52014-02-10 17:46:57 -0800524 bool found_pt_load = false;
525 for (size_t i = 0; i < phdr_count; ++i) {
526 const ElfW(Phdr)* phdr = &phdr_table[i];
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200527
Elliott Hughes0266ae52014-02-10 17:46:57 -0800528 if (phdr->p_type != PT_LOAD) {
529 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200530 }
Elliott Hughes0266ae52014-02-10 17:46:57 -0800531 found_pt_load = true;
532
533 if (phdr->p_vaddr < min_vaddr) {
534 min_vaddr = phdr->p_vaddr;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200535 }
536
Elliott Hughes0266ae52014-02-10 17:46:57 -0800537 if (phdr->p_vaddr + phdr->p_memsz > max_vaddr) {
538 max_vaddr = phdr->p_vaddr + phdr->p_memsz;
539 }
540 }
541 if (!found_pt_load) {
542 min_vaddr = 0;
543 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200544
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700545 min_vaddr = page_start(min_vaddr);
546 max_vaddr = page_end(max_vaddr);
Elliott Hughes0266ae52014-02-10 17:46:57 -0800547
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700548 if (out_min_vaddr != nullptr) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800549 *out_min_vaddr = min_vaddr;
550 }
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700551 if (out_max_vaddr != nullptr) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800552 *out_max_vaddr = max_vaddr;
553 }
554 return max_vaddr - min_vaddr;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200555}
556
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700557// Returns the maximum p_align associated with a loadable segment in the ELF
558// program header table. Used to determine whether the file should be loaded at
559// a specific virtual address alignment for use with huge pages.
560size_t phdr_table_get_maximum_alignment(const ElfW(Phdr)* phdr_table, size_t phdr_count) {
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700561 size_t maximum_alignment = page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700562
563 for (size_t i = 0; i < phdr_count; ++i) {
564 const ElfW(Phdr)* phdr = &phdr_table[i];
565
566 // p_align must be 0, 1, or a positive, integral power of two.
567 if (phdr->p_type != PT_LOAD || ((phdr->p_align & (phdr->p_align - 1)) != 0)) {
568 continue;
569 }
570
571 if (phdr->p_align > maximum_alignment) {
572 maximum_alignment = phdr->p_align;
573 }
574 }
575
576#if defined(__LP64__)
577 return maximum_alignment;
578#else
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700579 return page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700580#endif
581}
582
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700583// Reserve a virtual address range such that if it's limits were extended to the next 2**align
584// boundary, it would not overlap with any existing mappings.
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700585static void* ReserveWithAlignmentPadding(size_t size, size_t mapping_align, size_t start_align,
586 void** out_gap_start, size_t* out_gap_size) {
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700587 int mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS;
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700588 // Reserve enough space to properly align the library's start address.
589 mapping_align = std::max(mapping_align, start_align);
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700590 if (mapping_align == page_size()) {
Elliott Hughes8178c412018-11-05 13:34:36 -0800591 void* mmap_ptr = mmap(nullptr, size, PROT_NONE, mmap_flags, -1, 0);
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700592 if (mmap_ptr == MAP_FAILED) {
593 return nullptr;
594 }
595 return mmap_ptr;
596 }
597
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700598 // Minimum alignment of shared library gap. For efficiency, this should match the second level
599 // page size of the platform.
600#if defined(__LP64__)
601 constexpr size_t kGapAlignment = 1ul << 21; // 2MB
602#else
603 constexpr size_t kGapAlignment = 0;
604#endif
605 // Maximum gap size, in the units of kGapAlignment.
606 constexpr size_t kMaxGapUnits = 32;
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700607 // Allocate enough space so that the end of the desired region aligned up is still inside the
608 // mapping.
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700609 size_t mmap_size = align_up(size, mapping_align) + mapping_align - page_size();
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700610 uint8_t* mmap_ptr =
611 reinterpret_cast<uint8_t*>(mmap(nullptr, mmap_size, PROT_NONE, mmap_flags, -1, 0));
612 if (mmap_ptr == MAP_FAILED) {
613 return nullptr;
614 }
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700615 size_t gap_size = 0;
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700616 size_t first_byte = reinterpret_cast<size_t>(align_up(mmap_ptr, mapping_align));
617 size_t last_byte = reinterpret_cast<size_t>(align_down(mmap_ptr + mmap_size, mapping_align) - 1);
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700618 if (kGapAlignment && first_byte / kGapAlignment != last_byte / kGapAlignment) {
619 // This library crosses a 2MB boundary and will fragment a new huge page.
620 // Lets take advantage of that and insert a random number of inaccessible huge pages before that
621 // to improve address randomization and make it harder to locate this library code by probing.
622 munmap(mmap_ptr, mmap_size);
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700623 mapping_align = std::max(mapping_align, kGapAlignment);
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700624 gap_size =
625 kGapAlignment * (is_first_stage_init() ? 1 : arc4random_uniform(kMaxGapUnits - 1) + 1);
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700626 mmap_size = align_up(size + gap_size, mapping_align) + mapping_align - page_size();
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700627 mmap_ptr = reinterpret_cast<uint8_t*>(mmap(nullptr, mmap_size, PROT_NONE, mmap_flags, -1, 0));
628 if (mmap_ptr == MAP_FAILED) {
629 return nullptr;
630 }
631 }
632
633 uint8_t *gap_end, *gap_start;
634 if (gap_size) {
635 gap_end = align_down(mmap_ptr + mmap_size, kGapAlignment);
636 gap_start = gap_end - gap_size;
637 } else {
638 gap_start = gap_end = mmap_ptr + mmap_size;
639 }
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700640
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700641 uint8_t* first = align_up(mmap_ptr, mapping_align);
642 uint8_t* last = align_down(gap_start, mapping_align) - size;
Jiyong Park31cd08f2018-06-01 19:18:56 +0900643
Tom Cherry66bc4282018-11-08 13:40:52 -0800644 // arc4random* is not available in first stage init because /dev/urandom hasn't yet been
Jiyong Park31cd08f2018-06-01 19:18:56 +0900645 // created. Don't randomize then.
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700646 size_t n = is_first_stage_init() ? 0 : arc4random_uniform((last - first) / start_align + 1);
647 uint8_t* start = first + n * start_align;
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700648 // Unmap the extra space around the allocation.
649 // Keep it mapped PROT_NONE on 64-bit targets where address space is plentiful to make it harder
650 // to defeat ASLR by probing for readable memory mappings.
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700651 munmap(mmap_ptr, start - mmap_ptr);
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700652 munmap(start + size, gap_start - (start + size));
653 if (gap_end != mmap_ptr + mmap_size) {
654 munmap(gap_end, mmap_ptr + mmap_size - gap_end);
655 }
656 *out_gap_start = gap_start;
657 *out_gap_size = gap_size;
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700658 return start;
659}
660
Elliott Hughes650be4e2013-03-05 18:47:58 -0800661// Reserve a virtual address range big enough to hold all loadable
662// segments of a program header table. This is done by creating a
663// private anonymous mmap() with PROT_NONE.
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400664bool ElfReader::ReserveAddressSpace(address_space_params* address_space) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800665 ElfW(Addr) min_vaddr;
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800666 load_size_ = phdr_table_get_load_size(phdr_table_, phdr_num_, &min_vaddr);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800667 if (load_size_ == 0) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700668 DL_ERR("\"%s\" has no loadable segments", name_.c_str());
Elliott Hughes650be4e2013-03-05 18:47:58 -0800669 return false;
670 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200671
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800672 uint8_t* addr = reinterpret_cast<uint8_t*>(min_vaddr);
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000673 void* start;
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000674
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400675 if (load_size_ > address_space->reserved_size) {
676 if (address_space->must_use_address) {
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000677 DL_ERR("reserved address space %zd smaller than %zd bytes needed for \"%s\"",
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400678 load_size_ - address_space->reserved_size, load_size_, name_.c_str());
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000679 return false;
680 }
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700681 size_t start_alignment = page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700682 if (get_transparent_hugepages_supported() && get_application_target_sdk_version() >= 31) {
683 size_t maximum_alignment = phdr_table_get_maximum_alignment(phdr_table_, phdr_num_);
684 // Limit alignment to PMD size as other alignments reduce the number of
685 // bits available for ASLR for no benefit.
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700686 start_alignment = maximum_alignment == kPmdSize ? kPmdSize : page_size();
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700687 }
688 start = ReserveWithAlignmentPadding(load_size_, kLibraryAlignment, start_alignment, &gap_start_,
689 &gap_size_);
Evgenii Stepanovd13e9a62016-07-15 16:31:42 -0700690 if (start == nullptr) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700691 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 +0000692 return false;
693 }
694 } else {
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400695 start = address_space->start_addr;
Evgenii Stepanove0848bb2020-07-14 16:44:57 -0700696 gap_start_ = nullptr;
697 gap_size_ = 0;
Dimitry Ivanovf45b0e92016-01-15 11:13:35 -0800698 mapped_by_caller_ = true;
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -0400699
700 // Update the reserved address space to subtract the space used by this library.
701 address_space->start_addr = reinterpret_cast<uint8_t*>(address_space->start_addr) + load_size_;
702 address_space->reserved_size -= load_size_;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800703 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200704
Elliott Hughes650be4e2013-03-05 18:47:58 -0800705 load_start_ = start;
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800706 load_bias_ = reinterpret_cast<uint8_t*>(start) - addr;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800707 return true;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200708}
709
Kalesh Singh377f0b92024-01-31 20:23:39 -0800710// Find the ELF note of type NT_ANDROID_TYPE_PAD_SEGMENT and check that the desc value is 1.
711bool ElfReader::ReadPadSegmentNote() {
712 // The ELF can have multiple PT_NOTE's, check them all
713 for (size_t i = 0; i < phdr_num_; ++i) {
714 const ElfW(Phdr)* phdr = &phdr_table_[i];
715
716 if (phdr->p_type != PT_NOTE) {
717 continue;
718 }
719
Kalesh Singh13fb3cf2024-02-08 14:58:04 -0800720 // Some obfuscated ELFs may contain "empty" PT_NOTE program headers that don't
721 // point to any part of the ELF (p_memsz == 0). Skip these since there is
722 // nothing to decode. See: b/324468126
723 if (phdr->p_memsz == 0) {
724 continue;
725 }
726
Kalesh Singh377f0b92024-01-31 20:23:39 -0800727 // note_fragment is scoped to within the loop so that there is
728 // at most 1 PT_NOTE mapped at anytime during this search.
729 MappedFileFragment note_fragment;
730 if (!note_fragment.Map(fd_, file_offset_, phdr->p_offset, phdr->p_memsz)) {
Kalesh Singh13fb3cf2024-02-08 14:58:04 -0800731 DL_ERR("\"%s\": PT_NOTE mmap(nullptr, %zu, PROT_READ, MAP_PRIVATE, %d, %p) failed: %m",
732 name_.c_str(), phdr->p_memsz, fd_, page_start(file_offset_ + phdr->p_offset));
733 return false;
Kalesh Singh377f0b92024-01-31 20:23:39 -0800734 }
735
736 const ElfW(Nhdr)* note_hdr = nullptr;
737 const char* note_desc = nullptr;
738 if (!__get_elf_note(NT_ANDROID_TYPE_PAD_SEGMENT, "Android",
739 reinterpret_cast<ElfW(Addr)>(note_fragment.data()),
740 phdr, &note_hdr, &note_desc)) {
741 continue;
742 }
743
744 if (note_hdr->n_descsz != sizeof(ElfW(Word))) {
745 DL_ERR("\"%s\" NT_ANDROID_TYPE_PAD_SEGMENT note has unexpected n_descsz: %u",
746 name_.c_str(), reinterpret_cast<unsigned int>(note_hdr->n_descsz));
747 return false;
748 }
749
750 // 1 == enabled, 0 == disabled
751 should_pad_segments_ = *reinterpret_cast<const ElfW(Word)*>(note_desc) == 1;
752 return true;
753 }
754
755 return true;
756}
757
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700758static inline void _extend_load_segment_vma(const ElfW(Phdr)* phdr_table, size_t phdr_count,
759 size_t phdr_idx, ElfW(Addr)* p_memsz,
760 ElfW(Addr)* p_filesz) {
761 const ElfW(Phdr)* phdr = &phdr_table[phdr_idx];
762 const ElfW(Phdr)* next = nullptr;
763 size_t next_idx = phdr_idx + 1;
764 if (next_idx < phdr_count && phdr_table[next_idx].p_type == PT_LOAD) {
765 next = &phdr_table[next_idx];
766 }
767
768 // If this is the last LOAD segment, no extension is needed
769 if (!next || *p_memsz != *p_filesz) {
770 return;
771 }
772
773 ElfW(Addr) next_start = page_start(next->p_vaddr);
774 ElfW(Addr) curr_end = page_end(phdr->p_vaddr + *p_memsz);
775
776 // If adjacent segment mappings overlap, no extension is needed.
777 if (curr_end >= next_start) {
778 return;
779 }
780
781 // Extend the LOAD segment mapping to be contiguous with that of
782 // the next LOAD segment.
783 ElfW(Addr) extend = next_start - curr_end;
784 *p_memsz += extend;
785 *p_filesz += extend;
786}
787
Elliott Hughes650be4e2013-03-05 18:47:58 -0800788bool ElfReader::LoadSegments() {
789 for (size_t i = 0; i < phdr_num_; ++i) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800790 const ElfW(Phdr)* phdr = &phdr_table_[i];
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200791
Elliott Hughes650be4e2013-03-05 18:47:58 -0800792 if (phdr->p_type != PT_LOAD) {
793 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200794 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800795
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700796 ElfW(Addr) p_memsz = phdr->p_memsz;
797 ElfW(Addr) p_filesz = phdr->p_filesz;
798 if (phdr->p_align > kPageSize && should_pad_segments_) {
799 _extend_load_segment_vma(phdr_table_, phdr_num_, i, &p_memsz, &p_filesz);
800 }
801
Elliott Hughes650be4e2013-03-05 18:47:58 -0800802 // Segment addresses in memory.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800803 ElfW(Addr) seg_start = phdr->p_vaddr + load_bias_;
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700804 ElfW(Addr) seg_end = seg_start + p_memsz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800805
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700806 ElfW(Addr) seg_page_start = page_start(seg_start);
807 ElfW(Addr) seg_page_end = page_end(seg_end);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800808
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700809 ElfW(Addr) seg_file_end = seg_start + p_filesz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800810
811 // File offsets.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800812 ElfW(Addr) file_start = phdr->p_offset;
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700813 ElfW(Addr) file_end = file_start + p_filesz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800814
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700815 ElfW(Addr) file_page_start = page_start(file_start);
Elliott Hughes0266ae52014-02-10 17:46:57 -0800816 ElfW(Addr) file_length = file_end - file_page_start;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800817
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700818 if (file_size_ <= 0) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700819 DL_ERR("\"%s\" invalid file size: %" PRId64, name_.c_str(), file_size_);
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700820 return false;
821 }
822
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700823 if (file_start + phdr->p_filesz > static_cast<size_t>(file_size_)) {
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700824 DL_ERR("invalid ELF file \"%s\" load segment[%zd]:"
825 " p_offset (%p) + p_filesz (%p) ( = %p) past end of file (0x%" PRIx64 ")",
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700826 name_.c_str(), i, reinterpret_cast<void*>(phdr->p_offset),
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700827 reinterpret_cast<void*>(phdr->p_filesz),
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700828 reinterpret_cast<void*>(file_start + phdr->p_filesz), file_size_);
Dmitriy Ivanov3f987f52015-06-25 15:51:41 -0700829 return false;
830 }
831
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700832 if (file_length != 0) {
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700833 int prot = PFLAGS_TO_PROT(phdr->p_flags);
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700834 if ((prot & (PROT_EXEC | PROT_WRITE)) == (PROT_EXEC | PROT_WRITE)) {
Elliott Hughes4cc5a602016-11-15 16:54:16 -0800835 // W + E PT_LOAD segments are not allowed in O.
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800836 if (get_application_target_sdk_version() >= 26) {
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800837 DL_ERR_AND_LOG("\"%s\": W+E load segments are not allowed", name_.c_str());
Elliott Hughes4cc5a602016-11-15 16:54:16 -0800838 return false;
839 }
Elliott Hughes95c6cd72019-12-20 13:26:14 -0800840 DL_WARN_documented_change(26,
Elliott Hughes9076b0c2018-02-28 11:29:45 -0800841 "writable-and-executable-segments-enforced-for-api-level-26",
842 "\"%s\" has load segments that are both writable and executable",
843 name_.c_str());
Elliott Hughes4cc5a602016-11-15 16:54:16 -0800844 add_dlwarning(name_.c_str(), "W+E load segments");
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700845 }
846
Dmitriy Ivanov07e5bc12014-10-03 17:52:44 -0700847 void* seg_addr = mmap64(reinterpret_cast<void*>(seg_page_start),
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700848 file_length,
Dimitry Ivanov9700bab2016-08-10 18:54:06 -0700849 prot,
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700850 MAP_FIXED|MAP_PRIVATE,
851 fd_,
Dmitriy Ivanov07e5bc12014-10-03 17:52:44 -0700852 file_offset_ + file_page_start);
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700853 if (seg_addr == MAP_FAILED) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700854 DL_ERR("couldn't map \"%s\" segment %zd: %s", name_.c_str(), i, strerror(errno));
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700855 return false;
856 }
Collin Fijalkovich47d27aa2021-03-24 10:17:39 -0700857
858 // Mark segments as huge page eligible if they meet the requirements
859 // (executable and PMD aligned).
860 if ((phdr->p_flags & PF_X) && phdr->p_align == kPmdSize &&
861 get_transparent_hugepages_supported()) {
862 madvise(seg_addr, file_length, MADV_HUGEPAGE);
863 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800864 }
865
866 // if the segment is writable, and does not end on a page boundary,
867 // zero-fill it until the page limit.
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700868 //
869 // The intention is to zero the partial page at that may exist at the
870 // end of a file backed mapping. With the extended seg_file_end, this
871 // file offset as calculated from the mapping start can overrun the end
872 // of the file. However pages in that range cannot be touched by userspace
873 // because the kernel will not be able to handle a file map fault past the
874 // extent of the file. No need to try zeroing this untouchable region.
875 // Zero the partial page at the end of the original unextended seg_file_end.
876 ElfW(Addr) seg_file_end_orig = seg_start + phdr->p_filesz;
877 if ((phdr->p_flags & PF_W) != 0 && page_offset(seg_file_end_orig) > 0) {
878 memset(reinterpret_cast<void*>(seg_file_end_orig), 0,
879 kPageSize - page_offset(seg_file_end_orig));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800880 }
881
Peter Collingbournebb11ee62022-05-02 12:26:16 -0700882 seg_file_end = page_end(seg_file_end);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800883
884 // seg_file_end is now the first page address after the file
885 // content. If seg_end is larger, we need to zero anything
886 // between them. This is done by using a private anonymous
887 // map for all extra pages.
888 if (seg_page_end > seg_file_end) {
Dimitry Ivanov1b84afc2016-01-27 18:12:03 -0800889 size_t zeromap_size = seg_page_end - seg_file_end;
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800890 void* zeromap = mmap(reinterpret_cast<void*>(seg_file_end),
Dimitry Ivanov1b84afc2016-01-27 18:12:03 -0800891 zeromap_size,
Elliott Hughes650be4e2013-03-05 18:47:58 -0800892 PFLAGS_TO_PROT(phdr->p_flags),
893 MAP_FIXED|MAP_ANONYMOUS|MAP_PRIVATE,
894 -1,
895 0);
896 if (zeromap == MAP_FAILED) {
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -0700897 DL_ERR("couldn't zero fill \"%s\" gap: %s", name_.c_str(), strerror(errno));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800898 return false;
899 }
Dimitry Ivanov1b84afc2016-01-27 18:12:03 -0800900
901 prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME, zeromap, zeromap_size, ".bss");
Elliott Hughes650be4e2013-03-05 18:47:58 -0800902 }
903 }
904 return true;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200905}
906
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000907/* Used internally. Used to set the protection bits of all loaded segments
908 * with optional extra flags (i.e. really PROT_WRITE). Used by
909 * phdr_table_protect_segments and phdr_table_unprotect_segments.
910 */
911static int _phdr_table_set_load_prot(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700912 ElfW(Addr) load_bias, int extra_prot_flags,
913 bool should_pad_segments) {
914 for (size_t i = 0; i < phdr_count; ++i) {
915 const ElfW(Phdr)* phdr = &phdr_table[i];
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000916
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000917 if (phdr->p_type != PT_LOAD || (phdr->p_flags & PF_W) != 0) {
918 continue;
919 }
920
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700921 ElfW(Addr) p_memsz = phdr->p_memsz;
922 ElfW(Addr) p_filesz = phdr->p_filesz;
923 if (phdr->p_align > kPageSize && should_pad_segments) {
924 _extend_load_segment_vma(phdr_table, phdr_count, i, &p_memsz, &p_filesz);
925 }
926
927 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr + load_bias);
928 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + p_memsz + load_bias);
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000929
Tamas Petz8d55d182020-02-24 14:15:25 +0100930 int prot = PFLAGS_TO_PROT(phdr->p_flags) | extra_prot_flags;
931 if ((prot & PROT_WRITE) != 0) {
Nick Kralevich8fdb3412015-04-01 16:57:50 -0700932 // make sure we're never simultaneously writable / executable
933 prot &= ~PROT_EXEC;
934 }
Tamas Petz8d55d182020-02-24 14:15:25 +0100935#if defined(__aarch64__)
936 if ((prot & PROT_EXEC) == 0) {
937 // Though it is not specified don't add PROT_BTI if segment is not
938 // executable.
939 prot &= ~PROT_BTI;
940 }
941#endif
Nick Kralevich8fdb3412015-04-01 16:57:50 -0700942
Tamas Petz8d55d182020-02-24 14:15:25 +0100943 int ret =
944 mprotect(reinterpret_cast<void*>(seg_page_start), seg_page_end - seg_page_start, prot);
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000945 if (ret < 0) {
946 return -1;
947 }
948 }
949 return 0;
950}
951
952/* Restore the original protection modes for all loadable segments.
953 * You should only call this after phdr_table_unprotect_segments and
954 * applying all relocations.
955 *
Tamas Petz8d55d182020-02-24 14:15:25 +0100956 * AArch64: also called from linker_main and ElfReader::Load to apply
957 * PROT_BTI for loaded main so and other so-s.
958 *
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000959 * Input:
960 * phdr_table -> program header table
961 * phdr_count -> number of entries in tables
962 * load_bias -> load bias
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700963 * should_pad_segments -> Are segments extended to avoid gaps in the memory map
Tamas Petz8d55d182020-02-24 14:15:25 +0100964 * prop -> GnuPropertySection or nullptr
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000965 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +0000966 * 0 on success, -1 on failure (error code in errno).
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000967 */
Tamas Petz8d55d182020-02-24 14:15:25 +0100968int phdr_table_protect_segments(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700969 ElfW(Addr) load_bias, bool should_pad_segments,
970 const GnuPropertySection* prop __unused) {
Tamas Petz8d55d182020-02-24 14:15:25 +0100971 int prot = 0;
972#if defined(__aarch64__)
973 if ((prop != nullptr) && prop->IsBTICompatible()) {
974 prot |= PROT_BTI;
975 }
976#endif
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700977 return _phdr_table_set_load_prot(phdr_table, phdr_count, load_bias, prot, should_pad_segments);
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000978}
979
980/* Change the protection of all loaded segments in memory to writable.
981 * This is useful before performing relocations. Once completed, you
982 * will have to call phdr_table_protect_segments to restore the original
983 * protection flags on all segments.
984 *
985 * Note that some writable segments can also have their content turned
986 * to read-only by calling phdr_table_protect_gnu_relro. This is no
987 * performed here.
988 *
989 * Input:
990 * phdr_table -> program header table
991 * phdr_count -> number of entries in tables
992 * load_bias -> load bias
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700993 * should_pad_segments -> Are segments extended to avoid gaps in the memory map
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000994 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +0000995 * 0 on success, -1 on failure (error code in errno).
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000996 */
997int phdr_table_unprotect_segments(const ElfW(Phdr)* phdr_table,
Kalesh Singh4b4fb6f2023-10-18 22:19:41 -0700998 size_t phdr_count, ElfW(Addr) load_bias,
999 bool should_pad_segments) {
1000 return _phdr_table_set_load_prot(phdr_table, phdr_count, load_bias, PROT_WRITE,
1001 should_pad_segments);
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +00001002}
1003
Kalesh Singh33f89702023-10-24 12:47:16 -07001004static inline void _extend_gnu_relro_prot_end(const ElfW(Phdr)* relro_phdr,
1005 const ElfW(Phdr)* phdr_table, size_t phdr_count,
1006 ElfW(Addr) load_bias, ElfW(Addr)* seg_page_end) {
1007 // Find the index and phdr of the LOAD containing the GNU_RELRO segment
1008 for (size_t index = 0; index < phdr_count; ++index) {
1009 const ElfW(Phdr)* phdr = &phdr_table[index];
1010
1011 if (phdr->p_type == PT_LOAD && phdr->p_vaddr == relro_phdr->p_vaddr) {
1012 // If the PT_GNU_RELRO mem size is not at least as large as the corresponding
1013 // LOAD segment mem size, we need to protect only a partial region of the
1014 // LOAD segment and therefore cannot avoid a VMA split.
1015 if (relro_phdr->p_memsz < phdr->p_memsz) {
1016 break;
1017 }
1018
1019 ElfW(Addr) p_memsz = phdr->p_memsz;
1020 ElfW(Addr) p_filesz = phdr->p_filesz;
1021
1022 // Attempt extending the VMA (mprotect range). Without extending the range
1023 // mprotect will only RO protect a part of the extend RW LOAD segment, which will
1024 // leave an extra split RW VMA (the gap).
1025 _extend_load_segment_vma(phdr_table, phdr_count, index, &p_memsz, &p_filesz);
1026
1027 *seg_page_end = page_end(phdr->p_vaddr + p_memsz + load_bias);
1028
1029 break;
1030 }
1031 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001032}
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001033
1034/* Used internally by phdr_table_protect_gnu_relro and
1035 * phdr_table_unprotect_gnu_relro.
1036 */
1037static int _phdr_table_set_gnu_relro_prot(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Kalesh Singh33f89702023-10-24 12:47:16 -07001038 ElfW(Addr) load_bias, int prot_flags,
1039 bool should_pad_segments) {
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001040 const ElfW(Phdr)* phdr = phdr_table;
1041 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
1042
1043 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
1044 if (phdr->p_type != PT_GNU_RELRO) {
1045 continue;
1046 }
1047
1048 // Tricky: what happens when the relro segment does not start
1049 // or end at page boundaries? We're going to be over-protective
1050 // here and put every page touched by the segment as read-only.
1051
1052 // This seems to match Ian Lance Taylor's description of the
1053 // feature at http://www.airs.com/blog/archives/189.
1054
1055 // Extract:
1056 // Note that the current dynamic linker code will only work
1057 // correctly if the PT_GNU_RELRO segment starts on a page
1058 // boundary. This is because the dynamic linker rounds the
1059 // p_vaddr field down to the previous page boundary. If
1060 // there is anything on the page which should not be read-only,
1061 // the program is likely to fail at runtime. So in effect the
1062 // linker must only emit a PT_GNU_RELRO segment if it ensures
1063 // that it starts on a page boundary.
Kalesh Singh33f89702023-10-24 12:47:16 -07001064 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr + load_bias);
1065 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz + load_bias);
1066
1067 // Before extending the RO protection, we need to ensure that the segments were extended
1068 // by bionic, because the kernel won't map gaps so it usually contains unrelated
1069 // mappings which will be incorrectly protected as RO likely leading to
1070 // segmentation fault.
1071 if (phdr->p_align > kPageSize && should_pad_segments) {
1072 _extend_gnu_relro_prot_end(phdr, phdr_table, phdr_count, load_bias, &seg_page_end);
1073 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001074
1075 int ret = mprotect(reinterpret_cast<void*>(seg_page_start),
1076 seg_page_end - seg_page_start,
1077 prot_flags);
1078 if (ret < 0) {
1079 return -1;
1080 }
1081 }
1082 return 0;
1083}
1084
1085/* Apply GNU relro protection if specified by the program header. This will
1086 * turn some of the pages of a writable PT_LOAD segment to read-only, as
1087 * specified by one or more PT_GNU_RELRO segments. This must be always
1088 * performed after relocations.
1089 *
1090 * The areas typically covered are .got and .data.rel.ro, these are
1091 * read-only from the program's POV, but contain absolute addresses
1092 * that need to be relocated before use.
1093 *
1094 * Input:
1095 * phdr_table -> program header table
1096 * phdr_count -> number of entries in tables
1097 * load_bias -> load bias
Kalesh Singh33f89702023-10-24 12:47:16 -07001098 * should_pad_segments -> Were segments extended to avoid gaps in the memory map
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001099 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001100 * 0 on success, -1 on failure (error code in errno).
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001101 */
Kalesh Singh33f89702023-10-24 12:47:16 -07001102int phdr_table_protect_gnu_relro(const ElfW(Phdr)* phdr_table, size_t phdr_count,
1103 ElfW(Addr) load_bias, bool should_pad_segments) {
1104 return _phdr_table_set_gnu_relro_prot(phdr_table, phdr_count, load_bias, PROT_READ,
1105 should_pad_segments);
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001106}
1107
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001108/* Serialize the GNU relro segments to the given file descriptor. This can be
1109 * performed after relocations to allow another process to later share the
1110 * relocated segment, if it was loaded at the same address.
1111 *
1112 * Input:
1113 * phdr_table -> program header table
1114 * phdr_count -> number of entries in tables
1115 * load_bias -> load bias
1116 * fd -> writable file descriptor to use
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001117 * file_offset -> pointer to offset into file descriptor to use/update
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001118 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001119 * 0 on success, -1 on failure (error code in errno).
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001120 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001121int phdr_table_serialize_gnu_relro(const ElfW(Phdr)* phdr_table,
1122 size_t phdr_count,
1123 ElfW(Addr) load_bias,
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001124 int fd,
1125 size_t* file_offset) {
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001126 const ElfW(Phdr)* phdr = phdr_table;
1127 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001128
1129 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
1130 if (phdr->p_type != PT_GNU_RELRO) {
1131 continue;
1132 }
1133
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001134 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr) + load_bias;
1135 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001136 ssize_t size = seg_page_end - seg_page_start;
1137
1138 ssize_t written = TEMP_FAILURE_RETRY(write(fd, reinterpret_cast<void*>(seg_page_start), size));
1139 if (written != size) {
1140 return -1;
1141 }
1142 void* map = mmap(reinterpret_cast<void*>(seg_page_start), size, PROT_READ,
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001143 MAP_PRIVATE|MAP_FIXED, fd, *file_offset);
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001144 if (map == MAP_FAILED) {
1145 return -1;
1146 }
Torne (Richard Coles)fa9f7f22019-04-02 17:04:42 -04001147 *file_offset += size;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001148 }
1149 return 0;
1150}
1151
1152/* Where possible, replace the GNU relro segments with mappings of the given
1153 * file descriptor. This can be performed after relocations to allow a file
1154 * previously created by phdr_table_serialize_gnu_relro in another process to
1155 * replace the dirty relocated pages, saving memory, if it was loaded at the
1156 * same address. We have to compare the data before we map over it, since some
1157 * parts of the relro segment may not be identical due to other libraries in
1158 * the process being loaded at different addresses.
1159 *
1160 * Input:
1161 * phdr_table -> program header table
1162 * phdr_count -> number of entries in tables
1163 * load_bias -> load bias
1164 * fd -> readable file descriptor to use
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001165 * file_offset -> pointer to offset into file descriptor to use/update
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001166 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001167 * 0 on success, -1 on failure (error code in errno).
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001168 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001169int phdr_table_map_gnu_relro(const ElfW(Phdr)* phdr_table,
1170 size_t phdr_count,
1171 ElfW(Addr) load_bias,
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001172 int fd,
1173 size_t* file_offset) {
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001174 // Map the file at a temporary location so we can compare its contents.
1175 struct stat file_stat;
1176 if (TEMP_FAILURE_RETRY(fstat(fd, &file_stat)) != 0) {
1177 return -1;
1178 }
1179 off_t file_size = file_stat.st_size;
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001180 void* temp_mapping = nullptr;
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +01001181 if (file_size > 0) {
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001182 temp_mapping = mmap(nullptr, file_size, PROT_READ, MAP_PRIVATE, fd, 0);
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +01001183 if (temp_mapping == MAP_FAILED) {
1184 return -1;
1185 }
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001186 }
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001187
1188 // Iterate over the relro segments and compare/remap the pages.
1189 const ElfW(Phdr)* phdr = phdr_table;
1190 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
1191
1192 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
1193 if (phdr->p_type != PT_GNU_RELRO) {
1194 continue;
1195 }
1196
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001197 ElfW(Addr) seg_page_start = page_start(phdr->p_vaddr) + load_bias;
1198 ElfW(Addr) seg_page_end = page_end(phdr->p_vaddr + phdr->p_memsz) + load_bias;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001199
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001200 char* file_base = static_cast<char*>(temp_mapping) + *file_offset;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001201 char* mem_base = reinterpret_cast<char*>(seg_page_start);
1202 size_t match_offset = 0;
1203 size_t size = seg_page_end - seg_page_start;
1204
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001205 if (file_size - *file_offset < size) {
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +01001206 // File is too short to compare to this segment. The contents are likely
1207 // different as well (it's probably for a different library version) so
1208 // just don't bother checking.
1209 break;
1210 }
1211
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001212 while (match_offset < size) {
1213 // Skip over dissimilar pages.
1214 while (match_offset < size &&
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001215 memcmp(mem_base + match_offset, file_base + match_offset, page_size()) != 0) {
1216 match_offset += page_size();
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001217 }
1218
1219 // Count similar pages.
1220 size_t mismatch_offset = match_offset;
1221 while (mismatch_offset < size &&
Peter Collingbournebb11ee62022-05-02 12:26:16 -07001222 memcmp(mem_base + mismatch_offset, file_base + mismatch_offset, page_size()) == 0) {
1223 mismatch_offset += page_size();
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001224 }
1225
1226 // Map over similar pages.
1227 if (mismatch_offset > match_offset) {
1228 void* map = mmap(mem_base + match_offset, mismatch_offset - match_offset,
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001229 PROT_READ, MAP_PRIVATE|MAP_FIXED, fd, *file_offset + match_offset);
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001230 if (map == MAP_FAILED) {
1231 munmap(temp_mapping, file_size);
1232 return -1;
1233 }
1234 }
1235
1236 match_offset = mismatch_offset;
1237 }
1238
1239 // Add to the base file offset in case there are multiple relro segments.
Torne (Richard Coles)efbe9a52018-10-17 15:59:38 -04001240 *file_offset += size;
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +00001241 }
1242 munmap(temp_mapping, file_size);
1243 return 0;
1244}
1245
1246
Elliott Hughes4eeb1f12013-10-25 17:38:02 -07001247#if defined(__arm__)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001248
1249# ifndef PT_ARM_EXIDX
1250# define PT_ARM_EXIDX 0x70000001 /* .ARM.exidx segment */
1251# endif
1252
1253/* Return the address and size of the .ARM.exidx section in memory,
1254 * if present.
1255 *
1256 * Input:
1257 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -07001258 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001259 * load_bias -> load bias
1260 * Output:
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001261 * arm_exidx -> address of table in memory (null on failure).
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001262 * arm_exidx_count -> number of items in table (0 on failure).
1263 * Return:
Mitch Phillips117e45e2023-10-20 13:32:33 +00001264 * 0 on success, -1 on failure (_no_ error code in errno)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001265 */
Elliott Hughes0266ae52014-02-10 17:46:57 -08001266int phdr_table_get_arm_exidx(const ElfW(Phdr)* phdr_table, size_t phdr_count,
1267 ElfW(Addr) load_bias,
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -08001268 ElfW(Addr)** arm_exidx, size_t* arm_exidx_count) {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001269 const ElfW(Phdr)* phdr = phdr_table;
1270 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001271
Elliott Hughes0266ae52014-02-10 17:46:57 -08001272 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
1273 if (phdr->p_type != PT_ARM_EXIDX) {
1274 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001275 }
Elliott Hughes0266ae52014-02-10 17:46:57 -08001276
1277 *arm_exidx = reinterpret_cast<ElfW(Addr)*>(load_bias + phdr->p_vaddr);
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -08001278 *arm_exidx_count = phdr->p_memsz / 8;
Elliott Hughes0266ae52014-02-10 17:46:57 -08001279 return 0;
1280 }
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001281 *arm_exidx = nullptr;
Elliott Hughes0266ae52014-02-10 17:46:57 -08001282 *arm_exidx_count = 0;
1283 return -1;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001284}
Elliott Hughes4eeb1f12013-10-25 17:38:02 -07001285#endif
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001286
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +02001287/* Return the address and size of the ELF file's .dynamic section in memory,
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001288 * or null if missing.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001289 *
1290 * Input:
1291 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -07001292 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001293 * load_bias -> load bias
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +02001294 * Output:
Dmitriy Ivanov851135b2014-08-29 12:02:36 -07001295 * dynamic -> address of table in memory (null on failure).
Ningsheng Jiane93be992014-09-16 15:22:10 +08001296 * dynamic_flags -> protection flags for section (unset on failure)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001297 * Return:
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +02001298 * void
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001299 */
Elliott Hughes0266ae52014-02-10 17:46:57 -08001300void phdr_table_get_dynamic_section(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Ningsheng Jiane93be992014-09-16 15:22:10 +08001301 ElfW(Addr) load_bias, ElfW(Dyn)** dynamic,
1302 ElfW(Word)* dynamic_flags) {
Dmitriy Ivanov498eb182014-09-05 14:57:59 -07001303 *dynamic = nullptr;
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001304 for (size_t i = 0; i<phdr_count; ++i) {
1305 const ElfW(Phdr)& phdr = phdr_table[i];
1306 if (phdr.p_type == PT_DYNAMIC) {
1307 *dynamic = reinterpret_cast<ElfW(Dyn)*>(load_bias + phdr.p_vaddr);
Ningsheng Jiane93be992014-09-16 15:22:10 +08001308 if (dynamic_flags) {
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -07001309 *dynamic_flags = phdr.p_flags;
Ningsheng Jiane93be992014-09-16 15:22:10 +08001310 }
Dmitriy Ivanov14669a92014-09-05 16:42:53 -07001311 return;
1312 }
Elliott Hughes0266ae52014-02-10 17:46:57 -08001313 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001314}
1315
Evgenii Stepanovd640b222015-07-10 17:54:01 -07001316/* Return the program interpreter string, or nullptr if missing.
1317 *
1318 * Input:
1319 * phdr_table -> program header table
1320 * phdr_count -> number of entries in tables
1321 * load_bias -> load bias
1322 * Return:
1323 * pointer to the program interpreter string.
1324 */
Tamas Petz8d55d182020-02-24 14:15:25 +01001325const char* phdr_table_get_interpreter_name(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Evgenii Stepanovd640b222015-07-10 17:54:01 -07001326 ElfW(Addr) load_bias) {
1327 for (size_t i = 0; i<phdr_count; ++i) {
1328 const ElfW(Phdr)& phdr = phdr_table[i];
1329 if (phdr.p_type == PT_INTERP) {
1330 return reinterpret_cast<const char*>(load_bias + phdr.p_vaddr);
1331 }
1332 }
1333 return nullptr;
1334}
1335
Robert Grosse4544d9f2014-10-15 14:32:19 -07001336// Sets loaded_phdr_ to the address of the program header table as it appears
1337// in the loaded segments in memory. This is in contrast with phdr_table_,
1338// which is temporary and will be released before the library is relocated.
Elliott Hughes650be4e2013-03-05 18:47:58 -08001339bool ElfReader::FindPhdr() {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001340 const ElfW(Phdr)* phdr_limit = phdr_table_ + phdr_num_;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001341
Elliott Hughes650be4e2013-03-05 18:47:58 -08001342 // If there is a PT_PHDR, use it directly.
Elliott Hughes0266ae52014-02-10 17:46:57 -08001343 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -08001344 if (phdr->p_type == PT_PHDR) {
1345 return CheckPhdr(load_bias_ + phdr->p_vaddr);
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001346 }
Elliott Hughes650be4e2013-03-05 18:47:58 -08001347 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001348
Elliott Hughes650be4e2013-03-05 18:47:58 -08001349 // Otherwise, check the first loadable segment. If its file offset
1350 // is 0, it starts with the ELF header, and we can trivially find the
1351 // loaded program header from it.
Elliott Hughes0266ae52014-02-10 17:46:57 -08001352 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -08001353 if (phdr->p_type == PT_LOAD) {
1354 if (phdr->p_offset == 0) {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001355 ElfW(Addr) elf_addr = load_bias_ + phdr->p_vaddr;
Elliott Hughesfaf05ba2014-02-11 16:59:37 -08001356 const ElfW(Ehdr)* ehdr = reinterpret_cast<const ElfW(Ehdr)*>(elf_addr);
Elliott Hughes0266ae52014-02-10 17:46:57 -08001357 ElfW(Addr) offset = ehdr->e_phoff;
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -08001358 return CheckPhdr(reinterpret_cast<ElfW(Addr)>(ehdr) + offset);
Elliott Hughes650be4e2013-03-05 18:47:58 -08001359 }
1360 break;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001361 }
Elliott Hughes650be4e2013-03-05 18:47:58 -08001362 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001363
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -07001364 DL_ERR("can't find loaded phdr for \"%s\"", name_.c_str());
Elliott Hughes650be4e2013-03-05 18:47:58 -08001365 return false;
1366}
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001367
Tamas Petz8d55d182020-02-24 14:15:25 +01001368// Tries to find .note.gnu.property section.
1369// It is not considered an error if such section is missing.
1370bool ElfReader::FindGnuPropertySection() {
1371#if defined(__aarch64__)
1372 note_gnu_property_ = GnuPropertySection(phdr_table_, phdr_num_, load_start(), name_.c_str());
1373#endif
1374 return true;
1375}
1376
Elliott Hughes650be4e2013-03-05 18:47:58 -08001377// Ensures that our program header is actually within a loadable
1378// segment. This should help catch badly-formed ELF files that
1379// would cause the linker to crash later when trying to access it.
Elliott Hughes0266ae52014-02-10 17:46:57 -08001380bool ElfReader::CheckPhdr(ElfW(Addr) loaded) {
1381 const ElfW(Phdr)* phdr_limit = phdr_table_ + phdr_num_;
1382 ElfW(Addr) loaded_end = loaded + (phdr_num_ * sizeof(ElfW(Phdr)));
Dmitriy Ivanovcf1cbbe2015-10-19 16:57:46 -07001383 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -08001384 if (phdr->p_type != PT_LOAD) {
1385 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001386 }
Elliott Hughes0266ae52014-02-10 17:46:57 -08001387 ElfW(Addr) seg_start = phdr->p_vaddr + load_bias_;
1388 ElfW(Addr) seg_end = phdr->p_filesz + seg_start;
Elliott Hughes650be4e2013-03-05 18:47:58 -08001389 if (seg_start <= loaded && loaded_end <= seg_end) {
Elliott Hughes0266ae52014-02-10 17:46:57 -08001390 loaded_phdr_ = reinterpret_cast<const ElfW(Phdr)*>(loaded);
Elliott Hughes650be4e2013-03-05 18:47:58 -08001391 return true;
1392 }
1393 }
Dmitriy Ivanov4f7a7ad2015-10-15 12:07:25 -07001394 DL_ERR("\"%s\" loaded phdr %p not in loadable segment",
1395 name_.c_str(), reinterpret_cast<void*>(loaded));
Elliott Hughes650be4e2013-03-05 18:47:58 -08001396 return false;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +02001397}