blob: 4f4b8895a5f66750326001afbc218d496723e246 [file] [log] [blame]
The Android Open Source Projectcbb10112009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 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//
18// Shared file mapping class.
19//
20
21#define LOG_TAG "filemap"
22
23#include <utils/FileMap.h>
24#include <utils/Log.h>
25
Yabin Cui266092c2014-11-11 10:31:30 -080026#if defined(__MINGW32__) && !defined(__USE_MINGW_ANSI_STDIO)
Mark Salyzyn5bed8032014-04-30 11:10:46 -070027# define PRId32 "I32d"
28# define PRIx32 "I32x"
29# define PRId64 "I64d"
30#else
Mark Salyzyn15085a62014-04-17 09:34:42 -070031#include <inttypes.h>
Mark Salyzyn5bed8032014-04-30 11:10:46 -070032#endif
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080033#include <stdio.h>
34#include <stdlib.h>
35
Yabin Cui266092c2014-11-11 10:31:30 -080036#if !defined(__MINGW32__)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080037#include <sys/mman.h>
38#endif
39
40#include <string.h>
41#include <memory.h>
42#include <errno.h>
43#include <assert.h>
44
45using namespace android;
46
47/*static*/ long FileMap::mPageSize = -1;
48
Mark Salyzynb6185762014-04-17 10:01:12 -070049// Constructor. Create an empty object.
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080050FileMap::FileMap(void)
Narayan Kamath6832a7a2015-02-23 15:43:35 +000051 : mFileName(NULL), mBasePtr(NULL), mBaseLength(0),
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080052 mDataPtr(NULL), mDataLength(0)
53{
54}
55
Adam Lesinski6f8885b2015-09-22 18:42:19 -070056// Move Constructor.
57FileMap::FileMap(FileMap&& other)
58 : mFileName(other.mFileName), mBasePtr(other.mBasePtr), mBaseLength(other.mBaseLength),
59 mDataOffset(other.mDataOffset), mDataPtr(other.mDataPtr), mDataLength(other.mDataLength)
60#if defined(__MINGW32__)
61 , mFileHandle(other.mFileHandle), mFileMapping(other.mFileMapping)
62#endif
63{
64 other.mFileName = NULL;
65 other.mBasePtr = NULL;
66 other.mDataPtr = NULL;
67#if defined(__MINGW32__)
68 other.mFileHandle = 0;
69 other.mFileMapping = 0;
70#endif
71}
72
73// Move assign operator.
74FileMap& FileMap::operator=(FileMap&& other) {
75 mFileName = other.mFileName;
76 mBasePtr = other.mBasePtr;
77 mBaseLength = other.mBaseLength;
78 mDataOffset = other.mDataOffset;
79 mDataPtr = other.mDataPtr;
80 mDataLength = other.mDataLength;
81 other.mFileName = NULL;
82 other.mBasePtr = NULL;
83 other.mDataPtr = NULL;
84#if defined(__MINGW32__)
85 mFileHandle = other.mFileHandle;
86 mFileMapping = other.mFileMapping;
87 other.mFileHandle = 0;
88 other.mFileMapping = 0;
89#endif
90 return *this;
91}
92
Mark Salyzynb6185762014-04-17 10:01:12 -070093// Destructor.
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080094FileMap::~FileMap(void)
95{
The Android Open Source Projectcbb10112009-03-03 19:31:44 -080096 if (mFileName != NULL) {
97 free(mFileName);
98 }
Yabin Cui266092c2014-11-11 10:31:30 -080099#if defined(__MINGW32__)
Jeff Brown1d618d62010-12-02 13:50:46 -0800100 if (mBasePtr && UnmapViewOfFile(mBasePtr) == 0) {
Mark Salyzyn15085a62014-04-17 09:34:42 -0700101 ALOGD("UnmapViewOfFile(%p) failed, error = %" PRId32 "\n", mBasePtr,
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800102 GetLastError() );
103 }
Jeff Brown1d618d62010-12-02 13:50:46 -0800104 if (mFileMapping != INVALID_HANDLE_VALUE) {
105 CloseHandle(mFileMapping);
106 }
Yabin Cui266092c2014-11-11 10:31:30 -0800107#else
108 if (mBasePtr && munmap(mBasePtr, mBaseLength) != 0) {
109 ALOGD("munmap(%p, %zu) failed\n", mBasePtr, mBaseLength);
110 }
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800111#endif
112}
113
114
Mark Salyzynb6185762014-04-17 10:01:12 -0700115// Create a new mapping on an open file.
116//
117// Closing the file descriptor does not unmap the pages, so we don't
118// claim ownership of the fd.
119//
120// Returns "false" on failure.
Kenny Roote2fa7dc2010-11-24 12:56:06 -0800121bool FileMap::create(const char* origFileName, int fd, off64_t offset, size_t length,
122 bool readOnly)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800123{
Yabin Cui266092c2014-11-11 10:31:30 -0800124#if defined(__MINGW32__)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800125 int adjust;
Kenny Roote2fa7dc2010-11-24 12:56:06 -0800126 off64_t adjOffset;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800127 size_t adjLength;
128
129 if (mPageSize == -1) {
130 SYSTEM_INFO si;
Mark Salyzynb6185762014-04-17 10:01:12 -0700131
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800132 GetSystemInfo( &si );
133 mPageSize = si.dwAllocationGranularity;
134 }
135
136 DWORD protect = readOnly ? PAGE_READONLY : PAGE_READWRITE;
Mark Salyzynb6185762014-04-17 10:01:12 -0700137
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800138 mFileHandle = (HANDLE) _get_osfhandle(fd);
139 mFileMapping = CreateFileMapping( mFileHandle, NULL, protect, 0, 0, NULL);
140 if (mFileMapping == NULL) {
Mark Salyzyn15085a62014-04-17 09:34:42 -0700141 ALOGE("CreateFileMapping(%p, %" PRIx32 ") failed with error %" PRId32 "\n",
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800142 mFileHandle, protect, GetLastError() );
143 return false;
144 }
Mark Salyzynb6185762014-04-17 10:01:12 -0700145
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800146 adjust = offset % mPageSize;
147 adjOffset = offset - adjust;
148 adjLength = length + adjust;
Mark Salyzynb6185762014-04-17 10:01:12 -0700149
150 mBasePtr = MapViewOfFile( mFileMapping,
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800151 readOnly ? FILE_MAP_READ : FILE_MAP_ALL_ACCESS,
152 0,
153 (DWORD)(adjOffset),
154 adjLength );
155 if (mBasePtr == NULL) {
Mark Salyzyn15085a62014-04-17 09:34:42 -0700156 ALOGE("MapViewOfFile(%" PRId64 ", %zu) failed with error %" PRId32 "\n",
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800157 adjOffset, adjLength, GetLastError() );
158 CloseHandle(mFileMapping);
159 mFileMapping = INVALID_HANDLE_VALUE;
160 return false;
161 }
Yabin Cui266092c2014-11-11 10:31:30 -0800162#else // !defined(__MINGW32__)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800163 int prot, flags, adjust;
Kenny Roote2fa7dc2010-11-24 12:56:06 -0800164 off64_t adjOffset;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800165 size_t adjLength;
166
167 void* ptr;
168
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800169 assert(fd >= 0);
170 assert(offset >= 0);
171 assert(length > 0);
172
Mark Salyzynb6185762014-04-17 10:01:12 -0700173 // init on first use
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800174 if (mPageSize == -1) {
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800175 mPageSize = sysconf(_SC_PAGESIZE);
176 if (mPageSize == -1) {
Steve Block1b781ab2012-01-06 19:20:56 +0000177 ALOGE("could not get _SC_PAGESIZE\n");
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800178 return false;
179 }
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800180 }
181
Narayan Kamath5955a9f2015-02-19 17:29:27 +0000182 adjust = offset % mPageSize;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800183 adjOffset = offset - adjust;
184 adjLength = length + adjust;
185
186 flags = MAP_SHARED;
187 prot = PROT_READ;
188 if (!readOnly)
189 prot |= PROT_WRITE;
190
191 ptr = mmap(NULL, adjLength, prot, flags, fd, adjOffset);
192 if (ptr == MAP_FAILED) {
Mark Salyzyn5bed8032014-04-30 11:10:46 -0700193 ALOGE("mmap(%lld,%zu) failed: %s\n",
194 (long long)adjOffset, adjLength, strerror(errno));
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800195 return false;
196 }
197 mBasePtr = ptr;
Yabin Cui266092c2014-11-11 10:31:30 -0800198#endif // !defined(__MINGW32__)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800199
200 mFileName = origFileName != NULL ? strdup(origFileName) : NULL;
201 mBaseLength = adjLength;
202 mDataOffset = offset;
203 mDataPtr = (char*) mBasePtr + adjust;
204 mDataLength = length;
205
206 assert(mBasePtr != NULL);
207
Mark Salyzyn15085a62014-04-17 09:34:42 -0700208 ALOGV("MAP: base %p/%zu data %p/%zu\n",
209 mBasePtr, mBaseLength, mDataPtr, mDataLength);
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800210
211 return true;
212}
213
Mark Salyzynb6185762014-04-17 10:01:12 -0700214// Provide guidance to the system.
Yabin Cui745c5f62014-11-18 20:00:41 -0800215#if !defined(_WIN32)
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800216int FileMap::advise(MapAdvice advice)
217{
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800218 int cc, sysAdvice;
219
220 switch (advice) {
221 case NORMAL: sysAdvice = MADV_NORMAL; break;
222 case RANDOM: sysAdvice = MADV_RANDOM; break;
223 case SEQUENTIAL: sysAdvice = MADV_SEQUENTIAL; break;
224 case WILLNEED: sysAdvice = MADV_WILLNEED; break;
225 case DONTNEED: sysAdvice = MADV_DONTNEED; break;
226 default:
227 assert(false);
228 return -1;
229 }
230
231 cc = madvise(mBasePtr, mBaseLength, sysAdvice);
232 if (cc != 0)
Steve Block61d341b2012-01-05 23:22:43 +0000233 ALOGW("madvise(%d) failed: %s\n", sysAdvice, strerror(errno));
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800234 return cc;
The Android Open Source Projectcbb10112009-03-03 19:31:44 -0800235}
Yabin Cui745c5f62014-11-18 20:00:41 -0800236
237#else
238int FileMap::advise(MapAdvice /* advice */)
239{
240 return -1;
241}
242#endif