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 CONTENT_PUBLIC_BROWSER_TRACING_CONTROLLER_H_ | 5 #ifndef CONTENT_PUBLIC_BROWSER_TRACING_CONTROLLER_H_ |
6 #define CONTENT_PUBLIC_BROWSER_TRACING_CONTROLLER_H_ | 6 #define CONTENT_PUBLIC_BROWSER_TRACING_CONTROLLER_H_ |
7 | 7 |
8 #include <set> | 8 #include <set> |
9 #include <string> | 9 #include <string> |
10 | 10 |
11 #include "base/callback.h" | 11 #include "base/callback.h" |
12 #include "base/debug/trace_event.h" | 12 #include "base/debug/trace_event.h" |
13 #include "content/common/content_export.h" | 13 #include "content/common/content_export.h" |
14 | 14 |
15 namespace base { | |
16 class FilePath; | |
17 }; | |
18 | |
19 namespace content { | 15 namespace content { |
20 | 16 |
21 class TracingController; | 17 class TracingController; |
22 | 18 |
23 // TracingController is used on the browser processes to enable/disable | 19 // TracingController is used on the browser processes to enable/disable |
24 // trace status and collect trace data. Only the browser UI thread is allowed | 20 // trace status and collect trace data. Only the browser UI thread is allowed |
25 // to interact with the TracingController object. All callbacks are called on | 21 // to interact with the TracingController object. All callbacks are called on |
26 // the UI thread. | 22 // the UI thread. |
27 class TracingController { | 23 class TracingController { |
28 public: | 24 public: |
29 | 25 |
30 CONTENT_EXPORT static TracingController* GetInstance(); | 26 CONTENT_EXPORT static TracingController* GetInstance(); |
31 | 27 |
| 28 // An interface for trace data consumer. An implemnentation of this interface |
| 29 // is passed to either DisableTracing() or CaptureMonitoringSnapshot() and |
| 30 // receives the trace data followed by a notification that all child processes |
| 31 // have completed tracing and the data collection is over. |
| 32 // All methods are called on the UI thread. |
| 33 // Close method will be called exactly once and no methods will be |
| 34 // called after that. |
| 35 class CONTENT_EXPORT TraceDataSink { |
| 36 public: |
| 37 virtual ~TraceDataSink() {} |
| 38 |
| 39 virtual void AddTraceChunk(const std::string& chunk) {} |
| 40 virtual void SetSystemTrace(const std::string& data) {} |
| 41 virtual void Close() {} |
| 42 }; |
| 43 |
32 // Get a set of category groups. The category groups can change as | 44 // Get a set of category groups. The category groups can change as |
33 // new code paths are reached. | 45 // new code paths are reached. |
34 // | 46 // |
35 // Once all child processes have acked to the GetCategories request, | 47 // Once all child processes have acked to the GetCategories request, |
36 // GetCategoriesDoneCallback is called back with a set of category | 48 // GetCategoriesDoneCallback is called back with a set of category |
37 // groups. | 49 // groups. |
38 typedef base::Callback<void(const std::set<std::string>&)> | 50 typedef base::Callback<void(const std::set<std::string>&)> |
39 GetCategoriesDoneCallback; | 51 GetCategoriesDoneCallback; |
40 virtual bool GetCategories( | 52 virtual bool GetCategories( |
41 const GetCategoriesDoneCallback& callback) = 0; | 53 const GetCategoriesDoneCallback& callback) = 0; |
(...skipping 27 matching lines...) Expand all Loading... |
69 // Child processes typically are caching trace data and only rarely flush | 81 // Child processes typically are caching trace data and only rarely flush |
70 // and send trace data back to the browser process. That is because it may be | 82 // and send trace data back to the browser process. That is because it may be |
71 // an expensive operation to send the trace data over IPC, and we would like | 83 // an expensive operation to send the trace data over IPC, and we would like |
72 // to avoid much runtime overhead of tracing. So, to end tracing, we must | 84 // to avoid much runtime overhead of tracing. So, to end tracing, we must |
73 // asynchronously ask all child processes to flush any pending trace data. | 85 // asynchronously ask all child processes to flush any pending trace data. |
74 // | 86 // |
75 // Once all child processes have acked to the DisableRecording request, | 87 // Once all child processes have acked to the DisableRecording request, |
76 // TracingFileResultCallback will be called back with a file that contains | 88 // TracingFileResultCallback will be called back with a file that contains |
77 // the traced data. | 89 // the traced data. |
78 // | 90 // |
79 // Trace data will be written into |result_file_path| if it is not empty, or | 91 // If |trace_data_sink| is not null, it will receive chunks of trace data |
80 // into a temporary file. The actual file path will be passed to |callback| if | 92 // as a comma-separated sequences of JSON-stringified events, followed by |
81 // it's not null. | 93 // a notification that the trace collection is finished. |
82 // | 94 // |
83 // If |result_file_path| is empty and |callback| is null, trace data won't be | 95 virtual bool DisableRecording(TraceDataSink *trace_data_sink) = 0; |
84 // written to any file. | |
85 typedef base::Callback<void(const base::FilePath&)> TracingFileResultCallback; | |
86 virtual bool DisableRecording(const base::FilePath& result_file_path, | |
87 const TracingFileResultCallback& callback) = 0; | |
88 | 96 |
89 // Start monitoring on all processes. | 97 // Start monitoring on all processes. |
90 // | 98 // |
91 // Monitoring begins immediately locally, and asynchronously on child | 99 // Monitoring begins immediately locally, and asynchronously on child |
92 // processes as soon as they receive the EnableMonitoring request. | 100 // processes as soon as they receive the EnableMonitoring request. |
93 // | 101 // |
94 // Once all child processes have acked to the EnableMonitoring request, | 102 // Once all child processes have acked to the EnableMonitoring request, |
95 // EnableMonitoringDoneCallback will be called back. | 103 // EnableMonitoringDoneCallback will be called back. |
96 // | 104 // |
97 // |category_filter| is a filter to control what category groups should be | 105 // |category_filter| is a filter to control what category groups should be |
(...skipping 25 matching lines...) Expand all Loading... |
123 // Child processes typically are caching trace data and only rarely flush | 131 // Child processes typically are caching trace data and only rarely flush |
124 // and send trace data back to the browser process. That is because it may be | 132 // and send trace data back to the browser process. That is because it may be |
125 // an expensive operation to send the trace data over IPC, and we would like | 133 // an expensive operation to send the trace data over IPC, and we would like |
126 // to avoid much runtime overhead of tracing. So, to end tracing, we must | 134 // to avoid much runtime overhead of tracing. So, to end tracing, we must |
127 // asynchronously ask all child processes to flush any pending trace data. | 135 // asynchronously ask all child processes to flush any pending trace data. |
128 // | 136 // |
129 // Once all child processes have acked to the CaptureMonitoringSnapshot | 137 // Once all child processes have acked to the CaptureMonitoringSnapshot |
130 // request, TracingFileResultCallback will be called back with a file that | 138 // request, TracingFileResultCallback will be called back with a file that |
131 // contains the traced data. | 139 // contains the traced data. |
132 // | 140 // |
133 // Trace data will be written into |result_file_path| if it is not empty, or | 141 // If |trace_data_sink| is not null, it will receive chunks of trace data |
134 // into a temporary file. The actual file path will be passed to |callback|. | 142 // as a comma-separated sequences of JSON-stringified events, followed by |
135 // | 143 // a notification that the trace collection is finished. |
136 // If |result_file_path| is empty and |callback| is null, trace data won't be | 144 virtual bool CaptureMonitoringSnapshot(TraceDataSink* trace_data_sink) = 0; |
137 // written to any file. | |
138 virtual bool CaptureMonitoringSnapshot( | |
139 const base::FilePath& result_file_path, | |
140 const TracingFileResultCallback& callback) = 0; | |
141 | 145 |
142 // Get the maximum across processes of trace buffer percent full state. | 146 // Get the maximum across processes of trace buffer percent full state. |
143 // When the TraceBufferPercentFull value is determined, the callback is | 147 // When the TraceBufferPercentFull value is determined, the callback is |
144 // called. | 148 // called. |
145 typedef base::Callback<void(float)> GetTraceBufferPercentFullCallback; | 149 typedef base::Callback<void(float)> GetTraceBufferPercentFullCallback; |
146 virtual bool GetTraceBufferPercentFull( | 150 virtual bool GetTraceBufferPercentFull( |
147 const GetTraceBufferPercentFullCallback& callback) = 0; | 151 const GetTraceBufferPercentFullCallback& callback) = 0; |
148 | 152 |
149 // |callback| will will be called every time the given event occurs on any | 153 // |callback| will will be called every time the given event occurs on any |
150 // process. | 154 // process. |
151 typedef base::Callback<void()> WatchEventCallback; | 155 typedef base::Callback<void()> WatchEventCallback; |
152 virtual bool SetWatchEvent(const std::string& category_name, | 156 virtual bool SetWatchEvent(const std::string& category_name, |
153 const std::string& event_name, | 157 const std::string& event_name, |
154 const WatchEventCallback& callback) = 0; | 158 const WatchEventCallback& callback) = 0; |
155 | 159 |
156 // Cancel the watch event. If tracing is enabled, this may race with the | 160 // Cancel the watch event. If tracing is enabled, this may race with the |
157 // watch event callback. | 161 // watch event callback. |
158 virtual bool CancelWatchEvent() = 0; | 162 virtual bool CancelWatchEvent() = 0; |
159 | 163 |
160 protected: | 164 protected: |
161 virtual ~TracingController() {} | 165 virtual ~TracingController() {} |
162 }; | 166 }; |
163 | 167 |
164 } // namespace content | 168 } // namespace content |
165 | 169 |
166 #endif // CONTENT_PUBLIC_BROWSER_TRACING_CONTROLLER_H_ | 170 #endif // CONTENT_PUBLIC_BROWSER_TRACING_CONTROLLER_H_ |
OLD | NEW |