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 | 10 |
11 namespace base { | 11 namespace base { |
12 namespace trace_event { | 12 namespace trace_event { |
13 | 13 |
14 class ProcessMemoryDump; | 14 class ProcessMemoryDump; |
15 | 15 |
| 16 // Contains information about the type of memory dump the MemoryDumpProvider |
| 17 // should generate on dump request. This is to control the size of dumps |
| 18 // generated. |
| 19 struct MemoryDumpArgs { |
| 20 enum LevelOfDetail { LEVEL_OF_DETAIL_LOW, LEVEL_OF_DETAIL_HIGH }; |
| 21 |
| 22 LevelOfDetail level_of_detail; |
| 23 }; |
| 24 |
16 // The contract interface that memory dump providers must implement. | 25 // The contract interface that memory dump providers must implement. |
17 class BASE_EXPORT MemoryDumpProvider { | 26 class BASE_EXPORT MemoryDumpProvider { |
18 public: | 27 public: |
19 // Called by the MemoryDumpManager when generating memory dumps. | 28 // Called by the MemoryDumpManager when generating memory dumps. |
20 // The embedder should return true if the |pmd| was successfully populated, | 29 // The |args| specify if the embedder should generate light/heavy dumps on |
21 // false if something went wrong and the dump should be considered invalid. | 30 // dump requests. The embedder should return true if the |pmd| was |
| 31 // successfully populated, false if something went wrong and the dump should |
| 32 // be considered invalid. |
22 // (Note, the MemoryDumpManager has a fail-safe logic which will disable the | 33 // (Note, the MemoryDumpManager has a fail-safe logic which will disable the |
23 // MemoryDumpProvider for the entire trace session if it fails consistently). | 34 // MemoryDumpProvider for the entire trace session if it fails consistently). |
24 virtual bool OnMemoryDump(ProcessMemoryDump* pmd) = 0; | 35 virtual bool OnMemoryDump(const MemoryDumpArgs& args, |
| 36 ProcessMemoryDump* pmd) = 0; |
25 | 37 |
26 protected: | 38 protected: |
27 MemoryDumpProvider() {} | 39 MemoryDumpProvider() {} |
28 virtual ~MemoryDumpProvider() {} | 40 virtual ~MemoryDumpProvider() {} |
29 | 41 |
30 DISALLOW_COPY_AND_ASSIGN(MemoryDumpProvider); | 42 DISALLOW_COPY_AND_ASSIGN(MemoryDumpProvider); |
31 }; | 43 }; |
32 | 44 |
33 } // namespace trace_event | 45 } // namespace trace_event |
34 } // namespace base | 46 } // namespace base |
35 | 47 |
36 #endif // BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ | 48 #endif // BASE_TRACE_EVENT_MEMORY_DUMP_PROVIDER_H_ |
OLD | NEW |