OLD | NEW |
| (Empty) |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 //------------------------------------------------------------------------------ | |
6 // Tracked is the base class for all tracked objects. During construction, it | |
7 // registers the fact that an instance was created, and at destruction time, it | |
8 // records that event. The instance may be tagged with a name, which is refered | |
9 // to as its Location. The Location is a file and line number, most | |
10 // typically indicated where the object was constructed. In some cases, as the | |
11 // object's significance is refined (for example, a Task object is augmented to | |
12 // do additonal things), its Location may be redefined to that later location. | |
13 | |
14 // Tracking includes (for each instance) recording the birth thread, death | |
15 // thread, and duration of life (from construction to destruction). All this | |
16 // data is accumulated and filtered for review at about:objects. | |
17 | |
18 #ifndef BASE_TRACKED_H_ | |
19 #define BASE_TRACKED_H_ | |
20 #pragma once | |
21 | |
22 #include <string> | |
23 | |
24 #include "base/base_export.h" | |
25 #include "base/time.h" | |
26 | |
27 #ifndef NDEBUG | |
28 #ifndef TRACK_ALL_TASK_OBJECTS | |
29 #define TRACK_ALL_TASK_OBJECTS | |
30 #endif // TRACK_ALL_TASK_OBJECTS | |
31 #endif // NDEBUG | |
32 | |
33 namespace tracked_objects { | |
34 | |
35 //------------------------------------------------------------------------------ | |
36 // Location provides basic info where of an object was constructed, or was | |
37 // significantly brought to life. | |
38 | |
39 class BASE_EXPORT Location { | |
40 public: | |
41 // Constructor should be called with a long-lived char*, such as __FILE__. | |
42 // It assumes the provided value will persist as a global constant, and it | |
43 // will not make a copy of it. | |
44 Location(const char* function_name, | |
45 const char* file_name, | |
46 int line_number, | |
47 const void* program_counter); | |
48 | |
49 // Provide a default constructor for easy of debugging. | |
50 Location(); | |
51 | |
52 // Comparison operator for insertion into a std::map<> hash tables. | |
53 // All we need is *some* (any) hashing distinction. Strings should already | |
54 // be unique, so we don't bother with strcmp or such. | |
55 // Use line number as the primary key (because it is fast, and usually gets us | |
56 // a difference), and then pointers as secondary keys (just to get some | |
57 // distinctions). | |
58 bool operator < (const Location& other) const { | |
59 if (line_number_ != other.line_number_) | |
60 return line_number_ < other.line_number_; | |
61 if (file_name_ != other.file_name_) | |
62 return file_name_ < other.file_name_; | |
63 return function_name_ < other.function_name_; | |
64 } | |
65 | |
66 const char* function_name() const { return function_name_; } | |
67 const char* file_name() const { return file_name_; } | |
68 int line_number() const { return line_number_; } | |
69 const void* program_counter() const { return program_counter_; } | |
70 | |
71 std::string ToString() const; | |
72 | |
73 void Write(bool display_filename, bool display_function_name, | |
74 std::string* output) const; | |
75 | |
76 // Write function_name_ in HTML with '<' and '>' properly encoded. | |
77 void WriteFunctionName(std::string* output) const; | |
78 | |
79 private: | |
80 const char* const function_name_; | |
81 const char* const file_name_; | |
82 const int line_number_; | |
83 const void* const program_counter_; | |
84 }; | |
85 | |
86 BASE_EXPORT const void* GetProgramCounter(); | |
87 | |
88 //------------------------------------------------------------------------------ | |
89 // Define a macro to record the current source location. | |
90 | |
91 #define FROM_HERE tracked_objects::Location( \ | |
92 __FUNCTION__, \ | |
93 __FILE__, \ | |
94 __LINE__, \ | |
95 tracked_objects::GetProgramCounter()) \ | |
96 | |
97 | |
98 //------------------------------------------------------------------------------ | |
99 | |
100 | |
101 class Births; | |
102 | |
103 class BASE_EXPORT Tracked { | |
104 public: | |
105 Tracked(); | |
106 virtual ~Tracked(); | |
107 | |
108 // Used to record the FROM_HERE location of a caller. | |
109 void SetBirthPlace(const Location& from_here); | |
110 const Location GetBirthPlace() const; | |
111 | |
112 // When a task sits around a long time, such as in a timer, or object watcher, | |
113 // this method should be called when the task becomes active, and its | |
114 // significant lifetime begins (and its waiting to be woken up has passed). | |
115 void ResetBirthTime(); | |
116 | |
117 bool MissingBirthPlace() const; | |
118 | |
119 #if defined(TRACK_ALL_TASK_OBJECTS) | |
120 base::TimeTicks tracked_birth_time() const { return tracked_birth_time_; } | |
121 #else | |
122 base::TimeTicks tracked_birth_time() const { return base::TimeTicks::Now(); } | |
123 #endif // defined(TRACK_ALL_TASK_OBJECTS) | |
124 | |
125 // Returns null if SetBirthPlace has not been called. | |
126 const void* get_birth_program_counter() const { | |
127 return birth_program_counter_; | |
128 } | |
129 | |
130 private: | |
131 #if defined(TRACK_ALL_TASK_OBJECTS) | |
132 | |
133 // Pointer to instance were counts of objects with the same birth location | |
134 // (on the same thread) are stored. | |
135 Births* tracked_births_; | |
136 // The time this object was constructed. If its life consisted of a long | |
137 // waiting period, and then it became active, then this value is generally | |
138 // reset before the object begins it active life. | |
139 base::TimeTicks tracked_birth_time_; | |
140 | |
141 #endif // defined(TRACK_ALL_TASK_OBJECTS) | |
142 | |
143 const void* birth_program_counter_; | |
144 | |
145 DISALLOW_COPY_AND_ASSIGN(Tracked); | |
146 }; | |
147 | |
148 } // namespace tracked_objects | |
149 | |
150 #endif // BASE_TRACKED_H_ | |
OLD | NEW |