include/utils/MemoryHeapPmem.h

   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_PMEM_H
  18 #define ANDROID_MEMORY_HEAP_PMEM_H
  19
  20 #include <stdlib.h>
  21 #include <stdint.h>
  22
  23 #include <utils/MemoryDealer.h>
  24 #include <utils/MemoryHeapBase.h>
  25 #include <utils/IMemory.h>
  26 #include <utils/SortedVector.h>
  27
  28 namespace android {
  29
  30 class MemoryHeapBase;
  31
  32 // ---------------------------------------------------------------------------
  33
  34 class MemoryHeapPmem : public HeapInterface, public MemoryHeapBase
  35 {
  36 public:
  37     class MemoryPmem : public BnMemory {
  38     public:
  39         MemoryPmem(const sp<MemoryHeapPmem>& heap);
  40         ~MemoryPmem();
  41     protected:
  42         const sp<MemoryHeapPmem>&  getHeap() const { return mClientHeap; }
  43     private:
  44         friend class MemoryHeapPmem;
  45         virtual void revoke() = 0;
  46         sp<MemoryHeapPmem>  mClientHeap;
  47     };
  48
  49     MemoryHeapPmem(const sp<MemoryHeapBase>& pmemHeap,
  50                 uint32_t flags = IMemoryHeap::MAP_ONCE);
  51     ~MemoryHeapPmem();
  52
  53     /* HeapInterface additions */
  54     virtual sp<IMemory> mapMemory(size_t offset, size_t size);
  55
  56     /* make the whole heap visible (you know who you are) */
  57     virtual status_t slap();
  58
  59     /* hide (revoke) the whole heap (the client will see the garbage page) */
  60     virtual status_t unslap();
  61
  62     /* revoke all allocations made by this heap */
  63     virtual void revoke();
  64
  65 private:
  66     /* use this to create your own IMemory for mapMemory */
  67     virtual sp<MemoryPmem> createMemory(size_t offset, size_t size);
  68     void remove(const wp<MemoryPmem>& memory);
  69
  70 private:
  71     sp<MemoryHeapBase>              mParentHeap;
  72     mutable Mutex                   mLock;
  73     SortedVector< wp<MemoryPmem> >  mAllocations;
  74 };
  75
  76
  77 // ---------------------------------------------------------------------------
  78 }; // namespace android
  79
  80 #endif // ANDROID_MEMORY_HEAP_PMEM_H