Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 1 | /* |
| 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 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_MEM_MAP_H_ |
| 18 | #define ART_RUNTIME_MEM_MAP_H_ |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 19 | |
Mathieu Chartier | 1c23e1e | 2012-10-12 14:14:11 -0700 | [diff] [blame] | 20 | #include <string> |
| 21 | |
Brian Carlstrom | 27ec961 | 2011-09-19 20:20:38 -0700 | [diff] [blame] | 22 | #include <stddef.h> |
Elliott Hughes | a168c83 | 2012-06-12 15:34:20 -0700 | [diff] [blame] | 23 | #include <sys/mman.h> // For the PROT_* and MAP_* constants. |
Brian Carlstrom | 27ec961 | 2011-09-19 20:20:38 -0700 | [diff] [blame] | 24 | #include <sys/types.h> |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 25 | |
Brian Carlstrom | 27ec961 | 2011-09-19 20:20:38 -0700 | [diff] [blame] | 26 | #include "globals.h" |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 27 | |
| 28 | namespace art { |
| 29 | |
| 30 | // Used to keep track of mmap segments. |
| 31 | class MemMap { |
| 32 | public: |
Elliott Hughes | ecd3a6f | 2012-06-06 18:16:37 -0700 | [diff] [blame] | 33 | // Request an anonymous region of length 'byte_count' and a requested base address. |
Elliott Hughes | 6c9c06d | 2011-11-07 16:43:47 -0800 | [diff] [blame] | 34 | // Use NULL as the requested base address if you don't care. |
| 35 | // |
| 36 | // The word "anonymous" in this context means "not backed by a file". The supplied |
| 37 | // 'ashmem_name' will be used -- on systems that support it -- to give the mapping |
| 38 | // a name. |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 39 | // |
| 40 | // On success, returns returns a MemMap instance. On failure, returns a NULL; |
Ian Rogers | 8d31bbd | 2013-10-13 10:44:14 -0700 | [diff] [blame] | 41 | static MemMap* MapAnonymous(const char* ashmem_name, byte* addr, size_t byte_count, int prot, |
| 42 | std::string* error_msg); |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 43 | |
| 44 | // Map part of a file, taking care of non-page aligned offsets. The |
| 45 | // "start" offset is absolute, not relative. |
| 46 | // |
| 47 | // On success, returns returns a MemMap instance. On failure, returns a NULL; |
Ian Rogers | 8d31bbd | 2013-10-13 10:44:14 -0700 | [diff] [blame] | 48 | static MemMap* MapFile(size_t byte_count, int prot, int flags, int fd, off_t start, |
| 49 | const char* filename, std::string* error_msg) { |
| 50 | return MapFileAtAddress(NULL, byte_count, prot, flags, fd, start, false, filename, error_msg); |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 51 | } |
| 52 | |
| 53 | // Map part of a file, taking care of non-page aligned offsets. The |
| 54 | // "start" offset is absolute, not relative. This version allows |
| 55 | // requesting a specific address for the base of the mapping. |
| 56 | // |
| 57 | // On success, returns returns a MemMap instance. On failure, returns a NULL; |
Ian Rogers | 8d31bbd | 2013-10-13 10:44:14 -0700 | [diff] [blame] | 58 | static MemMap* MapFileAtAddress(byte* addr, size_t byte_count, int prot, int flags, int fd, |
| 59 | off_t start, bool reuse, const char* filename, |
| 60 | std::string* error_msg); |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 61 | |
Brian Carlstrom | 27ec961 | 2011-09-19 20:20:38 -0700 | [diff] [blame] | 62 | // Releases the memory mapping |
| 63 | ~MemMap(); |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 64 | |
Logan Chien | d88fa26 | 2012-06-06 15:23:32 +0800 | [diff] [blame] | 65 | bool Protect(int prot); |
| 66 | |
Ian Rogers | 1c849e5 | 2012-06-28 14:00:33 -0700 | [diff] [blame] | 67 | int GetProtect() const { |
| 68 | return prot_; |
| 69 | } |
| 70 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 71 | byte* Begin() const { |
| 72 | return begin_; |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 73 | } |
| 74 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 75 | size_t Size() const { |
| 76 | return size_; |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 77 | } |
| 78 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 79 | byte* End() const { |
Mathieu Chartier | 2fde533 | 2012-09-14 14:51:54 -0700 | [diff] [blame] | 80 | return Begin() + Size(); |
| 81 | } |
| 82 | |
| 83 | bool HasAddress(const void* addr) const { |
| 84 | return Begin() <= addr && addr < End(); |
Brian Carlstrom | b765be0 | 2011-08-17 23:54:10 -0700 | [diff] [blame] | 85 | } |
| 86 | |
Hiroshi Yamauchi | fd7e7f1 | 2013-10-22 14:17:48 -0700 | [diff] [blame] | 87 | // Unmap the pages at end and remap them to create another memory map. |
| 88 | MemMap* RemapAtEnd(byte* new_end, const char* tail_name, int tail_prot, |
| 89 | std::string* error_msg); |
Mathieu Chartier | cc236d7 | 2012-07-20 10:29:05 -0700 | [diff] [blame] | 90 | |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 91 | private: |
Mathieu Chartier | 1c23e1e | 2012-10-12 14:14:11 -0700 | [diff] [blame] | 92 | MemMap(const std::string& name, byte* begin, size_t size, void* base_begin, size_t base_size, |
| 93 | int prot); |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 94 | |
Mathieu Chartier | 1c23e1e | 2012-10-12 14:14:11 -0700 | [diff] [blame] | 95 | std::string name_; |
Ian Rogers | 1c849e5 | 2012-06-28 14:00:33 -0700 | [diff] [blame] | 96 | byte* const begin_; // Start of data. |
Mathieu Chartier | cc236d7 | 2012-07-20 10:29:05 -0700 | [diff] [blame] | 97 | size_t size_; // Length of data. |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 98 | |
Ian Rogers | 1c849e5 | 2012-06-28 14:00:33 -0700 | [diff] [blame] | 99 | void* const base_begin_; // Page-aligned base address. |
Hiroshi Yamauchi | fd7e7f1 | 2013-10-22 14:17:48 -0700 | [diff] [blame] | 100 | size_t base_size_; // Length of mapping. May be changed by RemapAtEnd (ie Zygote). |
Ian Rogers | 1c849e5 | 2012-06-28 14:00:33 -0700 | [diff] [blame] | 101 | int prot_; // Protection of the map. |
Hiroshi Yamauchi | fd7e7f1 | 2013-10-22 14:17:48 -0700 | [diff] [blame] | 102 | |
| 103 | friend class MemMapTest; // To allow access to base_begin_ and base_size_. |
Brian Carlstrom | db4d540 | 2011-08-09 12:18:28 -0700 | [diff] [blame] | 104 | }; |
| 105 | |
| 106 | } // namespace art |
| 107 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 108 | #endif // ART_RUNTIME_MEM_MAP_H_ |