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