blob: 4b85469fdf55ae79da874f328f38dbe8570b71eb [file] [log] [blame]
Brian Carlstrom27ec9612011-09-19 20:20:38 -07001/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "mem_map.h"
18
Christopher Ferris943af7d2014-01-16 12:41:46 -080019#include <backtrace/BacktraceMap.h>
Ian Rogersc7dd2952014-10-21 23:31:19 -070020#include <inttypes.h>
21
Ian Rogers700a4022014-05-19 16:49:03 -070022#include <memory>
Ian Rogersc7dd2952014-10-21 23:31:19 -070023#include <sstream>
Elliott Hughesecd3a6f2012-06-06 18:16:37 -070024
Andreas Gamped8f26db2014-05-19 17:01:13 -070025// See CreateStartPos below.
26#ifdef __BIONIC__
27#include <sys/auxv.h>
28#endif
29
Elliott Hughese222ee02012-12-13 14:41:43 -080030#include "base/stringprintf.h"
Andreas Gampe277ccbd2014-11-03 21:36:10 -080031
32#pragma GCC diagnostic push
33#pragma GCC diagnostic ignored "-Wshadow"
Elliott Hughese222ee02012-12-13 14:41:43 -080034#include "ScopedFd.h"
Andreas Gampe277ccbd2014-11-03 21:36:10 -080035#pragma GCC diagnostic pop
36
Ian Rogersc7dd2952014-10-21 23:31:19 -070037#include "thread-inl.h"
Elliott Hughese222ee02012-12-13 14:41:43 -080038#include "utils.h"
39
Elliott Hughes6c9c06d2011-11-07 16:43:47 -080040#define USE_ASHMEM 1
41
42#ifdef USE_ASHMEM
43#include <cutils/ashmem.h>
Ian Rogers997f0f92014-06-21 22:58:05 -070044#ifndef ANDROID_OS
45#include <sys/resource.h>
46#endif
Elliott Hughes6c9c06d2011-11-07 16:43:47 -080047#endif
48
Ian Rogersd6b68652014-06-23 14:07:03 -070049#ifndef MAP_ANONYMOUS
50#define MAP_ANONYMOUS MAP_ANON
51#endif
52
Brian Carlstrom27ec9612011-09-19 20:20:38 -070053namespace art {
54
Christopher Ferris943af7d2014-01-16 12:41:46 -080055static std::ostream& operator<<(
56 std::ostream& os,
57 std::pair<BacktraceMap::const_iterator, BacktraceMap::const_iterator> iters) {
58 for (BacktraceMap::const_iterator it = iters.first; it != iters.second; ++it) {
59 os << StringPrintf("0x%08x-0x%08x %c%c%c %s\n",
60 static_cast<uint32_t>(it->start),
61 static_cast<uint32_t>(it->end),
62 (it->flags & PROT_READ) ? 'r' : '-',
63 (it->flags & PROT_WRITE) ? 'w' : '-',
64 (it->flags & PROT_EXEC) ? 'x' : '-', it->name.c_str());
Elliott Hughesecd3a6f2012-06-06 18:16:37 -070065 }
66 return os;
Brian Carlstrom27ec9612011-09-19 20:20:38 -070067}
68
Mathieu Chartierbad02672014-08-25 13:08:22 -070069std::ostream& operator<<(std::ostream& os, const MemMap::Maps& mem_maps) {
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -070070 os << "MemMap:" << std::endl;
71 for (auto it = mem_maps.begin(); it != mem_maps.end(); ++it) {
72 void* base = it->first;
73 MemMap* map = it->second;
74 CHECK_EQ(base, map->BaseBegin());
75 os << *map << std::endl;
76 }
77 return os;
78}
79
Mathieu Chartier6e88ef62014-10-14 15:01:24 -070080MemMap::Maps* MemMap::maps_ = nullptr;
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -070081
Ian Rogersc3ccc102014-06-25 11:52:14 -070082#if USE_ART_LOW_4G_ALLOCATOR
Andreas Gamped8f26db2014-05-19 17:01:13 -070083// Handling mem_map in 32b address range for 64b architectures that do not support MAP_32BIT.
84
85// The regular start of memory allocations. The first 64KB is protected by SELinux.
Andreas Gampe6bd621a2014-05-16 17:28:58 -070086static constexpr uintptr_t LOW_MEM_START = 64 * KB;
Andreas Gampe7104cbf2014-03-21 11:44:43 -070087
Andreas Gamped8f26db2014-05-19 17:01:13 -070088// Generate random starting position.
89// To not interfere with image position, take the image's address and only place it below. Current
90// formula (sketch):
91//
92// ART_BASE_ADDR = 0001XXXXXXXXXXXXXXX
93// ----------------------------------------
94// = 0000111111111111111
95// & ~(kPageSize - 1) =~0000000000000001111
96// ----------------------------------------
97// mask = 0000111111111110000
98// & random data = YYYYYYYYYYYYYYYYYYY
99// -----------------------------------
100// tmp = 0000YYYYYYYYYYY0000
101// + LOW_MEM_START = 0000000000001000000
102// --------------------------------------
103// start
104//
105// getauxval as an entropy source is exposed in Bionic, but not in glibc before 2.16. When we
106// do not have Bionic, simply start with LOW_MEM_START.
107
108// Function is standalone so it can be tested somewhat in mem_map_test.cc.
109#ifdef __BIONIC__
110uintptr_t CreateStartPos(uint64_t input) {
111 CHECK_NE(0, ART_BASE_ADDRESS);
112
113 // Start with all bits below highest bit in ART_BASE_ADDRESS.
114 constexpr size_t leading_zeros = CLZ(static_cast<uint32_t>(ART_BASE_ADDRESS));
115 constexpr uintptr_t mask_ones = (1 << (31 - leading_zeros)) - 1;
116
117 // Lowest (usually 12) bits are not used, as aligned by page size.
118 constexpr uintptr_t mask = mask_ones & ~(kPageSize - 1);
119
120 // Mask input data.
121 return (input & mask) + LOW_MEM_START;
122}
123#endif
124
125static uintptr_t GenerateNextMemPos() {
126#ifdef __BIONIC__
127 uint8_t* random_data = reinterpret_cast<uint8_t*>(getauxval(AT_RANDOM));
128 // The lower 8B are taken for the stack guard. Use the upper 8B (with mask).
129 return CreateStartPos(*reinterpret_cast<uintptr_t*>(random_data + 8));
130#else
131 // No auxv on host, see above.
132 return LOW_MEM_START;
133#endif
134}
135
136// Initialize linear scan to random position.
137uintptr_t MemMap::next_mem_pos_ = GenerateNextMemPos();
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000138#endif
139
Jim_Guoa62a5882014-04-28 11:11:57 +0800140// Return true if the address range is contained in a single /proc/self/map entry.
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100141static bool ContainedWithinExistingMap(uintptr_t begin,
142 uintptr_t end,
143 std::string* error_msg) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800144 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid(), true));
Christopher Ferris836572a2014-08-05 15:43:13 -0700145 if (map.get() == nullptr) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800146 *error_msg = StringPrintf("Failed to build process map");
147 return false;
148 }
149 for (BacktraceMap::const_iterator it = map->begin(); it != map->end(); ++it) {
150 if ((begin >= it->start && begin < it->end) // start of new within old
151 && (end > it->start && end <= it->end)) { // end of new within old
152 return true;
153 }
154 }
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800155 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
Jim_Guoa62a5882014-04-28 11:11:57 +0800156 *error_msg = StringPrintf("Requested region 0x%08" PRIxPTR "-0x%08" PRIxPTR " does not overlap "
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800157 "any existing map. See process maps in the log.", begin, end);
Jim_Guoa62a5882014-04-28 11:11:57 +0800158 return false;
159}
160
161// Return true if the address range does not conflict with any /proc/self/maps entry.
162static bool CheckNonOverlapping(uintptr_t begin,
163 uintptr_t end,
164 std::string* error_msg) {
165 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid(), true));
Christopher Ferris836572a2014-08-05 15:43:13 -0700166 if (map.get() == nullptr) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800167 *error_msg = StringPrintf("Failed to build process map");
168 return false;
169 }
170 for (BacktraceMap::const_iterator it = map->begin(); it != map->end(); ++it) {
171 if ((begin >= it->start && begin < it->end) // start of new within old
172 || (end > it->start && end < it->end) // end of new within old
173 || (begin <= it->start && end > it->end)) { // start/end of new includes all of old
174 std::ostringstream map_info;
175 map_info << std::make_pair(it, map->end());
176 *error_msg = StringPrintf("Requested region 0x%08" PRIxPTR "-0x%08" PRIxPTR " overlaps with "
177 "existing map 0x%08" PRIxPTR "-0x%08" PRIxPTR " (%s)\n%s",
178 begin, end,
179 static_cast<uintptr_t>(it->start), static_cast<uintptr_t>(it->end),
180 it->name.c_str(),
181 map_info.str().c_str());
182 return false;
183 }
184 }
185 return true;
186}
187
188// CheckMapRequest to validate a non-MAP_FAILED mmap result based on
189// the expected value, calling munmap if validation fails, giving the
190// reason in error_msg.
191//
192// If the expected_ptr is nullptr, nothing is checked beyond the fact
193// that the actual_ptr is not MAP_FAILED. However, if expected_ptr is
194// non-null, we check that pointer is the actual_ptr == expected_ptr,
195// and if not, report in error_msg what the conflict mapping was if
196// found, or a generic error in other cases.
Ian Rogers13735952014-10-08 12:43:28 -0700197static bool CheckMapRequest(uint8_t* expected_ptr, void* actual_ptr, size_t byte_count,
Jim_Guoa62a5882014-04-28 11:11:57 +0800198 std::string* error_msg) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700199 // Handled first by caller for more specific error messages.
200 CHECK(actual_ptr != MAP_FAILED);
201
202 if (expected_ptr == nullptr) {
203 return true;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700204 }
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700205
Jim_Guoa62a5882014-04-28 11:11:57 +0800206 uintptr_t actual = reinterpret_cast<uintptr_t>(actual_ptr);
207 uintptr_t expected = reinterpret_cast<uintptr_t>(expected_ptr);
208 uintptr_t limit = expected + byte_count;
209
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700210 if (expected_ptr == actual_ptr) {
211 return true;
212 }
213
214 // We asked for an address but didn't get what we wanted, all paths below here should fail.
215 int result = munmap(actual_ptr, byte_count);
216 if (result == -1) {
217 PLOG(WARNING) << StringPrintf("munmap(%p, %zd) failed", actual_ptr, byte_count);
218 }
219
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100220 // We call this here so that we can try and generate a full error
221 // message with the overlapping mapping. There's no guarantee that
222 // that there will be an overlap though, since
223 // - The kernel is not *required* to honour expected_ptr unless MAP_FIXED is
224 // true, even if there is no overlap
225 // - There might have been an overlap at the point of mmap, but the
226 // overlapping region has since been unmapped.
227 std::string error_detail;
228 CheckNonOverlapping(expected, limit, &error_detail);
229
230 std::ostringstream os;
231 os << StringPrintf("Failed to mmap at expected address, mapped at "
232 "0x%08" PRIxPTR " instead of 0x%08" PRIxPTR,
233 actual, expected);
234 if (!error_detail.empty()) {
235 os << " : " << error_detail;
Christopher Ferris943af7d2014-01-16 12:41:46 -0800236 }
Jim_Guoa62a5882014-04-28 11:11:57 +0800237
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100238 *error_msg = os.str();
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700239 return false;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700240}
241
Ian Rogers13735952014-10-08 12:43:28 -0700242MemMap* MemMap::MapAnonymous(const char* name, uint8_t* expected_ptr, size_t byte_count, int prot,
Ian Rogersef7d42f2014-01-06 12:55:46 -0800243 bool low_4gb, std::string* error_msg) {
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700244#ifndef __LP64__
245 UNUSED(low_4gb);
246#endif
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700247 if (byte_count == 0) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800248 return new MemMap(name, nullptr, 0, nullptr, 0, prot, false);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700249 }
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700250 size_t page_aligned_byte_count = RoundUp(byte_count, kPageSize);
Elliott Hughes6c9c06d2011-11-07 16:43:47 -0800251
Elliott Hughes6c9c06d2011-11-07 16:43:47 -0800252 int flags = MAP_PRIVATE | MAP_ANONYMOUS;
Ian Rogers997f0f92014-06-21 22:58:05 -0700253 ScopedFd fd(-1);
254
255#ifdef USE_ASHMEM
256#ifdef HAVE_ANDROID_OS
257 const bool use_ashmem = true;
258#else
259 // When not on Android ashmem is faked using files in /tmp. Ensure that such files won't
260 // fail due to ulimit restrictions. If they will then use a regular mmap.
261 struct rlimit rlimit_fsize;
262 CHECK_EQ(getrlimit(RLIMIT_FSIZE, &rlimit_fsize), 0);
263 const bool use_ashmem = (rlimit_fsize.rlim_cur == RLIM_INFINITY) ||
264 (page_aligned_byte_count < rlimit_fsize.rlim_cur);
265#endif
266 if (use_ashmem) {
267 // android_os_Debug.cpp read_mapinfo assumes all ashmem regions associated with the VM are
268 // prefixed "dalvik-".
269 std::string debug_friendly_name("dalvik-");
270 debug_friendly_name += name;
271 fd.reset(ashmem_create_region(debug_friendly_name.c_str(), page_aligned_byte_count));
272 if (fd.get() == -1) {
273 *error_msg = StringPrintf("ashmem_create_region failed for '%s': %s", name, strerror(errno));
274 return nullptr;
275 }
276 flags = MAP_PRIVATE;
277 }
Elliott Hughes6c9c06d2011-11-07 16:43:47 -0800278#endif
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000279
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700280 // We need to store and potentially set an error number for pretty printing of errors
281 int saved_errno = 0;
282
Qiming Shi84d49cc2014-04-24 15:38:41 +0800283#ifdef __LP64__
284 // When requesting low_4g memory and having an expectation, the requested range should fit into
285 // 4GB.
286 if (low_4gb && (
287 // Start out of bounds.
Jim_Guoa62a5882014-04-28 11:11:57 +0800288 (reinterpret_cast<uintptr_t>(expected_ptr) >> 32) != 0 ||
Qiming Shi84d49cc2014-04-24 15:38:41 +0800289 // End out of bounds. For simplicity, this will fail for the last page of memory.
Jim_Guoa62a5882014-04-28 11:11:57 +0800290 (reinterpret_cast<uintptr_t>(expected_ptr + page_aligned_byte_count) >> 32) != 0)) {
Qiming Shi84d49cc2014-04-24 15:38:41 +0800291 *error_msg = StringPrintf("The requested address space (%p, %p) cannot fit in low_4gb",
Jim_Guoa62a5882014-04-28 11:11:57 +0800292 expected_ptr, expected_ptr + page_aligned_byte_count);
Qiming Shi84d49cc2014-04-24 15:38:41 +0800293 return nullptr;
294 }
295#endif
296
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000297 // TODO:
298 // A page allocator would be a useful abstraction here, as
299 // 1) It is doubtful that MAP_32BIT on x86_64 is doing the right job for us
300 // 2) The linear scheme, even with simple saving of the last known position, is very crude
Ian Rogersc3ccc102014-06-25 11:52:14 -0700301#if USE_ART_LOW_4G_ALLOCATOR
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000302 // MAP_32BIT only available on x86_64.
303 void* actual = MAP_FAILED;
Jim_Guoa62a5882014-04-28 11:11:57 +0800304 if (low_4gb && expected_ptr == nullptr) {
Andreas Gampe7104cbf2014-03-21 11:44:43 -0700305 bool first_run = true;
306
Andreas Gampe71a3eba2014-03-17 12:57:08 -0700307 for (uintptr_t ptr = next_mem_pos_; ptr < 4 * GB; ptr += kPageSize) {
Andreas Gampe7104cbf2014-03-21 11:44:43 -0700308 if (4U * GB - ptr < page_aligned_byte_count) {
309 // Not enough memory until 4GB.
310 if (first_run) {
311 // Try another time from the bottom;
Andreas Gampe9de65ff2014-03-21 17:25:57 -0700312 ptr = LOW_MEM_START - kPageSize;
Andreas Gampe7104cbf2014-03-21 11:44:43 -0700313 first_run = false;
314 continue;
315 } else {
316 // Second try failed.
317 break;
318 }
319 }
320
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000321 uintptr_t tail_ptr;
322
323 // Check pages are free.
324 bool safe = true;
325 for (tail_ptr = ptr; tail_ptr < ptr + page_aligned_byte_count; tail_ptr += kPageSize) {
326 if (msync(reinterpret_cast<void*>(tail_ptr), kPageSize, 0) == 0) {
327 safe = false;
328 break;
329 } else {
330 DCHECK_EQ(errno, ENOMEM);
331 }
332 }
333
334 next_mem_pos_ = tail_ptr; // update early, as we break out when we found and mapped a region
335
336 if (safe == true) {
337 actual = mmap(reinterpret_cast<void*>(ptr), page_aligned_byte_count, prot, flags, fd.get(),
338 0);
339 if (actual != MAP_FAILED) {
Mathieu Chartierc355a2a2014-05-30 13:02:46 -0700340 // Since we didn't use MAP_FIXED the kernel may have mapped it somewhere not in the low
341 // 4GB. If this is the case, unmap and retry.
342 if (reinterpret_cast<uintptr_t>(actual) + page_aligned_byte_count < 4 * GB) {
343 break;
344 } else {
345 munmap(actual, page_aligned_byte_count);
346 actual = MAP_FAILED;
347 }
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000348 }
349 } else {
350 // Skip over last page.
351 ptr = tail_ptr;
352 }
353 }
354
355 if (actual == MAP_FAILED) {
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700356 LOG(ERROR) << "Could not find contiguous low-memory space.";
357 saved_errno = ENOMEM;
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000358 }
359 } else {
Jim_Guoa62a5882014-04-28 11:11:57 +0800360 actual = mmap(expected_ptr, page_aligned_byte_count, prot, flags, fd.get(), 0);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700361 saved_errno = errno;
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000362 }
363
364#else
Ian Rogersc3ccc102014-06-25 11:52:14 -0700365#if defined(__LP64__)
Jim_Guoa62a5882014-04-28 11:11:57 +0800366 if (low_4gb && expected_ptr == nullptr) {
Ian Rogersef7d42f2014-01-06 12:55:46 -0800367 flags |= MAP_32BIT;
368 }
369#endif
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700370
Jim_Guoa62a5882014-04-28 11:11:57 +0800371 void* actual = mmap(expected_ptr, page_aligned_byte_count, prot, flags, fd.get(), 0);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700372 saved_errno = errno;
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000373#endif
374
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700375 if (actual == MAP_FAILED) {
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800376 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700377
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800378 *error_msg = StringPrintf("Failed anonymous mmap(%p, %zd, 0x%x, 0x%x, %d, 0): %s. See process "
379 "maps in the log.", expected_ptr, page_aligned_byte_count, prot,
380 flags, fd.get(), strerror(saved_errno));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700381 return nullptr;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700382 }
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700383 std::ostringstream check_map_request_error_msg;
Jim_Guoa62a5882014-04-28 11:11:57 +0800384 if (!CheckMapRequest(expected_ptr, actual, page_aligned_byte_count, error_msg)) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700385 return nullptr;
386 }
Ian Rogers13735952014-10-08 12:43:28 -0700387 return new MemMap(name, reinterpret_cast<uint8_t*>(actual), byte_count, actual,
Jim_Guoa62a5882014-04-28 11:11:57 +0800388 page_aligned_byte_count, prot, false);
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700389}
390
Ian Rogers13735952014-10-08 12:43:28 -0700391MemMap* MemMap::MapFileAtAddress(uint8_t* expected_ptr, size_t byte_count, int prot, int flags, int fd,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700392 off_t start, bool reuse, const char* filename,
393 std::string* error_msg) {
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700394 CHECK_NE(0, prot);
395 CHECK_NE(0, flags & (MAP_SHARED | MAP_PRIVATE));
Jim_Guoa62a5882014-04-28 11:11:57 +0800396 uintptr_t expected = reinterpret_cast<uintptr_t>(expected_ptr);
397 uintptr_t limit = expected + byte_count;
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100398
399 // Note that we do not allow MAP_FIXED unless reuse == true, i.e we
400 // expect his mapping to be contained within an existing map.
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700401 if (reuse) {
402 // reuse means it is okay that it overlaps an existing page mapping.
403 // Only use this if you actually made the page reservation yourself.
Jim_Guoa62a5882014-04-28 11:11:57 +0800404 CHECK(expected_ptr != nullptr);
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100405
406 DCHECK(ContainedWithinExistingMap(expected, limit, error_msg));
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700407 flags |= MAP_FIXED;
408 } else {
409 CHECK_EQ(0, flags & MAP_FIXED);
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100410 // Don't bother checking for an overlapping region here. We'll
411 // check this if required after the fact inside CheckMapRequest.
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700412 }
413
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700414 if (byte_count == 0) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800415 return new MemMap(filename, nullptr, 0, nullptr, 0, prot, false);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700416 }
Ian Rogersf8adc602013-04-18 17:06:19 -0700417 // Adjust 'offset' to be page-aligned as required by mmap.
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700418 int page_offset = start % kPageSize;
419 off_t page_aligned_offset = start - page_offset;
Ian Rogersf8adc602013-04-18 17:06:19 -0700420 // Adjust 'byte_count' to be page-aligned as we will map this anyway.
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700421 size_t page_aligned_byte_count = RoundUp(byte_count + page_offset, kPageSize);
Jim_Guoa62a5882014-04-28 11:11:57 +0800422 // The 'expected_ptr' is modified (if specified, ie non-null) to be page aligned to the file but
423 // not necessarily to virtual memory. mmap will page align 'expected' for us.
Ian Rogers13735952014-10-08 12:43:28 -0700424 uint8_t* page_aligned_expected = (expected_ptr == nullptr) ? nullptr : (expected_ptr - page_offset);
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700425
Ian Rogers13735952014-10-08 12:43:28 -0700426 uint8_t* actual = reinterpret_cast<uint8_t*>(mmap(page_aligned_expected,
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700427 page_aligned_byte_count,
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700428 prot,
429 flags,
430 fd,
431 page_aligned_offset));
432 if (actual == MAP_FAILED) {
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700433 auto saved_errno = errno;
434
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800435 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700436
Mathieu Chartierc7cb1902014-03-05 14:41:03 -0800437 *error_msg = StringPrintf("mmap(%p, %zd, 0x%x, 0x%x, %d, %" PRId64
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800438 ") of file '%s' failed: %s. See process maps in the log.",
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700439 page_aligned_expected, page_aligned_byte_count, prot, flags, fd,
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700440 static_cast<int64_t>(page_aligned_offset), filename,
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800441 strerror(saved_errno));
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700442 return nullptr;
443 }
444 std::ostringstream check_map_request_error_msg;
Jim_Guoa62a5882014-04-28 11:11:57 +0800445 if (!CheckMapRequest(expected_ptr, actual, page_aligned_byte_count, error_msg)) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700446 return nullptr;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700447 }
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800448 return new MemMap(filename, actual + page_offset, byte_count, actual, page_aligned_byte_count,
Jim_Guoa62a5882014-04-28 11:11:57 +0800449 prot, reuse);
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700450}
451
452MemMap::~MemMap() {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700453 if (base_begin_ == nullptr && base_size_ == 0) {
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700454 return;
455 }
Jim_Guoa62a5882014-04-28 11:11:57 +0800456 if (!reuse_) {
457 int result = munmap(base_begin_, base_size_);
458 if (result == -1) {
459 PLOG(FATAL) << "munmap failed";
460 }
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700461 }
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700462
463 // Remove it from maps_.
464 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
465 bool found = false;
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700466 DCHECK(maps_ != nullptr);
467 for (auto it = maps_->lower_bound(base_begin_), end = maps_->end();
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700468 it != end && it->first == base_begin_; ++it) {
469 if (it->second == this) {
470 found = true;
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700471 maps_->erase(it);
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700472 break;
473 }
474 }
475 CHECK(found) << "MemMap not found";
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700476}
477
Ian Rogers13735952014-10-08 12:43:28 -0700478MemMap::MemMap(const std::string& name, uint8_t* begin, size_t size, void* base_begin,
Jim_Guoa62a5882014-04-28 11:11:57 +0800479 size_t base_size, int prot, bool reuse)
Mathieu Chartier1c23e1e2012-10-12 14:14:11 -0700480 : name_(name), begin_(begin), size_(size), base_begin_(base_begin), base_size_(base_size),
Jim_Guoa62a5882014-04-28 11:11:57 +0800481 prot_(prot), reuse_(reuse) {
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700482 if (size_ == 0) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700483 CHECK(begin_ == nullptr);
484 CHECK(base_begin_ == nullptr);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700485 CHECK_EQ(base_size_, 0U);
486 } else {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700487 CHECK(begin_ != nullptr);
488 CHECK(base_begin_ != nullptr);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700489 CHECK_NE(base_size_, 0U);
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700490
491 // Add it to maps_.
492 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700493 DCHECK(maps_ != nullptr);
494 maps_->insert(std::make_pair(base_begin_, this));
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700495 }
Andreas Gampec8ccf682014-09-29 20:07:43 -0700496}
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700497
Ian Rogers13735952014-10-08 12:43:28 -0700498MemMap* MemMap::RemapAtEnd(uint8_t* new_end, const char* tail_name, int tail_prot,
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700499 std::string* error_msg) {
Mathieu Chartiercc236d72012-07-20 10:29:05 -0700500 DCHECK_GE(new_end, Begin());
501 DCHECK_LE(new_end, End());
Ian Rogers13735952014-10-08 12:43:28 -0700502 DCHECK_LE(begin_ + size_, reinterpret_cast<uint8_t*>(base_begin_) + base_size_);
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700503 DCHECK(IsAligned<kPageSize>(begin_));
504 DCHECK(IsAligned<kPageSize>(base_begin_));
Ian Rogers13735952014-10-08 12:43:28 -0700505 DCHECK(IsAligned<kPageSize>(reinterpret_cast<uint8_t*>(base_begin_) + base_size_));
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700506 DCHECK(IsAligned<kPageSize>(new_end));
Ian Rogers13735952014-10-08 12:43:28 -0700507 uint8_t* old_end = begin_ + size_;
508 uint8_t* old_base_end = reinterpret_cast<uint8_t*>(base_begin_) + base_size_;
509 uint8_t* new_base_end = new_end;
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700510 DCHECK_LE(new_base_end, old_base_end);
511 if (new_base_end == old_base_end) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800512 return new MemMap(tail_name, nullptr, 0, nullptr, 0, tail_prot, false);
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700513 }
Ian Rogers13735952014-10-08 12:43:28 -0700514 size_ = new_end - reinterpret_cast<uint8_t*>(begin_);
515 base_size_ = new_base_end - reinterpret_cast<uint8_t*>(base_begin_);
516 DCHECK_LE(begin_ + size_, reinterpret_cast<uint8_t*>(base_begin_) + base_size_);
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700517 size_t tail_size = old_end - new_end;
Ian Rogers13735952014-10-08 12:43:28 -0700518 uint8_t* tail_base_begin = new_base_end;
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700519 size_t tail_base_size = old_base_end - new_base_end;
520 DCHECK_EQ(tail_base_begin + tail_base_size, old_base_end);
521 DCHECK(IsAligned<kPageSize>(tail_base_size));
522
523#ifdef USE_ASHMEM
524 // android_os_Debug.cpp read_mapinfo assumes all ashmem regions associated with the VM are
525 // prefixed "dalvik-".
526 std::string debug_friendly_name("dalvik-");
527 debug_friendly_name += tail_name;
528 ScopedFd fd(ashmem_create_region(debug_friendly_name.c_str(), tail_base_size));
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000529 int flags = MAP_PRIVATE | MAP_FIXED;
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700530 if (fd.get() == -1) {
531 *error_msg = StringPrintf("ashmem_create_region failed for '%s': %s",
532 tail_name, strerror(errno));
533 return nullptr;
534 }
535#else
536 ScopedFd fd(-1);
537 int flags = MAP_PRIVATE | MAP_ANONYMOUS;
538#endif
539
540 // Unmap/map the tail region.
541 int result = munmap(tail_base_begin, tail_base_size);
542 if (result == -1) {
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800543 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
544 *error_msg = StringPrintf("munmap(%p, %zd) failed for '%s'. See process maps in the log.",
545 tail_base_begin, tail_base_size, name_.c_str());
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700546 return nullptr;
547 }
548 // Don't cause memory allocation between the munmap and the mmap
549 // calls. Otherwise, libc (or something else) might take this memory
550 // region. Note this isn't perfect as there's no way to prevent
551 // other threads to try to take this memory region here.
Ian Rogers13735952014-10-08 12:43:28 -0700552 uint8_t* actual = reinterpret_cast<uint8_t*>(mmap(tail_base_begin, tail_base_size, tail_prot,
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700553 flags, fd.get(), 0));
554 if (actual == MAP_FAILED) {
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800555 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
556 *error_msg = StringPrintf("anonymous mmap(%p, %zd, 0x%x, 0x%x, %d, 0) failed. See process "
557 "maps in the log.", tail_base_begin, tail_base_size, tail_prot, flags,
558 fd.get());
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700559 return nullptr;
560 }
Jim_Guoa62a5882014-04-28 11:11:57 +0800561 return new MemMap(tail_name, actual, tail_size, actual, tail_base_size, tail_prot, false);
Mathieu Chartiercc236d72012-07-20 10:29:05 -0700562}
Logan Chiend88fa262012-06-06 15:23:32 +0800563
Ian Rogersc5f17732014-06-05 20:48:42 -0700564void MemMap::MadviseDontNeedAndZero() {
565 if (base_begin_ != nullptr || base_size_ != 0) {
566 if (!kMadviseZeroes) {
567 memset(base_begin_, 0, base_size_);
568 }
569 int result = madvise(base_begin_, base_size_, MADV_DONTNEED);
570 if (result == -1) {
571 PLOG(WARNING) << "madvise failed";
572 }
573 }
574}
575
Logan Chiend88fa262012-06-06 15:23:32 +0800576bool MemMap::Protect(int prot) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700577 if (base_begin_ == nullptr && base_size_ == 0) {
Ian Rogers1c849e52012-06-28 14:00:33 -0700578 prot_ = prot;
Logan Chiend88fa262012-06-06 15:23:32 +0800579 return true;
580 }
581
582 if (mprotect(base_begin_, base_size_, prot) == 0) {
Ian Rogers1c849e52012-06-28 14:00:33 -0700583 prot_ = prot;
Logan Chiend88fa262012-06-06 15:23:32 +0800584 return true;
585 }
586
Shih-wei Liaoa060ed92012-06-07 09:25:28 -0700587 PLOG(ERROR) << "mprotect(" << reinterpret_cast<void*>(base_begin_) << ", " << base_size_ << ", "
588 << prot << ") failed";
Logan Chiend88fa262012-06-06 15:23:32 +0800589 return false;
590}
591
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700592bool MemMap::CheckNoGaps(MemMap* begin_map, MemMap* end_map) {
593 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
594 CHECK(begin_map != nullptr);
595 CHECK(end_map != nullptr);
596 CHECK(HasMemMap(begin_map));
597 CHECK(HasMemMap(end_map));
598 CHECK_LE(begin_map->BaseBegin(), end_map->BaseBegin());
599 MemMap* map = begin_map;
600 while (map->BaseBegin() != end_map->BaseBegin()) {
601 MemMap* next_map = GetLargestMemMapAt(map->BaseEnd());
602 if (next_map == nullptr) {
603 // Found a gap.
604 return false;
605 }
606 map = next_map;
607 }
608 return true;
609}
610
611void MemMap::DumpMaps(std::ostream& os) {
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700612 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
Mathieu Chartierbad02672014-08-25 13:08:22 -0700613 DumpMapsLocked(os);
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700614}
615
Mathieu Chartierbad02672014-08-25 13:08:22 -0700616void MemMap::DumpMapsLocked(std::ostream& os) {
617 os << maps_;
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700618}
619
620bool MemMap::HasMemMap(MemMap* map) {
621 void* base_begin = map->BaseBegin();
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700622 for (auto it = maps_->lower_bound(base_begin), end = maps_->end();
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700623 it != end && it->first == base_begin; ++it) {
624 if (it->second == map) {
625 return true;
626 }
627 }
628 return false;
629}
630
631MemMap* MemMap::GetLargestMemMapAt(void* address) {
632 size_t largest_size = 0;
633 MemMap* largest_map = nullptr;
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700634 DCHECK(maps_ != nullptr);
635 for (auto it = maps_->lower_bound(address), end = maps_->end();
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700636 it != end && it->first == address; ++it) {
637 MemMap* map = it->second;
638 CHECK(map != nullptr);
639 if (largest_size < map->BaseSize()) {
640 largest_size = map->BaseSize();
641 largest_map = map;
642 }
643 }
644 return largest_map;
645}
646
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700647void MemMap::Init() {
648 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
649 if (maps_ == nullptr) {
650 // dex2oat calls MemMap::Init twice since its needed before the runtime is created.
651 maps_ = new Maps;
652 }
653}
654
655void MemMap::Shutdown() {
656 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
657 delete maps_;
658 maps_ = nullptr;
659}
660
Mathieu Chartier379d09f2015-01-08 11:28:13 -0800661void MemMap::SetSize(size_t new_size) {
662 if (new_size == base_size_) {
663 return;
664 }
665 CHECK_ALIGNED(new_size, kPageSize);
666 CHECK_EQ(base_size_, size_) << "Unsupported";
667 CHECK_LE(new_size, base_size_);
668 CHECK_EQ(munmap(reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(BaseBegin()) + new_size),
669 base_size_ - new_size), 0) << new_size << " " << base_size_;
670 base_size_ = new_size;
671 size_ = new_size;
672}
673
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800674std::ostream& operator<<(std::ostream& os, const MemMap& mem_map) {
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700675 os << StringPrintf("[MemMap: %p-%p prot=0x%x %s]",
676 mem_map.BaseBegin(), mem_map.BaseEnd(), mem_map.GetProtect(),
677 mem_map.GetName().c_str());
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800678 return os;
679}
680
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700681} // namespace art