OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 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_TRACE_EVENT_TRACE_EVENT_MEMORY_H_ | 5 #ifndef BASE_TRACE_EVENT_TRACE_EVENT_MEMORY_H_ |
6 #define BASE_TRACE_EVENT_TRACE_EVENT_MEMORY_H_ | 6 #define BASE_TRACE_EVENT_TRACE_EVENT_MEMORY_H_ |
7 | 7 |
8 #include "base/base_export.h" | 8 #include "base/base_export.h" |
9 #include "base/gtest_prod_util.h" | 9 #include "base/gtest_prod_util.h" |
10 #include "base/memory/ref_counted.h" | 10 #include "base/memory/ref_counted.h" |
11 #include "base/memory/weak_ptr.h" | 11 #include "base/memory/weak_ptr.h" |
12 #include "base/timer/timer.h" | 12 #include "base/timer/timer.h" |
13 #include "base/trace_event/trace_event_impl.h" | 13 #include "base/trace_event/trace_event_impl.h" |
14 | 14 |
15 // TODO(jamescook): Windows support for memory tracing. | 15 // TODO(jamescook): Windows support for memory tracing. |
16 #if !defined(NO_TCMALLOC) && !defined(OS_NACL) && \ | 16 #if !defined(NO_TCMALLOC) && !defined(OS_NACL) && \ |
17 (defined(OS_LINUX) || defined(OS_ANDROID)) | 17 (defined(OS_LINUX) || defined(OS_ANDROID)) |
18 #define TCMALLOC_TRACE_MEMORY_SUPPORTED 1 | 18 #define TCMALLOC_TRACE_MEMORY_SUPPORTED 1 |
19 #endif | 19 #endif |
20 | 20 |
21 namespace base { | 21 namespace base { |
22 | 22 |
23 class MessageLoopProxy; | 23 class SingleThreadTaskRunner; |
24 | 24 |
25 namespace trace_event { | 25 namespace trace_event { |
26 | 26 |
27 // Watches for chrome://tracing to be enabled or disabled. When tracing is | 27 // Watches for chrome://tracing to be enabled or disabled. When tracing is |
28 // enabled, also enables tcmalloc heap profiling. This class is the preferred | 28 // enabled, also enables tcmalloc heap profiling. This class is the preferred |
29 // way to turn trace-base heap memory profiling on and off. | 29 // way to turn trace-base heap memory profiling on and off. |
30 class BASE_EXPORT TraceMemoryController | 30 class BASE_EXPORT TraceMemoryController |
31 : public TraceLog::EnabledStateObserver { | 31 : public TraceLog::EnabledStateObserver { |
32 public: | 32 public: |
33 typedef int (*StackGeneratorFunction)(int skip_count, void** stack); | 33 typedef int (*StackGeneratorFunction)(int skip_count, void** stack); |
34 typedef void (*HeapProfilerStartFunction)(StackGeneratorFunction callback); | 34 typedef void (*HeapProfilerStartFunction)(StackGeneratorFunction callback); |
35 typedef void (*HeapProfilerStopFunction)(); | 35 typedef void (*HeapProfilerStopFunction)(); |
36 typedef char* (*GetHeapProfileFunction)(); | 36 typedef char* (*GetHeapProfileFunction)(); |
37 | 37 |
38 // |message_loop_proxy| must be a proxy to the primary thread for the client | 38 // |task_runner| must be a task runner for the primary thread for the client |
39 // process, e.g. the UI thread in a browser. The function pointers must be | 39 // process, e.g. the UI thread in a browser. The function pointers must be |
40 // pointers to tcmalloc heap profiling functions; by avoiding direct calls to | 40 // pointers to tcmalloc heap profiling functions; by avoiding direct calls to |
41 // these functions we avoid a dependency on third_party/tcmalloc from base. | 41 // these functions we avoid a dependency on third_party/tcmalloc from base. |
42 TraceMemoryController( | 42 TraceMemoryController(scoped_refptr<SingleThreadTaskRunner> task_runner, |
43 scoped_refptr<MessageLoopProxy> message_loop_proxy, | 43 HeapProfilerStartFunction heap_profiler_start_function, |
44 HeapProfilerStartFunction heap_profiler_start_function, | 44 HeapProfilerStopFunction heap_profiler_stop_function, |
45 HeapProfilerStopFunction heap_profiler_stop_function, | 45 GetHeapProfileFunction get_heap_profile_function); |
46 GetHeapProfileFunction get_heap_profile_function); | |
47 virtual ~TraceMemoryController(); | 46 virtual ~TraceMemoryController(); |
48 | 47 |
49 // base::trace_event::TraceLog::EnabledStateChangedObserver overrides: | 48 // base::trace_event::TraceLog::EnabledStateChangedObserver overrides: |
50 void OnTraceLogEnabled() override; | 49 void OnTraceLogEnabled() override; |
51 void OnTraceLogDisabled() override; | 50 void OnTraceLogDisabled() override; |
52 | 51 |
53 // Starts heap memory profiling. | 52 // Starts heap memory profiling. |
54 void StartProfiling(); | 53 void StartProfiling(); |
55 | 54 |
56 // Captures a heap profile. | 55 // Captures a heap profile. |
57 void DumpMemoryProfile(); | 56 void DumpMemoryProfile(); |
58 | 57 |
59 // If memory tracing is enabled, dumps a memory profile to the tracing system. | 58 // If memory tracing is enabled, dumps a memory profile to the tracing system. |
60 void StopProfiling(); | 59 void StopProfiling(); |
61 | 60 |
62 private: | 61 private: |
63 FRIEND_TEST_ALL_PREFIXES(TraceMemoryTest, TraceMemoryController); | 62 FRIEND_TEST_ALL_PREFIXES(TraceMemoryTest, TraceMemoryController); |
64 | 63 |
65 bool IsTimerRunningForTest() const; | 64 bool IsTimerRunningForTest() const; |
66 | 65 |
67 // Ensures the observer starts and stops tracing on the primary thread. | 66 // Ensures the observer starts and stops tracing on the primary thread. |
68 scoped_refptr<MessageLoopProxy> message_loop_proxy_; | 67 scoped_refptr<SingleThreadTaskRunner> task_runner_; |
69 | 68 |
70 // Pointers to tcmalloc heap profiling functions. Allows this class to use | 69 // Pointers to tcmalloc heap profiling functions. Allows this class to use |
71 // tcmalloc functions without introducing a dependency from base to tcmalloc. | 70 // tcmalloc functions without introducing a dependency from base to tcmalloc. |
72 HeapProfilerStartFunction heap_profiler_start_function_; | 71 HeapProfilerStartFunction heap_profiler_start_function_; |
73 HeapProfilerStopFunction heap_profiler_stop_function_; | 72 HeapProfilerStopFunction heap_profiler_stop_function_; |
74 GetHeapProfileFunction get_heap_profile_function_; | 73 GetHeapProfileFunction get_heap_profile_function_; |
75 | 74 |
76 // Timer to schedule memory profile dumps. | 75 // Timer to schedule memory profile dumps. |
77 RepeatingTimer<TraceMemoryController> dump_timer_; | 76 RepeatingTimer<TraceMemoryController> dump_timer_; |
78 | 77 |
(...skipping 84 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
163 #else | 162 #else |
164 #define INTERNAL_TRACE_MEMORY(category, name) | 163 #define INTERNAL_TRACE_MEMORY(category, name) |
165 #endif // defined(TRACE_MEMORY_SUPPORTED) | 164 #endif // defined(TRACE_MEMORY_SUPPORTED) |
166 | 165 |
167 // A special trace name that allows us to ignore memory allocations inside | 166 // A special trace name that allows us to ignore memory allocations inside |
168 // the memory dump system itself. The allocations are recorded, but the | 167 // the memory dump system itself. The allocations are recorded, but the |
169 // visualizer skips them. Must match the value in heap.js. | 168 // visualizer skips them. Must match the value in heap.js. |
170 #define TRACE_MEMORY_IGNORE "trace-memory-ignore" | 169 #define TRACE_MEMORY_IGNORE "trace-memory-ignore" |
171 | 170 |
172 #endif // BASE_TRACE_EVENT_TRACE_EVENT_MEMORY_H_ | 171 #endif // BASE_TRACE_EVENT_TRACE_EVENT_MEMORY_H_ |
OLD | NEW |