OLD | NEW |
---|---|
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 | 11 |
12 namespace base { | 12 namespace base { |
13 | 13 |
14 enum LockDiscardableMemoryStatus { | 14 enum LockDiscardableMemoryStatus { |
15 DISCARDABLE_MEMORY_FAILED = -1, | 15 DISCARDABLE_MEMORY_FAILED = -1, |
16 DISCARDABLE_MEMORY_PURGED = 0, | 16 DISCARDABLE_MEMORY_PURGED = 0, |
17 DISCARDABLE_MEMORY_SUCCESS = 1 | 17 DISCARDABLE_MEMORY_SUCCESS = 1 |
18 }; | 18 }; |
19 | 19 |
20 #if defined(OS_MACOSX) || defined(OS_ANDROID) | |
21 #define DISCARDABLE_MEMORY_SUPPORTED_NATIVELY | |
Avi (use Gerrit)
2013/06/20 21:16:41
If there is now a runtime call, do we need this #d
Ian Vollick
2013/06/20 23:27:09
Yup, but it needs a better name. We need to condit
Avi (use Gerrit)
2013/06/20 23:29:56
Meh. I'm not thrilled, but I don't care that much.
| |
22 #endif | |
23 | |
20 // Platform abstraction for discardable memory. DiscardableMemory is used to | 24 // Platform abstraction for discardable memory. DiscardableMemory is used to |
21 // cache large objects without worrying about blowing out memory, both on mobile | 25 // 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 | 26 // 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 | 27 // 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 | 28 // memory in response to an OOM signal because it is simpler, though it has less |
25 // flexibility as to which objects get discarded. | 29 // flexibility as to which objects get discarded. |
26 // | 30 // |
27 // Discardable memory has two states: locked and unlocked. While the memory is | 31 // 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 | 32 // locked, it will not be discarded. Unlocking the memory allows the OS to |
29 // reclaim it if needed. Locks do not nest. | 33 // reclaim it if needed. Locks do not nest. |
(...skipping 14 matching lines...) Expand all Loading... | |
44 // the comment starting with "vm_object_purgable_control" at | 48 // 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 | 49 // http://www.opensource.apple.com/source/xnu/xnu-792.13.8/osfmk/vm/v m_object.c |
46 class BASE_EXPORT DiscardableMemory { | 50 class BASE_EXPORT DiscardableMemory { |
47 public: | 51 public: |
48 DiscardableMemory(); | 52 DiscardableMemory(); |
49 | 53 |
50 // If the discardable memory is locked, the destructor will unlock it. | 54 // If the discardable memory is locked, the destructor will unlock it. |
51 // The opened file will also be closed after this. | 55 // The opened file will also be closed after this. |
52 ~DiscardableMemory(); | 56 ~DiscardableMemory(); |
53 | 57 |
54 // Check whether the system supports discardable memory. | 58 // Check whether the system supports discardable memory natively. Returns |
55 static bool Supported(); | 59 // false if the support is emulated. |
60 static bool SupportedNatively(); | |
56 | 61 |
57 // Initialize the DiscardableMemory object. On success, this function returns | 62 // Initialize the DiscardableMemory object. On success, this function returns |
58 // true and the memory is locked. This should only be called once. | 63 // 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 | 64 // This call could fail because of platform-specific limitations and the user |
60 // should stop using the DiscardableMemory afterwards. | 65 // should stop using the DiscardableMemory afterwards. |
61 bool InitializeAndLock(size_t size); | 66 bool InitializeAndLock(size_t size); |
62 | 67 |
63 // Lock the memory so that it will not be purged by the system. Returns | 68 // 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 | 69 // DISCARDABLE_MEMORY_SUCCESS on success. If the return value is |
65 // DISCARDABLE_MEMORY_FAILED then this object should be discarded and | 70 // DISCARDABLE_MEMORY_FAILED then this object should be discarded and |
66 // a new one should be created. If the return value is | 71 // a new one should be created. If the return value is |
67 // DISCARDABLE_MEMORY_PURGED then the memory is present but any data that | 72 // DISCARDABLE_MEMORY_PURGED then the memory is present but any data that |
68 // was in it is gone. | 73 // was in it is gone. |
69 LockDiscardableMemoryStatus Lock() WARN_UNUSED_RESULT; | 74 LockDiscardableMemoryStatus Lock() WARN_UNUSED_RESULT; |
70 | 75 |
71 // Unlock the memory so that it can be purged by the system. Must be called | 76 // Unlock the memory so that it can be purged by the system. Must be called |
72 // after every successful lock call. | 77 // after every successful lock call. |
73 void Unlock(); | 78 void Unlock(); |
74 | 79 |
80 bool is_locked() const { return is_locked_; } | |
81 | |
75 // Return the memory address held by this object. The object must be locked | 82 // Return the memory address held by this object. The object must be locked |
76 // before calling this. Otherwise, this will cause a DCHECK error. | 83 // before calling this. Otherwise, this will cause a DCHECK error. |
77 void* Memory() const; | 84 void* Memory() const; |
78 | 85 |
79 // Testing utility calls. | 86 // Testing utility calls. |
80 | 87 |
81 // Check whether a purge of all discardable memory in the system is supported. | 88 // Check whether a purge of all discardable memory in the system is supported. |
82 // Use only for testing! | 89 // Use only for testing! |
83 static bool PurgeForTestingSupported(); | 90 static bool PurgeForTestingSupported(); |
84 | 91 |
85 // Purge all discardable memory in the system. This call has global effects | 92 // 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! | 93 // across all running processes, so it should only be used for testing! |
87 static void PurgeForTesting(); | 94 static void PurgeForTesting(); |
88 | 95 |
89 private: | 96 private: |
97 #if !defined(DISCARDABLE_MEMORY_SUPPORTED_NATIVELY) | |
98 friend class DiscardableMemoryProvider; | |
99 friend class DiscardableMemoryProviderTest; | |
100 | |
101 // Used by the DiscardableMemoryProvider to allocate and free memory. | |
102 bool Allocate(); | |
103 void Deallocate(); | |
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_ |
OLD | NEW |