blob: 588615f9d4a704031770862ce10af88bcd028cc3 [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.
Vladimir Marko5c42c292015-02-25 12:02:49 +0000141static bool ContainedWithinExistingMap(uint8_t* ptr, size_t size,
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100142 std::string* error_msg) {
Vladimir Marko5c42c292015-02-25 12:02:49 +0000143 uintptr_t begin = reinterpret_cast<uintptr_t>(ptr);
144 uintptr_t end = begin + size;
Jim_Guoa62a5882014-04-28 11:11:57 +0800145 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid(), true));
Christopher Ferris836572a2014-08-05 15:43:13 -0700146 if (map.get() == nullptr) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800147 *error_msg = StringPrintf("Failed to build process map");
148 return false;
149 }
150 for (BacktraceMap::const_iterator it = map->begin(); it != map->end(); ++it) {
151 if ((begin >= it->start && begin < it->end) // start of new within old
152 && (end > it->start && end <= it->end)) { // end of new within old
153 return true;
154 }
155 }
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800156 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
Jim_Guoa62a5882014-04-28 11:11:57 +0800157 *error_msg = StringPrintf("Requested region 0x%08" PRIxPTR "-0x%08" PRIxPTR " does not overlap "
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800158 "any existing map. See process maps in the log.", begin, end);
Jim_Guoa62a5882014-04-28 11:11:57 +0800159 return false;
160}
161
162// Return true if the address range does not conflict with any /proc/self/maps entry.
163static bool CheckNonOverlapping(uintptr_t begin,
164 uintptr_t end,
165 std::string* error_msg) {
166 std::unique_ptr<BacktraceMap> map(BacktraceMap::Create(getpid(), true));
Christopher Ferris836572a2014-08-05 15:43:13 -0700167 if (map.get() == nullptr) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800168 *error_msg = StringPrintf("Failed to build process map");
169 return false;
170 }
171 for (BacktraceMap::const_iterator it = map->begin(); it != map->end(); ++it) {
172 if ((begin >= it->start && begin < it->end) // start of new within old
173 || (end > it->start && end < it->end) // end of new within old
174 || (begin <= it->start && end > it->end)) { // start/end of new includes all of old
175 std::ostringstream map_info;
176 map_info << std::make_pair(it, map->end());
177 *error_msg = StringPrintf("Requested region 0x%08" PRIxPTR "-0x%08" PRIxPTR " overlaps with "
178 "existing map 0x%08" PRIxPTR "-0x%08" PRIxPTR " (%s)\n%s",
179 begin, end,
180 static_cast<uintptr_t>(it->start), static_cast<uintptr_t>(it->end),
181 it->name.c_str(),
182 map_info.str().c_str());
183 return false;
184 }
185 }
186 return true;
187}
188
189// CheckMapRequest to validate a non-MAP_FAILED mmap result based on
190// the expected value, calling munmap if validation fails, giving the
191// reason in error_msg.
192//
193// If the expected_ptr is nullptr, nothing is checked beyond the fact
194// that the actual_ptr is not MAP_FAILED. However, if expected_ptr is
195// non-null, we check that pointer is the actual_ptr == expected_ptr,
196// and if not, report in error_msg what the conflict mapping was if
197// found, or a generic error in other cases.
Ian Rogers13735952014-10-08 12:43:28 -0700198static bool CheckMapRequest(uint8_t* expected_ptr, void* actual_ptr, size_t byte_count,
Jim_Guoa62a5882014-04-28 11:11:57 +0800199 std::string* error_msg) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700200 // Handled first by caller for more specific error messages.
201 CHECK(actual_ptr != MAP_FAILED);
202
203 if (expected_ptr == nullptr) {
204 return true;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700205 }
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700206
Jim_Guoa62a5882014-04-28 11:11:57 +0800207 uintptr_t actual = reinterpret_cast<uintptr_t>(actual_ptr);
208 uintptr_t expected = reinterpret_cast<uintptr_t>(expected_ptr);
209 uintptr_t limit = expected + byte_count;
210
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700211 if (expected_ptr == actual_ptr) {
212 return true;
213 }
214
215 // We asked for an address but didn't get what we wanted, all paths below here should fail.
216 int result = munmap(actual_ptr, byte_count);
217 if (result == -1) {
218 PLOG(WARNING) << StringPrintf("munmap(%p, %zd) failed", actual_ptr, byte_count);
219 }
220
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100221 // We call this here so that we can try and generate a full error
222 // message with the overlapping mapping. There's no guarantee that
223 // that there will be an overlap though, since
224 // - The kernel is not *required* to honour expected_ptr unless MAP_FIXED is
225 // true, even if there is no overlap
226 // - There might have been an overlap at the point of mmap, but the
227 // overlapping region has since been unmapped.
228 std::string error_detail;
229 CheckNonOverlapping(expected, limit, &error_detail);
230
231 std::ostringstream os;
232 os << StringPrintf("Failed to mmap at expected address, mapped at "
233 "0x%08" PRIxPTR " instead of 0x%08" PRIxPTR,
234 actual, expected);
235 if (!error_detail.empty()) {
236 os << " : " << error_detail;
Christopher Ferris943af7d2014-01-16 12:41:46 -0800237 }
Jim_Guoa62a5882014-04-28 11:11:57 +0800238
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100239 *error_msg = os.str();
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700240 return false;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700241}
242
Ian Rogers13735952014-10-08 12:43:28 -0700243MemMap* MemMap::MapAnonymous(const char* name, uint8_t* expected_ptr, size_t byte_count, int prot,
Vladimir Marko5c42c292015-02-25 12:02:49 +0000244 bool low_4gb, bool reuse, std::string* error_msg) {
Ian Rogers6a3c1fc2014-10-31 00:33:20 -0700245#ifndef __LP64__
246 UNUSED(low_4gb);
247#endif
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700248 if (byte_count == 0) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800249 return new MemMap(name, nullptr, 0, nullptr, 0, prot, false);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700250 }
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700251 size_t page_aligned_byte_count = RoundUp(byte_count, kPageSize);
Elliott Hughes6c9c06d2011-11-07 16:43:47 -0800252
Elliott Hughes6c9c06d2011-11-07 16:43:47 -0800253 int flags = MAP_PRIVATE | MAP_ANONYMOUS;
Vladimir Marko5c42c292015-02-25 12:02:49 +0000254 if (reuse) {
255 // reuse means it is okay that it overlaps an existing page mapping.
256 // Only use this if you actually made the page reservation yourself.
257 CHECK(expected_ptr != nullptr);
258
259 DCHECK(ContainedWithinExistingMap(expected_ptr, byte_count, error_msg)) << error_msg;
260 flags |= MAP_FIXED;
261 }
262
Ian Rogers997f0f92014-06-21 22:58:05 -0700263 ScopedFd fd(-1);
264
265#ifdef USE_ASHMEM
266#ifdef HAVE_ANDROID_OS
267 const bool use_ashmem = true;
268#else
269 // When not on Android ashmem is faked using files in /tmp. Ensure that such files won't
270 // fail due to ulimit restrictions. If they will then use a regular mmap.
271 struct rlimit rlimit_fsize;
272 CHECK_EQ(getrlimit(RLIMIT_FSIZE, &rlimit_fsize), 0);
273 const bool use_ashmem = (rlimit_fsize.rlim_cur == RLIM_INFINITY) ||
274 (page_aligned_byte_count < rlimit_fsize.rlim_cur);
275#endif
276 if (use_ashmem) {
277 // android_os_Debug.cpp read_mapinfo assumes all ashmem regions associated with the VM are
278 // prefixed "dalvik-".
279 std::string debug_friendly_name("dalvik-");
280 debug_friendly_name += name;
281 fd.reset(ashmem_create_region(debug_friendly_name.c_str(), page_aligned_byte_count));
282 if (fd.get() == -1) {
283 *error_msg = StringPrintf("ashmem_create_region failed for '%s': %s", name, strerror(errno));
284 return nullptr;
285 }
Vladimir Marko5c42c292015-02-25 12:02:49 +0000286 flags &= ~MAP_ANONYMOUS;
Ian Rogers997f0f92014-06-21 22:58:05 -0700287 }
Elliott Hughes6c9c06d2011-11-07 16:43:47 -0800288#endif
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000289
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700290 // We need to store and potentially set an error number for pretty printing of errors
291 int saved_errno = 0;
292
Qiming Shi84d49cc2014-04-24 15:38:41 +0800293#ifdef __LP64__
294 // When requesting low_4g memory and having an expectation, the requested range should fit into
295 // 4GB.
296 if (low_4gb && (
297 // Start out of bounds.
Jim_Guoa62a5882014-04-28 11:11:57 +0800298 (reinterpret_cast<uintptr_t>(expected_ptr) >> 32) != 0 ||
Qiming Shi84d49cc2014-04-24 15:38:41 +0800299 // End out of bounds. For simplicity, this will fail for the last page of memory.
Jim_Guoa62a5882014-04-28 11:11:57 +0800300 (reinterpret_cast<uintptr_t>(expected_ptr + page_aligned_byte_count) >> 32) != 0)) {
Qiming Shi84d49cc2014-04-24 15:38:41 +0800301 *error_msg = StringPrintf("The requested address space (%p, %p) cannot fit in low_4gb",
Jim_Guoa62a5882014-04-28 11:11:57 +0800302 expected_ptr, expected_ptr + page_aligned_byte_count);
Qiming Shi84d49cc2014-04-24 15:38:41 +0800303 return nullptr;
304 }
305#endif
306
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000307 // TODO:
308 // A page allocator would be a useful abstraction here, as
309 // 1) It is doubtful that MAP_32BIT on x86_64 is doing the right job for us
310 // 2) The linear scheme, even with simple saving of the last known position, is very crude
Ian Rogersc3ccc102014-06-25 11:52:14 -0700311#if USE_ART_LOW_4G_ALLOCATOR
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000312 // MAP_32BIT only available on x86_64.
313 void* actual = MAP_FAILED;
Jim_Guoa62a5882014-04-28 11:11:57 +0800314 if (low_4gb && expected_ptr == nullptr) {
Andreas Gampe7104cbf2014-03-21 11:44:43 -0700315 bool first_run = true;
316
Andreas Gampe71a3eba2014-03-17 12:57:08 -0700317 for (uintptr_t ptr = next_mem_pos_; ptr < 4 * GB; ptr += kPageSize) {
Andreas Gampe7104cbf2014-03-21 11:44:43 -0700318 if (4U * GB - ptr < page_aligned_byte_count) {
319 // Not enough memory until 4GB.
320 if (first_run) {
321 // Try another time from the bottom;
Andreas Gampe9de65ff2014-03-21 17:25:57 -0700322 ptr = LOW_MEM_START - kPageSize;
Andreas Gampe7104cbf2014-03-21 11:44:43 -0700323 first_run = false;
324 continue;
325 } else {
326 // Second try failed.
327 break;
328 }
329 }
330
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000331 uintptr_t tail_ptr;
332
333 // Check pages are free.
334 bool safe = true;
335 for (tail_ptr = ptr; tail_ptr < ptr + page_aligned_byte_count; tail_ptr += kPageSize) {
336 if (msync(reinterpret_cast<void*>(tail_ptr), kPageSize, 0) == 0) {
337 safe = false;
338 break;
339 } else {
340 DCHECK_EQ(errno, ENOMEM);
341 }
342 }
343
344 next_mem_pos_ = tail_ptr; // update early, as we break out when we found and mapped a region
345
346 if (safe == true) {
347 actual = mmap(reinterpret_cast<void*>(ptr), page_aligned_byte_count, prot, flags, fd.get(),
348 0);
349 if (actual != MAP_FAILED) {
Mathieu Chartierc355a2a2014-05-30 13:02:46 -0700350 // Since we didn't use MAP_FIXED the kernel may have mapped it somewhere not in the low
351 // 4GB. If this is the case, unmap and retry.
352 if (reinterpret_cast<uintptr_t>(actual) + page_aligned_byte_count < 4 * GB) {
353 break;
354 } else {
355 munmap(actual, page_aligned_byte_count);
356 actual = MAP_FAILED;
357 }
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000358 }
359 } else {
360 // Skip over last page.
361 ptr = tail_ptr;
362 }
363 }
364
365 if (actual == MAP_FAILED) {
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700366 LOG(ERROR) << "Could not find contiguous low-memory space.";
367 saved_errno = ENOMEM;
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000368 }
369 } else {
Jim_Guoa62a5882014-04-28 11:11:57 +0800370 actual = mmap(expected_ptr, page_aligned_byte_count, prot, flags, fd.get(), 0);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700371 saved_errno = errno;
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000372 }
373
374#else
Ian Rogersc3ccc102014-06-25 11:52:14 -0700375#if defined(__LP64__)
Jim_Guoa62a5882014-04-28 11:11:57 +0800376 if (low_4gb && expected_ptr == nullptr) {
Ian Rogersef7d42f2014-01-06 12:55:46 -0800377 flags |= MAP_32BIT;
378 }
379#endif
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700380
Jim_Guoa62a5882014-04-28 11:11:57 +0800381 void* actual = mmap(expected_ptr, page_aligned_byte_count, prot, flags, fd.get(), 0);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700382 saved_errno = errno;
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000383#endif
384
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700385 if (actual == MAP_FAILED) {
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800386 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700387
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800388 *error_msg = StringPrintf("Failed anonymous mmap(%p, %zd, 0x%x, 0x%x, %d, 0): %s. See process "
389 "maps in the log.", expected_ptr, page_aligned_byte_count, prot,
390 flags, fd.get(), strerror(saved_errno));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700391 return nullptr;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700392 }
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700393 std::ostringstream check_map_request_error_msg;
Jim_Guoa62a5882014-04-28 11:11:57 +0800394 if (!CheckMapRequest(expected_ptr, actual, page_aligned_byte_count, error_msg)) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700395 return nullptr;
396 }
Ian Rogers13735952014-10-08 12:43:28 -0700397 return new MemMap(name, reinterpret_cast<uint8_t*>(actual), byte_count, actual,
Jim_Guoa62a5882014-04-28 11:11:57 +0800398 page_aligned_byte_count, prot, false);
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700399}
400
Ian Rogers13735952014-10-08 12:43:28 -0700401MemMap* MemMap::MapFileAtAddress(uint8_t* expected_ptr, size_t byte_count, int prot, int flags, int fd,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700402 off_t start, bool reuse, const char* filename,
403 std::string* error_msg) {
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700404 CHECK_NE(0, prot);
405 CHECK_NE(0, flags & (MAP_SHARED | MAP_PRIVATE));
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100406
407 // Note that we do not allow MAP_FIXED unless reuse == true, i.e we
408 // expect his mapping to be contained within an existing map.
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700409 if (reuse) {
410 // reuse means it is okay that it overlaps an existing page mapping.
411 // Only use this if you actually made the page reservation yourself.
Jim_Guoa62a5882014-04-28 11:11:57 +0800412 CHECK(expected_ptr != nullptr);
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100413
Vladimir Marko5c42c292015-02-25 12:02:49 +0000414 DCHECK(ContainedWithinExistingMap(expected_ptr, byte_count, error_msg)) << error_msg;
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700415 flags |= MAP_FIXED;
416 } else {
417 CHECK_EQ(0, flags & MAP_FIXED);
Narayan Kamathb89c3da2014-08-21 17:38:09 +0100418 // Don't bother checking for an overlapping region here. We'll
419 // check this if required after the fact inside CheckMapRequest.
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700420 }
421
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700422 if (byte_count == 0) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800423 return new MemMap(filename, nullptr, 0, nullptr, 0, prot, false);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700424 }
Ian Rogersf8adc602013-04-18 17:06:19 -0700425 // Adjust 'offset' to be page-aligned as required by mmap.
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700426 int page_offset = start % kPageSize;
427 off_t page_aligned_offset = start - page_offset;
Ian Rogersf8adc602013-04-18 17:06:19 -0700428 // Adjust 'byte_count' to be page-aligned as we will map this anyway.
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700429 size_t page_aligned_byte_count = RoundUp(byte_count + page_offset, kPageSize);
Jim_Guoa62a5882014-04-28 11:11:57 +0800430 // The 'expected_ptr' is modified (if specified, ie non-null) to be page aligned to the file but
431 // not necessarily to virtual memory. mmap will page align 'expected' for us.
Ian Rogers13735952014-10-08 12:43:28 -0700432 uint8_t* page_aligned_expected = (expected_ptr == nullptr) ? nullptr : (expected_ptr - page_offset);
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700433
Ian Rogers13735952014-10-08 12:43:28 -0700434 uint8_t* actual = reinterpret_cast<uint8_t*>(mmap(page_aligned_expected,
Elliott Hughesecd3a6f2012-06-06 18:16:37 -0700435 page_aligned_byte_count,
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700436 prot,
437 flags,
438 fd,
439 page_aligned_offset));
440 if (actual == MAP_FAILED) {
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700441 auto saved_errno = errno;
442
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800443 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700444
Mathieu Chartierc7cb1902014-03-05 14:41:03 -0800445 *error_msg = StringPrintf("mmap(%p, %zd, 0x%x, 0x%x, %d, %" PRId64
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800446 ") of file '%s' failed: %s. See process maps in the log.",
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700447 page_aligned_expected, page_aligned_byte_count, prot, flags, fd,
Brian Carlstromaa94cf32014-03-23 23:47:25 -0700448 static_cast<int64_t>(page_aligned_offset), filename,
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800449 strerror(saved_errno));
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700450 return nullptr;
451 }
452 std::ostringstream check_map_request_error_msg;
Jim_Guoa62a5882014-04-28 11:11:57 +0800453 if (!CheckMapRequest(expected_ptr, actual, page_aligned_byte_count, error_msg)) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700454 return nullptr;
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700455 }
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800456 return new MemMap(filename, actual + page_offset, byte_count, actual, page_aligned_byte_count,
Jim_Guoa62a5882014-04-28 11:11:57 +0800457 prot, reuse);
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700458}
459
460MemMap::~MemMap() {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700461 if (base_begin_ == nullptr && base_size_ == 0) {
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700462 return;
463 }
Jim_Guoa62a5882014-04-28 11:11:57 +0800464 if (!reuse_) {
465 int result = munmap(base_begin_, base_size_);
466 if (result == -1) {
467 PLOG(FATAL) << "munmap failed";
468 }
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700469 }
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700470
471 // Remove it from maps_.
472 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
473 bool found = false;
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700474 DCHECK(maps_ != nullptr);
475 for (auto it = maps_->lower_bound(base_begin_), end = maps_->end();
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700476 it != end && it->first == base_begin_; ++it) {
477 if (it->second == this) {
478 found = true;
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700479 maps_->erase(it);
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700480 break;
481 }
482 }
483 CHECK(found) << "MemMap not found";
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700484}
485
Ian Rogers13735952014-10-08 12:43:28 -0700486MemMap::MemMap(const std::string& name, uint8_t* begin, size_t size, void* base_begin,
Jim_Guoa62a5882014-04-28 11:11:57 +0800487 size_t base_size, int prot, bool reuse)
Mathieu Chartier1c23e1e2012-10-12 14:14:11 -0700488 : name_(name), begin_(begin), size_(size), base_begin_(base_begin), base_size_(base_size),
Jim_Guoa62a5882014-04-28 11:11:57 +0800489 prot_(prot), reuse_(reuse) {
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700490 if (size_ == 0) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700491 CHECK(begin_ == nullptr);
492 CHECK(base_begin_ == nullptr);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700493 CHECK_EQ(base_size_, 0U);
494 } else {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700495 CHECK(begin_ != nullptr);
496 CHECK(base_begin_ != nullptr);
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700497 CHECK_NE(base_size_, 0U);
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700498
499 // Add it to maps_.
500 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700501 DCHECK(maps_ != nullptr);
502 maps_->insert(std::make_pair(base_begin_, this));
Brian Carlstrom9004cb62013-07-26 15:48:31 -0700503 }
Andreas Gampec8ccf682014-09-29 20:07:43 -0700504}
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700505
Ian Rogers13735952014-10-08 12:43:28 -0700506MemMap* MemMap::RemapAtEnd(uint8_t* new_end, const char* tail_name, int tail_prot,
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700507 std::string* error_msg) {
Mathieu Chartiercc236d72012-07-20 10:29:05 -0700508 DCHECK_GE(new_end, Begin());
509 DCHECK_LE(new_end, End());
Ian Rogers13735952014-10-08 12:43:28 -0700510 DCHECK_LE(begin_ + size_, reinterpret_cast<uint8_t*>(base_begin_) + base_size_);
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700511 DCHECK(IsAligned<kPageSize>(begin_));
512 DCHECK(IsAligned<kPageSize>(base_begin_));
Ian Rogers13735952014-10-08 12:43:28 -0700513 DCHECK(IsAligned<kPageSize>(reinterpret_cast<uint8_t*>(base_begin_) + base_size_));
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700514 DCHECK(IsAligned<kPageSize>(new_end));
Ian Rogers13735952014-10-08 12:43:28 -0700515 uint8_t* old_end = begin_ + size_;
516 uint8_t* old_base_end = reinterpret_cast<uint8_t*>(base_begin_) + base_size_;
517 uint8_t* new_base_end = new_end;
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700518 DCHECK_LE(new_base_end, old_base_end);
519 if (new_base_end == old_base_end) {
Jim_Guoa62a5882014-04-28 11:11:57 +0800520 return new MemMap(tail_name, nullptr, 0, nullptr, 0, tail_prot, false);
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700521 }
Ian Rogers13735952014-10-08 12:43:28 -0700522 size_ = new_end - reinterpret_cast<uint8_t*>(begin_);
523 base_size_ = new_base_end - reinterpret_cast<uint8_t*>(base_begin_);
524 DCHECK_LE(begin_ + size_, reinterpret_cast<uint8_t*>(base_begin_) + base_size_);
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700525 size_t tail_size = old_end - new_end;
Ian Rogers13735952014-10-08 12:43:28 -0700526 uint8_t* tail_base_begin = new_base_end;
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700527 size_t tail_base_size = old_base_end - new_base_end;
528 DCHECK_EQ(tail_base_begin + tail_base_size, old_base_end);
529 DCHECK(IsAligned<kPageSize>(tail_base_size));
530
531#ifdef USE_ASHMEM
532 // android_os_Debug.cpp read_mapinfo assumes all ashmem regions associated with the VM are
533 // prefixed "dalvik-".
534 std::string debug_friendly_name("dalvik-");
535 debug_friendly_name += tail_name;
536 ScopedFd fd(ashmem_create_region(debug_friendly_name.c_str(), tail_base_size));
Stuart Monteith8dba5aa2014-03-12 12:44:01 +0000537 int flags = MAP_PRIVATE | MAP_FIXED;
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700538 if (fd.get() == -1) {
539 *error_msg = StringPrintf("ashmem_create_region failed for '%s': %s",
540 tail_name, strerror(errno));
541 return nullptr;
542 }
543#else
544 ScopedFd fd(-1);
545 int flags = MAP_PRIVATE | MAP_ANONYMOUS;
546#endif
547
548 // Unmap/map the tail region.
549 int result = munmap(tail_base_begin, tail_base_size);
550 if (result == -1) {
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800551 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
552 *error_msg = StringPrintf("munmap(%p, %zd) failed for '%s'. See process maps in the log.",
553 tail_base_begin, tail_base_size, name_.c_str());
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700554 return nullptr;
555 }
556 // Don't cause memory allocation between the munmap and the mmap
557 // calls. Otherwise, libc (or something else) might take this memory
558 // region. Note this isn't perfect as there's no way to prevent
559 // other threads to try to take this memory region here.
Ian Rogers13735952014-10-08 12:43:28 -0700560 uint8_t* actual = reinterpret_cast<uint8_t*>(mmap(tail_base_begin, tail_base_size, tail_prot,
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700561 flags, fd.get(), 0));
562 if (actual == MAP_FAILED) {
Andreas Gampea6dfdae2015-02-24 15:50:19 -0800563 PrintFileToLog("/proc/self/maps", LogSeverity::WARNING);
564 *error_msg = StringPrintf("anonymous mmap(%p, %zd, 0x%x, 0x%x, %d, 0) failed. See process "
565 "maps in the log.", tail_base_begin, tail_base_size, tail_prot, flags,
566 fd.get());
Hiroshi Yamauchifd7e7f12013-10-22 14:17:48 -0700567 return nullptr;
568 }
Jim_Guoa62a5882014-04-28 11:11:57 +0800569 return new MemMap(tail_name, actual, tail_size, actual, tail_base_size, tail_prot, false);
Mathieu Chartiercc236d72012-07-20 10:29:05 -0700570}
Logan Chiend88fa262012-06-06 15:23:32 +0800571
Ian Rogersc5f17732014-06-05 20:48:42 -0700572void MemMap::MadviseDontNeedAndZero() {
573 if (base_begin_ != nullptr || base_size_ != 0) {
574 if (!kMadviseZeroes) {
575 memset(base_begin_, 0, base_size_);
576 }
577 int result = madvise(base_begin_, base_size_, MADV_DONTNEED);
578 if (result == -1) {
579 PLOG(WARNING) << "madvise failed";
580 }
581 }
582}
583
Logan Chiend88fa262012-06-06 15:23:32 +0800584bool MemMap::Protect(int prot) {
Hiroshi Yamauchi4fb5df82014-03-13 15:10:27 -0700585 if (base_begin_ == nullptr && base_size_ == 0) {
Ian Rogers1c849e52012-06-28 14:00:33 -0700586 prot_ = prot;
Logan Chiend88fa262012-06-06 15:23:32 +0800587 return true;
588 }
589
590 if (mprotect(base_begin_, base_size_, prot) == 0) {
Ian Rogers1c849e52012-06-28 14:00:33 -0700591 prot_ = prot;
Logan Chiend88fa262012-06-06 15:23:32 +0800592 return true;
593 }
594
Shih-wei Liaoa060ed92012-06-07 09:25:28 -0700595 PLOG(ERROR) << "mprotect(" << reinterpret_cast<void*>(base_begin_) << ", " << base_size_ << ", "
596 << prot << ") failed";
Logan Chiend88fa262012-06-06 15:23:32 +0800597 return false;
598}
599
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700600bool MemMap::CheckNoGaps(MemMap* begin_map, MemMap* end_map) {
601 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
602 CHECK(begin_map != nullptr);
603 CHECK(end_map != nullptr);
604 CHECK(HasMemMap(begin_map));
605 CHECK(HasMemMap(end_map));
606 CHECK_LE(begin_map->BaseBegin(), end_map->BaseBegin());
607 MemMap* map = begin_map;
608 while (map->BaseBegin() != end_map->BaseBegin()) {
609 MemMap* next_map = GetLargestMemMapAt(map->BaseEnd());
610 if (next_map == nullptr) {
611 // Found a gap.
612 return false;
613 }
614 map = next_map;
615 }
616 return true;
617}
618
619void MemMap::DumpMaps(std::ostream& os) {
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700620 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
Mathieu Chartierbad02672014-08-25 13:08:22 -0700621 DumpMapsLocked(os);
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700622}
623
Mathieu Chartierbad02672014-08-25 13:08:22 -0700624void MemMap::DumpMapsLocked(std::ostream& os) {
625 os << maps_;
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700626}
627
628bool MemMap::HasMemMap(MemMap* map) {
629 void* base_begin = map->BaseBegin();
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700630 for (auto it = maps_->lower_bound(base_begin), end = maps_->end();
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700631 it != end && it->first == base_begin; ++it) {
632 if (it->second == map) {
633 return true;
634 }
635 }
636 return false;
637}
638
639MemMap* MemMap::GetLargestMemMapAt(void* address) {
640 size_t largest_size = 0;
641 MemMap* largest_map = nullptr;
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700642 DCHECK(maps_ != nullptr);
643 for (auto it = maps_->lower_bound(address), end = maps_->end();
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700644 it != end && it->first == address; ++it) {
645 MemMap* map = it->second;
646 CHECK(map != nullptr);
647 if (largest_size < map->BaseSize()) {
648 largest_size = map->BaseSize();
649 largest_map = map;
650 }
651 }
652 return largest_map;
653}
654
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700655void MemMap::Init() {
656 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
657 if (maps_ == nullptr) {
658 // dex2oat calls MemMap::Init twice since its needed before the runtime is created.
659 maps_ = new Maps;
660 }
661}
662
663void MemMap::Shutdown() {
664 MutexLock mu(Thread::Current(), *Locks::mem_maps_lock_);
665 delete maps_;
666 maps_ = nullptr;
667}
668
Mathieu Chartier379d09f2015-01-08 11:28:13 -0800669void MemMap::SetSize(size_t new_size) {
670 if (new_size == base_size_) {
671 return;
672 }
673 CHECK_ALIGNED(new_size, kPageSize);
674 CHECK_EQ(base_size_, size_) << "Unsupported";
675 CHECK_LE(new_size, base_size_);
676 CHECK_EQ(munmap(reinterpret_cast<void*>(reinterpret_cast<uintptr_t>(BaseBegin()) + new_size),
677 base_size_ - new_size), 0) << new_size << " " << base_size_;
678 base_size_ = new_size;
679 size_ = new_size;
680}
681
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800682std::ostream& operator<<(std::ostream& os, const MemMap& mem_map) {
Hiroshi Yamauchi3eed93d2014-06-04 11:43:59 -0700683 os << StringPrintf("[MemMap: %p-%p prot=0x%x %s]",
684 mem_map.BaseBegin(), mem_map.BaseEnd(), mem_map.GetProtect(),
685 mem_map.GetName().c_str());
Brian Carlstrom0d6adac2014-02-05 17:39:16 -0800686 return os;
687}
688
Brian Carlstrom27ec9612011-09-19 20:20:38 -0700689} // namespace art