OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 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_PROFILER_SCOPED_TRACKER_H_ | 5 #ifndef BASE_PROFILER_SCOPED_TRACKER_H_ |
6 #define BASE_PROFILER_SCOPED_TRACKER_H_ | 6 #define BASE_PROFILER_SCOPED_TRACKER_H_ |
7 | 7 |
8 //------------------------------------------------------------------------------ | 8 //------------------------------------------------------------------------------ |
9 // Utilities for temporarily instrumenting code to dig into issues that were | 9 // Utilities for temporarily instrumenting code to dig into issues that were |
10 // found using profiler data. | 10 // found using profiler data. |
11 | 11 |
12 #include "base/base_export.h" | 12 #include "base/base_export.h" |
13 #include "base/callback_forward.h" | 13 #include "base/callback_forward.h" |
14 #include "base/location.h" | 14 #include "base/location.h" |
15 #include "base/profiler/scoped_profile.h" | 15 #include "base/profiler/scoped_profile.h" |
16 | 16 |
17 namespace tracked_objects { | 17 namespace tracked_objects { |
18 | 18 |
19 // ScopedTracker instruments a region within the code if the instrumentation is | 19 // ScopedTracker instruments a region within the code if the instrumentation is |
20 // enabled. It can be used, for example, to find out if a source of jankiness is | 20 // enabled. It can be used, for example, to find out if a source of jankiness is |
21 // inside the instrumented code region. | 21 // inside the instrumented code region. |
| 22 // Details: |
| 23 // 1. This class creates a task (like ones created by PostTask calls or IPC |
| 24 // message handlers). This task can be seen in chrome://profiler and is sent as |
| 25 // a part of profiler data to the UMA server. See profiler_event.proto. |
| 26 // 2. That task's lifetime is same as the lifetime of the ScopedTracker |
| 27 // instance. |
| 28 // 3. The execution time associated with the task is the wallclock time between |
| 29 // its constructor and destructor, minus wallclock times of directly nested |
| 30 // tasks. |
| 31 // 4. Task creation that this class utilizes is highly optimized. |
| 32 // 5. The class doesn't create a task unless this was enabled for the current |
| 33 // process. Search for ScopedTracker::Enable for the current list of processes |
| 34 // and channels where it's activated. |
| 35 // 6. The class is designed for temporarily instrumenting code to find |
| 36 // performance problems, after which the instrumentation must be removed. |
22 class BASE_EXPORT ScopedTracker { | 37 class BASE_EXPORT ScopedTracker { |
23 public: | 38 public: |
24 ScopedTracker(const Location& location); | 39 ScopedTracker(const Location& location); |
25 | 40 |
26 // Enables instrumentation for the remainder of the current process' life. If | 41 // Enables instrumentation for the remainder of the current process' life. If |
27 // this function is not called, all profiler instrumentations are no-ops. | 42 // this function is not called, all profiler instrumentations are no-ops. |
28 static void Enable(); | 43 static void Enable(); |
29 | 44 |
30 // Augments a |callback| with provided |location|. This is useful for | 45 // Augments a |callback| with provided |location|. This is useful for |
31 // instrumenting cases when we know that a jank is in a callback and there are | 46 // instrumenting cases when we know that a jank is in a callback and there are |
32 // many possible callbacks, but they come from a relatively small number of | 47 // many possible callbacks, but they come from a relatively small number of |
33 // places. We can instrument these few places and at least know which one | 48 // places. We can instrument these few places and at least know which one |
34 // passes the janky callback. | 49 // passes the janky callback. |
35 static base::Closure TrackCallback(const Location& location, | 50 static base::Closure TrackCallback(const Location& location, |
36 const base::Closure& callback); | 51 const base::Closure& callback); |
37 | 52 |
38 private: | 53 private: |
39 const ScopedProfile scoped_profile_; | 54 const ScopedProfile scoped_profile_; |
40 | 55 |
41 DISALLOW_COPY_AND_ASSIGN(ScopedTracker); | 56 DISALLOW_COPY_AND_ASSIGN(ScopedTracker); |
42 }; | 57 }; |
43 | 58 |
44 } // namespace tracked_objects | 59 } // namespace tracked_objects |
45 | 60 |
46 #endif // BASE_PROFILER_SCOPED_TRACKER_H_ | 61 #endif // BASE_PROFILER_SCOPED_TRACKER_H_ |
OLD | NEW |