19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project// 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project// Encapsulate a shared file mapping. 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project// 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#ifndef __LIBS_FILE_MAP_H 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#define __LIBS_FILE_MAP_H 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#include <sys/types.h> 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 25ddb76c4644756b31be948d70aaa8ee541dd94999Kenny Root#include <utils/Compat.h> 26ddb76c4644756b31be948d70aaa8ee541dd94999Kenny Root 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#ifdef HAVE_WIN32_FILEMAP 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#include <windows.h> 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#endif 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectnamespace android { 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This represents a memory-mapped file. It might be the entire file or 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * only part of it. This requires a little bookkeeping because the mapping 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * needs to be aligned on page boundaries, and in some cases we'd like to 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * have multiple references to the mapped area without creating additional 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * maps. 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This always uses MAP_SHARED. 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * TODO: we should be able to create a new FileMap that is a subset of 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * an existing FileMap and shares the underlying mapped pages. Requires 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * completing the refcounting stuff and possibly introducing the notion 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of a FileMap hierarchy. 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectclass FileMap { 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic: 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project FileMap(void); 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Create a new mapping on an open file. 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Closing the file descriptor does not unmap the pages, so we don't 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * claim ownership of the fd. 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns "false" on failure. 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project bool create(const char* origFileName, int fd, 60ddb76c4644756b31be948d70aaa8ee541dd94999Kenny Root off64_t offset, size_t length, bool readOnly); 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the name of the file this map came from, if known. 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project const char* getFileName(void) const { return mFileName; } 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get a pointer to the piece of the file we requested. 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void* getDataPtr(void) const { return mDataPtr; } 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the length we requested. 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project size_t getDataLength(void) const { return mDataLength; } 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the data offset used to create this map. 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 80ddb76c4644756b31be948d70aaa8ee541dd94999Kenny Root off64_t getDataOffset(void) const { return mDataOffset; } 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get a "copy" of the object. 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project FileMap* acquire(void) { mRefCount++; return this; } 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Call this when mapping is no longer needed. 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void release(void) { 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (--mRefCount <= 0) 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project delete this; 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This maps directly to madvise() values, but allows us to avoid 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * including <sys/mman.h> everywhere. 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project enum MapAdvice { 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project NORMAL, RANDOM, SEQUENTIAL, WILLNEED, DONTNEED 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }; 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Apply an madvise() call to the entire file. 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns 0 on success, -1 on failure. 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int advise(MapAdvice advice); 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectprotected: 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // don't delete objects; call release() 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ~FileMap(void); 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectprivate: 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // these are not implemented 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project FileMap(const FileMap& src); 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project const FileMap& operator=(const FileMap& src); 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int mRefCount; // reference count 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project char* mFileName; // original file name, if known 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void* mBasePtr; // base of mmap area; page aligned 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project size_t mBaseLength; // length, measured from "mBasePtr" 123ddb76c4644756b31be948d70aaa8ee541dd94999Kenny Root off64_t mDataOffset; // offset used when map was created 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void* mDataPtr; // start of requested data, offset from base 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project size_t mDataLength; // length, measured from "mDataPtr" 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#ifdef HAVE_WIN32_FILEMAP 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project HANDLE mFileHandle; // Win32 file handle 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project HANDLE mFileMapping; // Win32 file mapping handle 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#endif 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static long mPageSize; 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project}; 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project}; // namespace android 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project#endif // __LIBS_FILE_MAP_H 137