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 17 #ifndef ANDROID_MEMORY_HEAP_BASE_H 18 #define ANDROID_MEMORY_HEAP_BASE_H 19 20 #include <stdlib.h> 21 #include <stdint.h> 22 23 #include <binder/IMemory.h> 24 25 26 namespace android { 27 28 // --------------------------------------------------------------------------- 29 30 class MemoryHeapBase : public virtual BnMemoryHeap 31 { 32 public: 33 enum { 34 READ_ONLY = IMemoryHeap::READ_ONLY, 35 // memory won't be mapped locally, but will be mapped in the remote 36 // process. 37 DONT_MAP_LOCALLY = 0x00000100, 38 NO_CACHING = 0x00000200 39 }; 40 41 /* 42 * maps the memory referenced by fd. but DOESN'T take ownership 43 * of the filedescriptor (it makes a copy with dup() 44 */ 45 MemoryHeapBase(int fd, size_t size, uint32_t flags = 0, off_t offset = 0); 46 47 /* 48 * maps memory from the given device 49 */ 50 explicit MemoryHeapBase(const char* device, size_t size = 0, uint32_t flags = 0); 51 52 /* 53 * maps memory from ashmem, with the given name for debugging 54 */ 55 explicit MemoryHeapBase(size_t size, uint32_t flags = 0, char const* name = nullptr); 56 57 virtual ~MemoryHeapBase(); 58 59 /* implement IMemoryHeap interface */ 60 virtual int getHeapID() const; 61 62 /* virtual address of the heap. returns MAP_FAILED in case of error */ 63 virtual void* getBase() const; 64 65 virtual size_t getSize() const; 66 virtual uint32_t getFlags() const; 67 off_t getOffset() const override; 68 69 const char* getDevice() const; 70 71 /* this closes this heap -- use carefully */ 72 void dispose(); 73 74 /* this is only needed as a workaround, use only if you know 75 * what you are doing */ setDevice(const char * device)76 status_t setDevice(const char* device) { 77 if (mDevice == nullptr) 78 mDevice = device; 79 return mDevice ? NO_ERROR : ALREADY_EXISTS; 80 } 81 82 protected: 83 MemoryHeapBase(); 84 // init() takes ownership of fd 85 status_t init(int fd, void *base, size_t size, 86 int flags = 0, const char* device = nullptr); 87 88 private: 89 status_t mapfd(int fd, size_t size, off_t offset = 0); 90 91 int mFD; 92 size_t mSize; 93 void* mBase; 94 uint32_t mFlags; 95 const char* mDevice; 96 bool mNeedUnmap; 97 off_t mOffset; 98 }; 99 100 // --------------------------------------------------------------------------- 101 }; // namespace android 102 103 #endif // ANDROID_MEMORY_HEAP_BASE_H 104