blob: 638c9d6babb1f889c1fb8a7e36e2ab390ac689a7 [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>
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +000034#include <sys/types.h>
35#include <sys/stat.h>
36#include <unistd.h>
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020037
Elliott Hughes650be4e2013-03-05 18:47:58 -080038#include "linker.h"
39#include "linker_debug.h"
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020040
Elliott Hughesb5140262014-12-02 16:16:29 -080041static int GetTargetElfMachine() {
42#if defined(__arm__)
43 return EM_ARM;
44#elif defined(__aarch64__)
45 return EM_AARCH64;
46#elif defined(__i386__)
47 return EM_386;
48#elif defined(__mips__)
49 return EM_MIPS;
50#elif defined(__x86_64__)
51 return EM_X86_64;
52#endif
53}
54
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020055/**
56 TECHNICAL NOTE ON ELF LOADING.
57
58 An ELF file's program header table contains one or more PT_LOAD
59 segments, which corresponds to portions of the file that need to
60 be mapped into the process' address space.
61
62 Each loadable segment has the following important properties:
63
64 p_offset -> segment file offset
65 p_filesz -> segment file size
66 p_memsz -> segment memory size (always >= p_filesz)
67 p_vaddr -> segment's virtual address
68 p_flags -> segment flags (e.g. readable, writable, executable)
69
Elliott Hughes0266ae52014-02-10 17:46:57 -080070 We will ignore the p_paddr and p_align fields of ElfW(Phdr) for now.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +020071
72 The loadable segments can be seen as a list of [p_vaddr ... p_vaddr+p_memsz)
73 ranges of virtual addresses. A few rules apply:
74
75 - the virtual address ranges should not overlap.
76
77 - if a segment's p_filesz is smaller than its p_memsz, the extra bytes
78 between them should always be initialized to 0.
79
80 - ranges do not necessarily start or end at page boundaries. Two distinct
81 segments can have their start and end on the same page. In this case, the
82 page inherits the mapping flags of the latter segment.
83
84 Finally, the real load addrs of each segment is not p_vaddr. Instead the
85 loader decides where to load the first segment, then will load all others
86 relative to the first one to respect the initial range layout.
87
88 For example, consider the following list:
89
90 [ offset:0, filesz:0x4000, memsz:0x4000, vaddr:0x30000 ],
91 [ offset:0x4000, filesz:0x2000, memsz:0x8000, vaddr:0x40000 ],
92
93 This corresponds to two segments that cover these virtual address ranges:
94
95 0x30000...0x34000
96 0x40000...0x48000
97
98 If the loader decides to load the first segment at address 0xa0000000
99 then the segments' load address ranges will be:
100
101 0xa0030000...0xa0034000
102 0xa0040000...0xa0048000
103
104 In other words, all segments must be loaded at an address that has the same
105 constant offset from their p_vaddr value. This offset is computed as the
106 difference between the first segment's load address, and its p_vaddr value.
107
108 However, in practice, segments do _not_ start at page boundaries. Since we
109 can only memory-map at page boundaries, this means that the bias is
110 computed as:
111
112 load_bias = phdr0_load_address - PAGE_START(phdr0->p_vaddr)
113
114 (NOTE: The value must be used as a 32-bit unsigned integer, to deal with
115 possible wrap around UINT32_MAX for possible large p_vaddr values).
116
117 And that the phdr0_load_address must start at a page boundary, with
118 the segment's real content starting at:
119
120 phdr0_load_address + PAGE_OFFSET(phdr0->p_vaddr)
121
122 Note that ELF requires the following condition to make the mmap()-ing work:
123
124 PAGE_OFFSET(phdr0->p_vaddr) == PAGE_OFFSET(phdr0->p_offset)
125
126 The load_bias must be added to any p_vaddr value read from the ELF file to
127 determine the corresponding memory address.
128
129 **/
130
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800131#define MAYBE_MAP_FLAG(x, from, to) (((x) & (from)) ? (to) : 0)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200132#define PFLAGS_TO_PROT(x) (MAYBE_MAP_FLAG((x), PF_X, PROT_EXEC) | \
133 MAYBE_MAP_FLAG((x), PF_R, PROT_READ) | \
134 MAYBE_MAP_FLAG((x), PF_W, PROT_WRITE))
135
Dmitriy Ivanov07e5bc12014-10-03 17:52:44 -0700136ElfReader::ElfReader(const char* name, int fd, off64_t file_offset)
137 : name_(name), fd_(fd), file_offset_(file_offset),
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700138 phdr_num_(0), phdr_mmap_(nullptr), phdr_table_(nullptr), phdr_size_(0),
139 load_start_(nullptr), load_size_(0), load_bias_(0),
140 loaded_phdr_(nullptr) {
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200141}
142
Elliott Hughes650be4e2013-03-05 18:47:58 -0800143ElfReader::~ElfReader() {
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700144 if (phdr_mmap_ != nullptr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800145 munmap(phdr_mmap_, phdr_size_);
146 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200147}
148
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000149bool ElfReader::Load(const android_dlextinfo* extinfo) {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800150 return ReadElfHeader() &&
151 VerifyElfHeader() &&
152 ReadProgramHeader() &&
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000153 ReserveAddressSpace(extinfo) &&
Elliott Hughes650be4e2013-03-05 18:47:58 -0800154 LoadSegments() &&
155 FindPhdr();
156}
157
158bool ElfReader::ReadElfHeader() {
Dmitriy Ivanova6c12792014-10-21 12:09:18 -0700159 ssize_t rc = TEMP_FAILURE_RETRY(pread64(fd_, &header_, sizeof(header_), file_offset_));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800160 if (rc < 0) {
161 DL_ERR("can't read file \"%s\": %s", name_, strerror(errno));
162 return false;
163 }
Dmitriy Ivanova6c12792014-10-21 12:09:18 -0700164
Elliott Hughes650be4e2013-03-05 18:47:58 -0800165 if (rc != sizeof(header_)) {
Elliott Hughesc6200592013-09-30 18:43:46 -0700166 DL_ERR("\"%s\" is too small to be an ELF executable: only found %zd bytes", name_,
167 static_cast<size_t>(rc));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800168 return false;
169 }
170 return true;
171}
172
173bool ElfReader::VerifyElfHeader() {
Elliott Hughes625993d2014-07-15 16:53:13 -0700174 if (memcmp(header_.e_ident, ELFMAG, SELFMAG) != 0) {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800175 DL_ERR("\"%s\" has bad ELF magic", name_);
176 return false;
177 }
178
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700179 // Try to give a clear diagnostic for ELF class mismatches, since they're
180 // an easy mistake to make during the 32-bit/64-bit transition period.
181 int elf_class = header_.e_ident[EI_CLASS];
182#if defined(__LP64__)
183 if (elf_class != ELFCLASS64) {
184 if (elf_class == ELFCLASS32) {
185 DL_ERR("\"%s\" is 32-bit instead of 64-bit", name_);
186 } else {
187 DL_ERR("\"%s\" has unknown ELF class: %d", name_, elf_class);
188 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800189 return false;
190 }
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700191#else
192 if (elf_class != ELFCLASS32) {
193 if (elf_class == ELFCLASS64) {
194 DL_ERR("\"%s\" is 64-bit instead of 32-bit", name_);
195 } else {
196 DL_ERR("\"%s\" has unknown ELF class: %d", name_, elf_class);
197 }
198 return false;
199 }
200#endif
201
Elliott Hughes650be4e2013-03-05 18:47:58 -0800202 if (header_.e_ident[EI_DATA] != ELFDATA2LSB) {
203 DL_ERR("\"%s\" not little-endian: %d", name_, header_.e_ident[EI_DATA]);
204 return false;
205 }
206
207 if (header_.e_type != ET_DYN) {
208 DL_ERR("\"%s\" has unexpected e_type: %d", name_, header_.e_type);
209 return false;
210 }
211
212 if (header_.e_version != EV_CURRENT) {
213 DL_ERR("\"%s\" has unexpected e_version: %d", name_, header_.e_version);
214 return false;
215 }
216
Elliott Hughesb5140262014-12-02 16:16:29 -0800217 if (header_.e_machine != GetTargetElfMachine()) {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800218 DL_ERR("\"%s\" has unexpected e_machine: %d", name_, header_.e_machine);
219 return false;
220 }
221
222 return true;
223}
224
225// Loads the program header table from an ELF file into a read-only private
226// anonymous mmap-ed block.
227bool ElfReader::ReadProgramHeader() {
228 phdr_num_ = header_.e_phnum;
229
230 // Like the kernel, we only accept program header tables that
231 // are smaller than 64KiB.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800232 if (phdr_num_ < 1 || phdr_num_ > 65536/sizeof(ElfW(Phdr))) {
Elliott Hughesc6200592013-09-30 18:43:46 -0700233 DL_ERR("\"%s\" has invalid e_phnum: %zd", name_, phdr_num_);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800234 return false;
235 }
236
Elliott Hughes0266ae52014-02-10 17:46:57 -0800237 ElfW(Addr) page_min = PAGE_START(header_.e_phoff);
238 ElfW(Addr) page_max = PAGE_END(header_.e_phoff + (phdr_num_ * sizeof(ElfW(Phdr))));
239 ElfW(Addr) page_offset = PAGE_OFFSET(header_.e_phoff);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800240
241 phdr_size_ = page_max - page_min;
242
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -0700243 void* mmap_result =
244 mmap64(nullptr, phdr_size_, PROT_READ, MAP_PRIVATE, fd_, file_offset_ + page_min);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800245 if (mmap_result == MAP_FAILED) {
246 DL_ERR("\"%s\" phdr mmap failed: %s", name_, strerror(errno));
247 return false;
248 }
249
250 phdr_mmap_ = mmap_result;
Elliott Hughes0266ae52014-02-10 17:46:57 -0800251 phdr_table_ = reinterpret_cast<ElfW(Phdr)*>(reinterpret_cast<char*>(mmap_result) + page_offset);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800252 return true;
253}
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200254
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800255/* Returns the size of the extent of all the possibly non-contiguous
256 * loadable segments in an ELF program header table. This corresponds
257 * to the page-aligned size in bytes that needs to be reserved in the
258 * process' address space. If there are no loadable segments, 0 is
259 * returned.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200260 *
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700261 * If out_min_vaddr or out_max_vaddr are not null, they will be
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800262 * set to the minimum and maximum addresses of pages to be reserved,
263 * or 0 if there is nothing to load.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200264 */
Elliott Hughes0266ae52014-02-10 17:46:57 -0800265size_t phdr_table_get_load_size(const ElfW(Phdr)* phdr_table, size_t phdr_count,
266 ElfW(Addr)* out_min_vaddr,
267 ElfW(Addr)* out_max_vaddr) {
268 ElfW(Addr) min_vaddr = UINTPTR_MAX;
269 ElfW(Addr) max_vaddr = 0;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200270
Elliott Hughes0266ae52014-02-10 17:46:57 -0800271 bool found_pt_load = false;
272 for (size_t i = 0; i < phdr_count; ++i) {
273 const ElfW(Phdr)* phdr = &phdr_table[i];
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200274
Elliott Hughes0266ae52014-02-10 17:46:57 -0800275 if (phdr->p_type != PT_LOAD) {
276 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200277 }
Elliott Hughes0266ae52014-02-10 17:46:57 -0800278 found_pt_load = true;
279
280 if (phdr->p_vaddr < min_vaddr) {
281 min_vaddr = phdr->p_vaddr;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200282 }
283
Elliott Hughes0266ae52014-02-10 17:46:57 -0800284 if (phdr->p_vaddr + phdr->p_memsz > max_vaddr) {
285 max_vaddr = phdr->p_vaddr + phdr->p_memsz;
286 }
287 }
288 if (!found_pt_load) {
289 min_vaddr = 0;
290 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200291
Elliott Hughes0266ae52014-02-10 17:46:57 -0800292 min_vaddr = PAGE_START(min_vaddr);
293 max_vaddr = PAGE_END(max_vaddr);
294
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700295 if (out_min_vaddr != nullptr) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800296 *out_min_vaddr = min_vaddr;
297 }
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700298 if (out_max_vaddr != nullptr) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800299 *out_max_vaddr = max_vaddr;
300 }
301 return max_vaddr - min_vaddr;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200302}
303
Elliott Hughes650be4e2013-03-05 18:47:58 -0800304// Reserve a virtual address range big enough to hold all loadable
305// segments of a program header table. This is done by creating a
306// private anonymous mmap() with PROT_NONE.
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000307bool ElfReader::ReserveAddressSpace(const android_dlextinfo* extinfo) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800308 ElfW(Addr) min_vaddr;
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800309 load_size_ = phdr_table_get_load_size(phdr_table_, phdr_num_, &min_vaddr);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800310 if (load_size_ == 0) {
311 DL_ERR("\"%s\" has no loadable segments", name_);
312 return false;
313 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200314
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800315 uint8_t* addr = reinterpret_cast<uint8_t*>(min_vaddr);
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000316 void* start;
317 size_t reserved_size = 0;
318 bool reserved_hint = true;
319
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700320 if (extinfo != nullptr) {
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000321 if (extinfo->flags & ANDROID_DLEXT_RESERVED_ADDRESS) {
322 reserved_size = extinfo->reserved_size;
323 reserved_hint = false;
324 } else if (extinfo->flags & ANDROID_DLEXT_RESERVED_ADDRESS_HINT) {
325 reserved_size = extinfo->reserved_size;
326 }
327 }
328
329 if (load_size_ > reserved_size) {
330 if (!reserved_hint) {
331 DL_ERR("reserved address space %zd smaller than %zd bytes needed for \"%s\"",
332 reserved_size - load_size_, load_size_, name_);
333 return false;
334 }
335 int mmap_flags = MAP_PRIVATE | MAP_ANONYMOUS;
Dmitriy Ivanov18a69562015-02-04 16:05:30 -0800336 start = mmap(nullptr, load_size_, PROT_NONE, mmap_flags, -1, 0);
Torne (Richard Coles)12bbb912014-02-06 14:34:21 +0000337 if (start == MAP_FAILED) {
338 DL_ERR("couldn't reserve %zd bytes of address space for \"%s\"", load_size_, name_);
339 return false;
340 }
341 } else {
342 start = extinfo->reserved_addr;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800343 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200344
Elliott Hughes650be4e2013-03-05 18:47:58 -0800345 load_start_ = start;
Brian Carlstrome7dffe12013-01-10 16:39:58 -0800346 load_bias_ = reinterpret_cast<uint8_t*>(start) - addr;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800347 return true;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200348}
349
Elliott Hughes650be4e2013-03-05 18:47:58 -0800350bool ElfReader::LoadSegments() {
351 for (size_t i = 0; i < phdr_num_; ++i) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800352 const ElfW(Phdr)* phdr = &phdr_table_[i];
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200353
Elliott Hughes650be4e2013-03-05 18:47:58 -0800354 if (phdr->p_type != PT_LOAD) {
355 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200356 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800357
358 // Segment addresses in memory.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800359 ElfW(Addr) seg_start = phdr->p_vaddr + load_bias_;
360 ElfW(Addr) seg_end = seg_start + phdr->p_memsz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800361
Elliott Hughes0266ae52014-02-10 17:46:57 -0800362 ElfW(Addr) seg_page_start = PAGE_START(seg_start);
363 ElfW(Addr) seg_page_end = PAGE_END(seg_end);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800364
Elliott Hughes0266ae52014-02-10 17:46:57 -0800365 ElfW(Addr) seg_file_end = seg_start + phdr->p_filesz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800366
367 // File offsets.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800368 ElfW(Addr) file_start = phdr->p_offset;
369 ElfW(Addr) file_end = file_start + phdr->p_filesz;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800370
Elliott Hughes0266ae52014-02-10 17:46:57 -0800371 ElfW(Addr) file_page_start = PAGE_START(file_start);
372 ElfW(Addr) file_length = file_end - file_page_start;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800373
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700374 if (file_length != 0) {
Dmitriy Ivanov07e5bc12014-10-03 17:52:44 -0700375 void* seg_addr = mmap64(reinterpret_cast<void*>(seg_page_start),
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700376 file_length,
377 PFLAGS_TO_PROT(phdr->p_flags),
378 MAP_FIXED|MAP_PRIVATE,
379 fd_,
Dmitriy Ivanov07e5bc12014-10-03 17:52:44 -0700380 file_offset_ + file_page_start);
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700381 if (seg_addr == MAP_FAILED) {
Elliott Hughesc6200592013-09-30 18:43:46 -0700382 DL_ERR("couldn't map \"%s\" segment %zd: %s", name_, i, strerror(errno));
Brian Carlstrom82dcc792013-05-21 16:49:24 -0700383 return false;
384 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800385 }
386
387 // if the segment is writable, and does not end on a page boundary,
388 // zero-fill it until the page limit.
389 if ((phdr->p_flags & PF_W) != 0 && PAGE_OFFSET(seg_file_end) > 0) {
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800390 memset(reinterpret_cast<void*>(seg_file_end), 0, PAGE_SIZE - PAGE_OFFSET(seg_file_end));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800391 }
392
393 seg_file_end = PAGE_END(seg_file_end);
394
395 // seg_file_end is now the first page address after the file
396 // content. If seg_end is larger, we need to zero anything
397 // between them. This is done by using a private anonymous
398 // map for all extra pages.
399 if (seg_page_end > seg_file_end) {
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800400 void* zeromap = mmap(reinterpret_cast<void*>(seg_file_end),
Elliott Hughes650be4e2013-03-05 18:47:58 -0800401 seg_page_end - seg_file_end,
402 PFLAGS_TO_PROT(phdr->p_flags),
403 MAP_FIXED|MAP_ANONYMOUS|MAP_PRIVATE,
404 -1,
405 0);
406 if (zeromap == MAP_FAILED) {
407 DL_ERR("couldn't zero fill \"%s\" gap: %s", name_, strerror(errno));
408 return false;
409 }
410 }
411 }
412 return true;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200413}
414
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000415/* Used internally. Used to set the protection bits of all loaded segments
416 * with optional extra flags (i.e. really PROT_WRITE). Used by
417 * phdr_table_protect_segments and phdr_table_unprotect_segments.
418 */
419static int _phdr_table_set_load_prot(const ElfW(Phdr)* phdr_table, size_t phdr_count,
420 ElfW(Addr) load_bias, int extra_prot_flags) {
421 const ElfW(Phdr)* phdr = phdr_table;
422 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
423
424 for (; phdr < phdr_limit; phdr++) {
425 if (phdr->p_type != PT_LOAD || (phdr->p_flags & PF_W) != 0) {
426 continue;
427 }
428
429 ElfW(Addr) seg_page_start = PAGE_START(phdr->p_vaddr) + load_bias;
430 ElfW(Addr) seg_page_end = PAGE_END(phdr->p_vaddr + phdr->p_memsz) + load_bias;
431
Nick Kralevich8fdb3412015-04-01 16:57:50 -0700432 int prot = PFLAGS_TO_PROT(phdr->p_flags);
433 if ((extra_prot_flags & PROT_WRITE) != 0) {
434 // make sure we're never simultaneously writable / executable
435 prot &= ~PROT_EXEC;
436 }
437
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000438 int ret = mprotect(reinterpret_cast<void*>(seg_page_start),
439 seg_page_end - seg_page_start,
Nick Kralevich8fdb3412015-04-01 16:57:50 -0700440 prot | extra_prot_flags);
Dimitry Ivanov56be6ed2015-04-01 21:18:48 +0000441 if (ret < 0) {
442 return -1;
443 }
444 }
445 return 0;
446}
447
448/* Restore the original protection modes for all loadable segments.
449 * You should only call this after phdr_table_unprotect_segments and
450 * applying all relocations.
451 *
452 * Input:
453 * phdr_table -> program header table
454 * phdr_count -> number of entries in tables
455 * load_bias -> load bias
456 * Return:
457 * 0 on error, -1 on failure (error code in errno).
458 */
459int phdr_table_protect_segments(const ElfW(Phdr)* phdr_table,
460 size_t phdr_count, ElfW(Addr) load_bias) {
461 return _phdr_table_set_load_prot(phdr_table, phdr_count, load_bias, 0);
462}
463
464/* Change the protection of all loaded segments in memory to writable.
465 * This is useful before performing relocations. Once completed, you
466 * will have to call phdr_table_protect_segments to restore the original
467 * protection flags on all segments.
468 *
469 * Note that some writable segments can also have their content turned
470 * to read-only by calling phdr_table_protect_gnu_relro. This is no
471 * performed here.
472 *
473 * Input:
474 * phdr_table -> program header table
475 * phdr_count -> number of entries in tables
476 * load_bias -> load bias
477 * Return:
478 * 0 on error, -1 on failure (error code in errno).
479 */
480int phdr_table_unprotect_segments(const ElfW(Phdr)* phdr_table,
481 size_t phdr_count, ElfW(Addr) load_bias) {
482 return _phdr_table_set_load_prot(phdr_table, phdr_count, load_bias, PROT_WRITE);
483}
484
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200485/* Used internally by phdr_table_protect_gnu_relro and
486 * phdr_table_unprotect_gnu_relro.
487 */
Elliott Hughes0266ae52014-02-10 17:46:57 -0800488static int _phdr_table_set_gnu_relro_prot(const ElfW(Phdr)* phdr_table, size_t phdr_count,
489 ElfW(Addr) load_bias, int prot_flags) {
490 const ElfW(Phdr)* phdr = phdr_table;
491 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200492
Elliott Hughes0266ae52014-02-10 17:46:57 -0800493 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
494 if (phdr->p_type != PT_GNU_RELRO) {
495 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200496 }
Elliott Hughes0266ae52014-02-10 17:46:57 -0800497
498 // Tricky: what happens when the relro segment does not start
499 // or end at page boundaries? We're going to be over-protective
500 // here and put every page touched by the segment as read-only.
501
502 // This seems to match Ian Lance Taylor's description of the
503 // feature at http://www.airs.com/blog/archives/189.
504
505 // Extract:
506 // Note that the current dynamic linker code will only work
507 // correctly if the PT_GNU_RELRO segment starts on a page
508 // boundary. This is because the dynamic linker rounds the
509 // p_vaddr field down to the previous page boundary. If
510 // there is anything on the page which should not be read-only,
511 // the program is likely to fail at runtime. So in effect the
512 // linker must only emit a PT_GNU_RELRO segment if it ensures
513 // that it starts on a page boundary.
514 ElfW(Addr) seg_page_start = PAGE_START(phdr->p_vaddr) + load_bias;
515 ElfW(Addr) seg_page_end = PAGE_END(phdr->p_vaddr + phdr->p_memsz) + load_bias;
516
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800517 int ret = mprotect(reinterpret_cast<void*>(seg_page_start),
Elliott Hughes0266ae52014-02-10 17:46:57 -0800518 seg_page_end - seg_page_start,
519 prot_flags);
520 if (ret < 0) {
521 return -1;
522 }
523 }
524 return 0;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200525}
526
527/* Apply GNU relro protection if specified by the program header. This will
528 * turn some of the pages of a writable PT_LOAD segment to read-only, as
529 * specified by one or more PT_GNU_RELRO segments. This must be always
530 * performed after relocations.
531 *
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +0200532 * The areas typically covered are .got and .data.rel.ro, these are
533 * read-only from the program's POV, but contain absolute addresses
534 * that need to be relocated before use.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200535 *
536 * Input:
537 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -0700538 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200539 * load_bias -> load bias
540 * Return:
541 * 0 on error, -1 on failure (error code in errno).
542 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -0700543int phdr_table_protect_gnu_relro(const ElfW(Phdr)* phdr_table,
544 size_t phdr_count, ElfW(Addr) load_bias) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800545 return _phdr_table_set_gnu_relro_prot(phdr_table, phdr_count, load_bias, PROT_READ);
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200546}
547
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +0000548/* Serialize the GNU relro segments to the given file descriptor. This can be
549 * performed after relocations to allow another process to later share the
550 * relocated segment, if it was loaded at the same address.
551 *
552 * Input:
553 * phdr_table -> program header table
554 * phdr_count -> number of entries in tables
555 * load_bias -> load bias
556 * fd -> writable file descriptor to use
557 * Return:
558 * 0 on error, -1 on failure (error code in errno).
559 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -0700560int phdr_table_serialize_gnu_relro(const ElfW(Phdr)* phdr_table,
561 size_t phdr_count,
562 ElfW(Addr) load_bias,
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +0000563 int fd) {
564 const ElfW(Phdr)* phdr = phdr_table;
565 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
566 ssize_t file_offset = 0;
567
568 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
569 if (phdr->p_type != PT_GNU_RELRO) {
570 continue;
571 }
572
573 ElfW(Addr) seg_page_start = PAGE_START(phdr->p_vaddr) + load_bias;
574 ElfW(Addr) seg_page_end = PAGE_END(phdr->p_vaddr + phdr->p_memsz) + load_bias;
575 ssize_t size = seg_page_end - seg_page_start;
576
577 ssize_t written = TEMP_FAILURE_RETRY(write(fd, reinterpret_cast<void*>(seg_page_start), size));
578 if (written != size) {
579 return -1;
580 }
581 void* map = mmap(reinterpret_cast<void*>(seg_page_start), size, PROT_READ,
582 MAP_PRIVATE|MAP_FIXED, fd, file_offset);
583 if (map == MAP_FAILED) {
584 return -1;
585 }
586 file_offset += size;
587 }
588 return 0;
589}
590
591/* Where possible, replace the GNU relro segments with mappings of the given
592 * file descriptor. This can be performed after relocations to allow a file
593 * previously created by phdr_table_serialize_gnu_relro in another process to
594 * replace the dirty relocated pages, saving memory, if it was loaded at the
595 * same address. We have to compare the data before we map over it, since some
596 * parts of the relro segment may not be identical due to other libraries in
597 * the process being loaded at different addresses.
598 *
599 * Input:
600 * phdr_table -> program header table
601 * phdr_count -> number of entries in tables
602 * load_bias -> load bias
603 * fd -> readable file descriptor to use
604 * Return:
605 * 0 on error, -1 on failure (error code in errno).
606 */
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -0700607int phdr_table_map_gnu_relro(const ElfW(Phdr)* phdr_table,
608 size_t phdr_count,
609 ElfW(Addr) load_bias,
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +0000610 int fd) {
611 // Map the file at a temporary location so we can compare its contents.
612 struct stat file_stat;
613 if (TEMP_FAILURE_RETRY(fstat(fd, &file_stat)) != 0) {
614 return -1;
615 }
616 off_t file_size = file_stat.st_size;
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700617 void* temp_mapping = nullptr;
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +0100618 if (file_size > 0) {
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700619 temp_mapping = mmap(nullptr, file_size, PROT_READ, MAP_PRIVATE, fd, 0);
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +0100620 if (temp_mapping == MAP_FAILED) {
621 return -1;
622 }
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +0000623 }
624 size_t file_offset = 0;
625
626 // Iterate over the relro segments and compare/remap the pages.
627 const ElfW(Phdr)* phdr = phdr_table;
628 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
629
630 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
631 if (phdr->p_type != PT_GNU_RELRO) {
632 continue;
633 }
634
635 ElfW(Addr) seg_page_start = PAGE_START(phdr->p_vaddr) + load_bias;
636 ElfW(Addr) seg_page_end = PAGE_END(phdr->p_vaddr + phdr->p_memsz) + load_bias;
637
638 char* file_base = static_cast<char*>(temp_mapping) + file_offset;
639 char* mem_base = reinterpret_cast<char*>(seg_page_start);
640 size_t match_offset = 0;
641 size_t size = seg_page_end - seg_page_start;
642
Torne (Richard Coles)26ec9672014-04-30 15:48:40 +0100643 if (file_size - file_offset < size) {
644 // File is too short to compare to this segment. The contents are likely
645 // different as well (it's probably for a different library version) so
646 // just don't bother checking.
647 break;
648 }
649
Torne (Richard Coles)183ad9d2014-02-27 13:18:00 +0000650 while (match_offset < size) {
651 // Skip over dissimilar pages.
652 while (match_offset < size &&
653 memcmp(mem_base + match_offset, file_base + match_offset, PAGE_SIZE) != 0) {
654 match_offset += PAGE_SIZE;
655 }
656
657 // Count similar pages.
658 size_t mismatch_offset = match_offset;
659 while (mismatch_offset < size &&
660 memcmp(mem_base + mismatch_offset, file_base + mismatch_offset, PAGE_SIZE) == 0) {
661 mismatch_offset += PAGE_SIZE;
662 }
663
664 // Map over similar pages.
665 if (mismatch_offset > match_offset) {
666 void* map = mmap(mem_base + match_offset, mismatch_offset - match_offset,
667 PROT_READ, MAP_PRIVATE|MAP_FIXED, fd, match_offset);
668 if (map == MAP_FAILED) {
669 munmap(temp_mapping, file_size);
670 return -1;
671 }
672 }
673
674 match_offset = mismatch_offset;
675 }
676
677 // Add to the base file offset in case there are multiple relro segments.
678 file_offset += size;
679 }
680 munmap(temp_mapping, file_size);
681 return 0;
682}
683
684
Elliott Hughes4eeb1f12013-10-25 17:38:02 -0700685#if defined(__arm__)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200686
687# ifndef PT_ARM_EXIDX
688# define PT_ARM_EXIDX 0x70000001 /* .ARM.exidx segment */
689# endif
690
691/* Return the address and size of the .ARM.exidx section in memory,
692 * if present.
693 *
694 * Input:
695 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -0700696 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200697 * load_bias -> load bias
698 * Output:
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700699 * arm_exidx -> address of table in memory (null on failure).
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200700 * arm_exidx_count -> number of items in table (0 on failure).
701 * Return:
702 * 0 on error, -1 on failure (_no_ error code in errno)
703 */
Elliott Hughes0266ae52014-02-10 17:46:57 -0800704int phdr_table_get_arm_exidx(const ElfW(Phdr)* phdr_table, size_t phdr_count,
705 ElfW(Addr) load_bias,
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -0800706 ElfW(Addr)** arm_exidx, size_t* arm_exidx_count) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800707 const ElfW(Phdr)* phdr = phdr_table;
708 const ElfW(Phdr)* phdr_limit = phdr + phdr_count;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200709
Elliott Hughes0266ae52014-02-10 17:46:57 -0800710 for (phdr = phdr_table; phdr < phdr_limit; phdr++) {
711 if (phdr->p_type != PT_ARM_EXIDX) {
712 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200713 }
Elliott Hughes0266ae52014-02-10 17:46:57 -0800714
715 *arm_exidx = reinterpret_cast<ElfW(Addr)*>(load_bias + phdr->p_vaddr);
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -0800716 *arm_exidx_count = phdr->p_memsz / 8;
Elliott Hughes0266ae52014-02-10 17:46:57 -0800717 return 0;
718 }
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700719 *arm_exidx = nullptr;
Elliott Hughes0266ae52014-02-10 17:46:57 -0800720 *arm_exidx_count = 0;
721 return -1;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200722}
Elliott Hughes4eeb1f12013-10-25 17:38:02 -0700723#endif
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200724
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +0200725/* Return the address and size of the ELF file's .dynamic section in memory,
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700726 * or null if missing.
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200727 *
728 * Input:
729 * phdr_table -> program header table
Elliott Hughes105bc262012-08-15 16:56:00 -0700730 * phdr_count -> number of entries in tables
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200731 * load_bias -> load bias
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +0200732 * Output:
Dmitriy Ivanov851135b2014-08-29 12:02:36 -0700733 * dynamic -> address of table in memory (null on failure).
Ningsheng Jiane93be992014-09-16 15:22:10 +0800734 * dynamic_flags -> protection flags for section (unset on failure)
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200735 * Return:
Ard Biesheuvel12c78bb2012-08-14 12:30:09 +0200736 * void
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200737 */
Elliott Hughes0266ae52014-02-10 17:46:57 -0800738void phdr_table_get_dynamic_section(const ElfW(Phdr)* phdr_table, size_t phdr_count,
Ningsheng Jiane93be992014-09-16 15:22:10 +0800739 ElfW(Addr) load_bias, ElfW(Dyn)** dynamic,
740 ElfW(Word)* dynamic_flags) {
Dmitriy Ivanov498eb182014-09-05 14:57:59 -0700741 *dynamic = nullptr;
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -0700742 for (size_t i = 0; i<phdr_count; ++i) {
743 const ElfW(Phdr)& phdr = phdr_table[i];
744 if (phdr.p_type == PT_DYNAMIC) {
745 *dynamic = reinterpret_cast<ElfW(Dyn)*>(load_bias + phdr.p_vaddr);
Ningsheng Jiane93be992014-09-16 15:22:10 +0800746 if (dynamic_flags) {
Dmitriy Ivanov20d89cb2015-03-30 18:43:38 -0700747 *dynamic_flags = phdr.p_flags;
Ningsheng Jiane93be992014-09-16 15:22:10 +0800748 }
Dmitriy Ivanov14669a92014-09-05 16:42:53 -0700749 return;
750 }
Elliott Hughes0266ae52014-02-10 17:46:57 -0800751 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200752}
753
Robert Grosse4544d9f2014-10-15 14:32:19 -0700754// Sets loaded_phdr_ to the address of the program header table as it appears
755// in the loaded segments in memory. This is in contrast with phdr_table_,
756// which is temporary and will be released before the library is relocated.
Elliott Hughes650be4e2013-03-05 18:47:58 -0800757bool ElfReader::FindPhdr() {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800758 const ElfW(Phdr)* phdr_limit = phdr_table_ + phdr_num_;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200759
Elliott Hughes650be4e2013-03-05 18:47:58 -0800760 // If there is a PT_PHDR, use it directly.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800761 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800762 if (phdr->p_type == PT_PHDR) {
763 return CheckPhdr(load_bias_ + phdr->p_vaddr);
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200764 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800765 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200766
Elliott Hughes650be4e2013-03-05 18:47:58 -0800767 // Otherwise, check the first loadable segment. If its file offset
768 // is 0, it starts with the ELF header, and we can trivially find the
769 // loaded program header from it.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800770 for (const ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800771 if (phdr->p_type == PT_LOAD) {
772 if (phdr->p_offset == 0) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800773 ElfW(Addr) elf_addr = load_bias_ + phdr->p_vaddr;
Elliott Hughesfaf05ba2014-02-11 16:59:37 -0800774 const ElfW(Ehdr)* ehdr = reinterpret_cast<const ElfW(Ehdr)*>(elf_addr);
Elliott Hughes0266ae52014-02-10 17:46:57 -0800775 ElfW(Addr) offset = ehdr->e_phoff;
Dmitriy Ivanov1649e7e2015-01-22 16:04:25 -0800776 return CheckPhdr(reinterpret_cast<ElfW(Addr)>(ehdr) + offset);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800777 }
778 break;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200779 }
Elliott Hughes650be4e2013-03-05 18:47:58 -0800780 }
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200781
Elliott Hughes650be4e2013-03-05 18:47:58 -0800782 DL_ERR("can't find loaded phdr for \"%s\"", name_);
783 return false;
784}
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200785
Elliott Hughes650be4e2013-03-05 18:47:58 -0800786// Ensures that our program header is actually within a loadable
787// segment. This should help catch badly-formed ELF files that
788// would cause the linker to crash later when trying to access it.
Elliott Hughes0266ae52014-02-10 17:46:57 -0800789bool ElfReader::CheckPhdr(ElfW(Addr) loaded) {
790 const ElfW(Phdr)* phdr_limit = phdr_table_ + phdr_num_;
791 ElfW(Addr) loaded_end = loaded + (phdr_num_ * sizeof(ElfW(Phdr)));
792 for (ElfW(Phdr)* phdr = phdr_table_; phdr < phdr_limit; ++phdr) {
Elliott Hughes650be4e2013-03-05 18:47:58 -0800793 if (phdr->p_type != PT_LOAD) {
794 continue;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200795 }
Elliott Hughes0266ae52014-02-10 17:46:57 -0800796 ElfW(Addr) seg_start = phdr->p_vaddr + load_bias_;
797 ElfW(Addr) seg_end = phdr->p_filesz + seg_start;
Elliott Hughes650be4e2013-03-05 18:47:58 -0800798 if (seg_start <= loaded && loaded_end <= seg_end) {
Elliott Hughes0266ae52014-02-10 17:46:57 -0800799 loaded_phdr_ = reinterpret_cast<const ElfW(Phdr)*>(loaded);
Elliott Hughes650be4e2013-03-05 18:47:58 -0800800 return true;
801 }
802 }
Elliott Hughesc00f2cb2013-10-04 17:01:33 -0700803 DL_ERR("\"%s\" loaded phdr %p not in loadable segment", name_, reinterpret_cast<void*>(loaded));
Elliott Hughes650be4e2013-03-05 18:47:58 -0800804 return false;
David 'Digit' Turnerc1bd5592012-06-19 11:21:29 +0200805}