OLD | NEW |
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 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_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ | 5 #ifndef BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ |
6 #define BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ | 6 #define BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ |
7 | 7 |
8 #include "base/base_export.h" | 8 #include "base/base_export.h" |
9 #include "base/macros.h" | 9 #include "base/macros.h" |
| 10 #include "base/trace_event/memory_dump_request_args.h" |
10 | 11 |
11 namespace base { | 12 namespace base { |
12 namespace trace_event { | 13 namespace trace_event { |
13 | 14 |
14 class ProcessMemoryDump; | 15 class ProcessMemoryDump; |
15 | 16 |
16 // Contains information about the type of memory dump the MemoryDumpProvider | 17 // Args passed to OnMemoryDump(). This is to avoid rewriting all the subclasses |
17 // should generate on dump request. This is to control the size of dumps | 18 // in the codebase when extending the MemoryDumpProvider API. |
18 // generated. | |
19 struct MemoryDumpArgs { | 19 struct MemoryDumpArgs { |
20 enum class LevelOfDetail { | 20 MemoryDumpLevelOfDetail level_of_detail; |
21 LOW, | |
22 HIGH, | |
23 LAST = HIGH // For IPC Macros. | |
24 }; | |
25 | |
26 LevelOfDetail level_of_detail; | |
27 }; | 21 }; |
28 | 22 |
29 // The contract interface that memory dump providers must implement. | 23 // The contract interface that memory dump providers must implement. |
30 class BASE_EXPORT MemoryDumpProvider { | 24 class BASE_EXPORT MemoryDumpProvider { |
31 public: | 25 public: |
32 // Called by the MemoryDumpManager when generating memory dumps. | 26 // Called by the MemoryDumpManager when generating memory dumps. |
33 // The |args| specify if the embedder should generate light/heavy dumps on | 27 // The |args| specify if the embedder should generate light/heavy dumps on |
34 // dump requests. The embedder should return true if the |pmd| was | 28 // dump requests. The embedder should return true if the |pmd| was |
35 // successfully populated, false if something went wrong and the dump should | 29 // successfully populated, false if something went wrong and the dump should |
36 // be considered invalid. | 30 // be considered invalid. |
37 // (Note, the MemoryDumpManager has a fail-safe logic which will disable the | 31 // (Note, the MemoryDumpManager has a fail-safe logic which will disable the |
38 // MemoryDumpProvider for the entire trace session if it fails consistently). | 32 // MemoryDumpProvider for the entire trace session if it fails consistently). |
39 virtual bool OnMemoryDump(const MemoryDumpArgs& args, | 33 virtual bool OnMemoryDump(const MemoryDumpArgs& args, |
40 ProcessMemoryDump* pmd) = 0; | 34 ProcessMemoryDump* pmd) = 0; |
41 | 35 |
42 protected: | 36 protected: |
43 MemoryDumpProvider() {} | 37 MemoryDumpProvider() {} |
44 virtual ~MemoryDumpProvider() {} | 38 virtual ~MemoryDumpProvider() {} |
45 | 39 |
46 DISALLOW_COPY_AND_ASSIGN(MemoryDumpProvider); | 40 DISALLOW_COPY_AND_ASSIGN(MemoryDumpProvider); |
47 }; | 41 }; |
48 | 42 |
49 } // namespace trace_event | 43 } // namespace trace_event |
50 } // namespace base | 44 } // namespace base |
51 | 45 |
52 #endif // BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ | 46 #endif // BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ |
OLD | NEW |