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

Side by Side Diff: third_party/WebKit/public/platform/WebDiscardableMemory.h

Issue 1787973002: Replace blink::WebDiscardableMemory with base::DiscardableMemory. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: use StringPiece::as_string Created 4 years, 9 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
« no previous file with comments | « third_party/WebKit/public/platform/Platform.h ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 /*
2 * Copyright (C) 2013 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26 #ifndef WebDiscardableMemory_h
27 #define WebDiscardableMemory_h
28
29 namespace blink {
30
31 class WebMemoryAllocatorDump;
32 class WebProcessMemoryDump;
33 class WebString;
34
35 // A memory allocation that can be automatically discarded by the operating
36 // system under memory pressure.
37 //
38 // Discardable usage is typically:
39 // WebDiscardableMemory* mem = allocateAndLockedDiscardableMemory(1024*1024);
40 // void* data = mem->data();
41 // memset(data, 3, 1024*1024);
42 // mem->unlock();
43 //
44 // Later, when you need it again:
45 // if (!mem->lock()) {
46 // ... handle the fact that the memory is gone...
47 // delete mem; // Make sure to destroy it. It is never going to come back.
48 // return;
49 // }
50 // ... use mem->data() as much as you want
51 // mem->unlock();
52 //
53 class WebDiscardableMemory {
54 public:
55 // Must not be called while locked.
56 virtual ~WebDiscardableMemory() { }
57
58 // Locks the memory, prevent it from being discarded. Once locked. you may
59 // obtain a pointer to that memory using the data() method.
60 //
61 // lock() may return false, indicating that the underlying memory was
62 // discarded and that the lock failed. In this case, the
63 // WebDiscardableMemory is effectively dead.
64 //
65 // Nested calls to lock are not allowed.
66 virtual bool lock() = 0;
67
68 // Returns the current pointer for the discardable memory. This call is ONLY
69 // valid when the discardable memory object is locked.
70 virtual void* data() = 0;
71
72 // Unlock the memory so that it can be purged by the system. Must be called
73 // after every successful lock call.
74 virtual void unlock() = 0;
75
76 // Used for tracing the statistics of discardable memory allocated. Returns
77 // a new MemoryAllocatorDump in the WebProcessMemoryDump object provided,
78 // with the size of the discardable memory. The MemoryAllocatorDump created
79 // is owned by the WebProcessMemoryDump object.
80 // See WebProcessMemoryDump::createMemoryAllocatorDump.
81 virtual WebMemoryAllocatorDump* createMemoryAllocatorDump(const WebString& n ame, WebProcessMemoryDump*) const = 0;
82 };
83
84 } // namespace blink
85
86 #endif
OLDNEW
« no previous file with comments | « third_party/WebKit/public/platform/Platform.h ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698