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