Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(126)

Side by Side Diff: base/memory/discardable_memory.h

Issue 17106004: Add discardable memory emulation for non-android/mac platforms (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: address review feedback Created 7 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef BASE_MEMORY_DISCARDABLE_MEMORY_H_ 5 #ifndef BASE_MEMORY_DISCARDABLE_MEMORY_H_
6 #define BASE_MEMORY_DISCARDABLE_MEMORY_H_ 6 #define BASE_MEMORY_DISCARDABLE_MEMORY_H_
7 7
8 #include "base/base_export.h" 8 #include "base/base_export.h"
9 #include "base/basictypes.h" 9 #include "base/basictypes.h"
10 #include "base/compiler_specific.h" 10 #include "base/compiler_specific.h"
11 #if !defined(DISCARDABLE_MEMORY_ALWAYS_SUPPORTED_NATIVELY)
12 #include "base/memory/scoped_ptr.h"
13 #endif
14 #include "base/threading/non_thread_safe.h"
11 15
12 namespace base { 16 namespace base {
13 17
18 namespace internal {
19 class DiscardableMemoryProvider;
20 }
21
14 enum LockDiscardableMemoryStatus { 22 enum LockDiscardableMemoryStatus {
15 DISCARDABLE_MEMORY_FAILED = -1, 23 DISCARDABLE_MEMORY_FAILED = -1,
16 DISCARDABLE_MEMORY_PURGED = 0, 24 DISCARDABLE_MEMORY_PURGED = 0,
17 DISCARDABLE_MEMORY_SUCCESS = 1 25 DISCARDABLE_MEMORY_SUCCESS = 1
18 }; 26 };
19 27
20 // Platform abstraction for discardable memory. DiscardableMemory is used to 28 // Platform abstraction for discardable memory. DiscardableMemory is used to
21 // cache large objects without worrying about blowing out memory, both on mobile 29 // cache large objects without worrying about blowing out memory, both on mobile
22 // devices where there is no swap, and desktop devices where unused free memory 30 // devices where there is no swap, and desktop devices where unused free memory
23 // should be used to help the user experience. This is preferable to releasing 31 // should be used to help the user experience. This is preferable to releasing
24 // memory in response to an OOM signal because it is simpler, though it has less 32 // memory in response to an OOM signal because it is simpler, though it has less
25 // flexibility as to which objects get discarded. 33 // flexibility as to which objects get discarded.
26 // 34 //
27 // Discardable memory has two states: locked and unlocked. While the memory is 35 // Discardable memory has two states: locked and unlocked. While the memory is
28 // locked, it will not be discarded. Unlocking the memory allows the OS to 36 // locked, it will not be discarded. Unlocking the memory allows the OS to
29 // reclaim it if needed. Locks do not nest. 37 // reclaim it if needed. Locks do not nest.
30 // 38 //
31 // Notes: 39 // Notes:
32 // - The paging behavior of memory while it is locked is not specified. While 40 // - The paging behavior of memory while it is locked is not specified. While
33 // mobile platforms will not swap it out, it may qualify for swapping 41 // mobile platforms will not swap it out, it may qualify for swapping
34 // on desktop platforms. It is not expected that this will matter, as the 42 // on desktop platforms. It is not expected that this will matter, as the
35 // preferred pattern of usage for DiscardableMemory is to lock down the 43 // preferred pattern of usage for DiscardableMemory is to lock down the
36 // memory, use it as quickly as possible, and then unlock it. 44 // memory, use it as quickly as possible, and then unlock it.
37 // - Because of memory alignment, the amount of memory allocated can be 45 // - Because of memory alignment, the amount of memory allocated can be
38 // larger than the requested memory size. It is not very efficient for 46 // larger than the requested memory size. It is not very efficient for
39 // small allocations. 47 // small allocations.
48 // - A discardable memory instance is not thread safe. It is the
49 // responsibility of users of discardable memory to ensure there are no
50 // races.
40 // 51 //
41 // References: 52 // References:
42 // - Linux: http://lwn.net/Articles/452035/ 53 // - Linux: http://lwn.net/Articles/452035/
43 // - Mac: http://trac.webkit.org/browser/trunk/Source/WebCore/platform/mac/Pur geableBufferMac.cpp 54 // - Mac: http://trac.webkit.org/browser/trunk/Source/WebCore/platform/mac/Pur geableBufferMac.cpp
44 // the comment starting with "vm_object_purgable_control" at 55 // the comment starting with "vm_object_purgable_control" at
45 // http://www.opensource.apple.com/source/xnu/xnu-792.13.8/osfmk/vm/v m_object.c 56 // http://www.opensource.apple.com/source/xnu/xnu-792.13.8/osfmk/vm/v m_object.c
46 class BASE_EXPORT DiscardableMemory { 57 class BASE_EXPORT DiscardableMemory {
47 public: 58 public:
48 DiscardableMemory(); 59 DiscardableMemory();
49 60
50 // If the discardable memory is locked, the destructor will unlock it. 61 // If the discardable memory is locked, the destructor will unlock it.
51 // The opened file will also be closed after this. 62 // The opened file will also be closed after this.
52 ~DiscardableMemory(); 63 ~DiscardableMemory();
53 64
54 // Check whether the system supports discardable memory. 65 // Check whether the system supports discardable memory natively. Returns
55 static bool Supported(); 66 // false if the support is emulated.
67 static bool SupportedNatively();
56 68
57 // Initialize the DiscardableMemory object. On success, this function returns 69 // Initialize the DiscardableMemory object. On success, this function returns
58 // true and the memory is locked. This should only be called once. 70 // true and the memory is locked. This should only be called once.
59 // This call could fail because of platform-specific limitations and the user 71 // This call could fail because of platform-specific limitations and the user
60 // should stop using the DiscardableMemory afterwards. 72 // should stop using the DiscardableMemory afterwards.
61 bool InitializeAndLock(size_t size); 73 bool InitializeAndLock(size_t size);
62 74
63 // Lock the memory so that it will not be purged by the system. Returns 75 // Lock the memory so that it will not be purged by the system. Returns
64 // DISCARDABLE_MEMORY_SUCCESS on success. If the return value is 76 // DISCARDABLE_MEMORY_SUCCESS on success. If the return value is
65 // DISCARDABLE_MEMORY_FAILED then this object should be discarded and 77 // DISCARDABLE_MEMORY_FAILED then this object should be discarded and
(...skipping 14 matching lines...) Expand all
80 92
81 // Check whether a purge of all discardable memory in the system is supported. 93 // Check whether a purge of all discardable memory in the system is supported.
82 // Use only for testing! 94 // Use only for testing!
83 static bool PurgeForTestingSupported(); 95 static bool PurgeForTestingSupported();
84 96
85 // Purge all discardable memory in the system. This call has global effects 97 // Purge all discardable memory in the system. This call has global effects
86 // across all running processes, so it should only be used for testing! 98 // across all running processes, so it should only be used for testing!
87 static void PurgeForTesting(); 99 static void PurgeForTesting();
88 100
89 private: 101 private:
102 #if !defined(DISCARDABLE_MEMORY_ALWAYS_SUPPORTED_NATIVELY)
103 scoped_ptr<uint8, FreeDeleter> acquired_memory_;
104 #endif
105
90 #if defined(OS_ANDROID) 106 #if defined(OS_ANDROID)
91 // Maps the discardable memory into the caller's address space. 107 // Maps the discardable memory into the caller's address space.
92 // Returns true on success, false otherwise. 108 // Returns true on success, false otherwise.
93 bool Map(); 109 bool Map();
94 110
95 // Unmaps the discardable memory from the caller's address space. 111 // Unmaps the discardable memory from the caller's address space.
96 void Unmap(); 112 void Unmap();
97 113
98 // Reserve a file descriptor. When reaching the fd limit, this call returns 114 // Reserve a file descriptor. When reaching the fd limit, this call returns
99 // false and initialization should fail. 115 // false and initialization should fail.
100 bool ReserveFileDescriptor(); 116 bool ReserveFileDescriptor();
101 117
102 // Release a file descriptor so that others can reserve it. 118 // Release a file descriptor so that others can reserve it.
103 void ReleaseFileDescriptor(); 119 void ReleaseFileDescriptor();
104 #endif // OS_ANDROID 120 #endif // OS_ANDROID
105 121
106 void* memory_; 122 void* memory_;
107 size_t size_; 123 size_t size_;
108 bool is_locked_; 124 bool is_locked_;
109 #if defined(OS_ANDROID) 125 #if defined(OS_ANDROID)
110 int fd_; 126 int fd_;
111 #endif // OS_ANDROID 127 #endif // OS_ANDROID
112 128
113 DISALLOW_COPY_AND_ASSIGN(DiscardableMemory); 129 DISALLOW_COPY_AND_ASSIGN(DiscardableMemory);
114 }; 130 };
115 131
116 } // namespace base 132 } // namespace base
117 133
118 #endif // BASE_MEMORY_DISCARDABLE_MEMORY_H_ 134 #endif // BASE_MEMORY_DISCARDABLE_MEMORY_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698