Tag all tracked objects, including Tasks, with the program counter at the site of FROM_HERE.

base/tracked.h

 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 //------------------------------------------------------------------------------
 // Tracked is the base class for all tracked objects.  During construction, it
 // registers the fact that an instance was created, and at destruction time, it
 // records that event.  The instance may be tagged with a name, which is refered
 // to as its Location.  The Location is a file and line number, most
 // typically indicated where the object was constructed.  In some cases, as the
@@ skipping 23 matching lines @@
 
 //------------------------------------------------------------------------------
 // Location provides basic info where of an object was constructed, or was
 // significantly brought to life.
 
 class BASE_API Location {
  public:
   // Constructor should be called with a long-lived char*, such as __FILE__.
   // It assumes the provided value will persist as a global constant, and it
   // will not make a copy of it.
-  Location(const char* function_name, const char* file_name, int line_number);
+  Location(const char* function_name,
+           const char* file_name,
+           int line_number,
+           void* program_counter);
 
   // Provide a default constructor for easy of debugging.
   Location();
 
   // Comparison operator for insertion into a std::map<> hash tables.
   // All we need is *some* (any) hashing distinction.  Strings should already
   // be unique, so we don't bother with strcmp or such.
   // Use line number as the primary key (because it is fast, and usually gets us
   // a difference), and then pointers as secondary keys (just to get some
   // distinctions).
   bool operator < (const Location& other) const {
     if (line_number_ != other.line_number_)
       return line_number_ < other.line_number_;
     if (file_name_ != other.file_name_)
       return file_name_ < other.file_name_;
     return function_name_ < other.function_name_;
   }
 
   const char* function_name() const { return function_name_; }
   const char* file_name()     const { return file_name_; }
   int line_number()           const { return line_number_; }
+  void* program_counter()     const { return program_counter_; }
 
   void Write(bool display_filename, bool display_function_name,
              std::string* output) const;
 
   // Write function_name_ in HTML with '<' and '>' properly encoded.
   void WriteFunctionName(std::string* output) const;
 
  private:
   const char* const function_name_;
   const char* const file_name_;
   const int line_number_;
+  void* program_counter_;

[awong, 2011/05/17 23:54:01]

This does fundamentally change the nature of this object.  If you look at the
rest of the definition of Location, it's written such that it is effectively a
constant.

I recall jar@ saying that this was done carefully to allow the compiler to
possibly even elide instances since the "class" is effectively a constant.

Adding in program_counter() breaks that performance characteristic.  This
functionality seems like a worthwhile inclusion, but we are changing some of the
fundamental semantics of tracked objects.

[cpu_(ooo_6.6-7.5), 2011/05/18 00:52:26]

But what if the program counter is const void* ?

On 2011/05/17 23:54:01, awong wrote:

[awong, 2011/05/18 01:02:45]

I don't think that const really matters too much (we should add it anyways
though).

The difference is that __FUNCTION__, __FILE__, and __LINE__ are all constants
that can be resolved in at compile time.

GetProgramCounterRegister() is specifically not such a thing.

I'm not saying there's necessarily a problem here...but I just remember jar@
noting that the Location was carefully crafted to be compile time resolvable.



On 2011/05/18 00:52:26, cpu wrote:

[apatrick_chromium, 2011/05/18 21:09:47]

I made it "const void* const" for consistency. I don't think it will help the
compiler though.

[apatrick_chromium, 2011/05/18 21:09:47]

I agree the result of GetProgramCounterRegister() is not compile time
resolvable. I examined the code generated for an optimized windows build prior
to this change (no global optimization) and the compiler was not doing anything
special for FROM_HERE:

5C50BD18  push        293h 
5C50BD1D  push        offset string ".\\browser\\safe_browsing\\safe_bro"...
(5D25874Ch) 
5C50BD22  push        offset string "SafeBrowsingService::MakeDatabas"...
(5D258C2Ch) 
5C50BD27  lea         ecx,[esp+2Ch] 
5C50BD2B  call        dword ptr [__imp_tracked_objects::Location::Location
(5D1B4C98h)] 

This change adds the overhead for invoking GetProgramCounterRegister() and
pushing it as an argument for the Location constructor.

I didn't figure out how to do an LTCG build.

 };
 
+BASE_API void* GetProgramCounterRegister();
 
 //------------------------------------------------------------------------------
 // Define a macro to record the current source location.
 
-#define FROM_HERE tracked_objects::Location(__FUNCTION__, __FILE__, __LINE__)
+#define FROM_HERE tracked_objects::Location(                                   \
+    __FUNCTION__,                                                              \
+    __FILE__,                                                                  \
+    __LINE__,                                                                  \
+    tracked_objects::GetProgramCounterRegister())                              \
 
 
 //------------------------------------------------------------------------------
 
 
 class Births;
 
 class BASE_API Tracked {
  public:
   Tracked();
   virtual ~Tracked();
 
   // Used to record the FROM_HERE location of a caller.
   void SetBirthPlace(const Location& from_here);
   const Location GetBirthPlace() const;
 
   // When a task sits around a long time, such as in a timer, or object watcher,
   // this method should be called when the task becomes active, and its
   // significant lifetime begins (and its waiting to be woken up has passed).
   void ResetBirthTime();
 
   bool MissingBirthplace() const;
 
 #if defined(TRACK_ALL_TASK_OBJECTS)
   base::TimeTicks tracked_birth_time() const { return tracked_birth_time_; }
 #else
   base::TimeTicks tracked_birth_time() const { return base::TimeTicks::Now(); }
 #endif  // defined(TRACK_ALL_TASK_OBJECTS)
 
+  void* get_birth_program_counter() const { return birth_program_counter_; }
+
  private:
 #if defined(TRACK_ALL_TASK_OBJECTS)
 
   // Pointer to instance were counts of objects with the same birth location
   // (on the same thread) are stored.
   Births* tracked_births_;
   // The time this object was constructed.  If its life consisted of a long
   // waiting period, and then it became active, then this value is generally
   // reset before the object begins it active life.
   base::TimeTicks tracked_birth_time_;
 
 #endif  // defined(TRACK_ALL_TASK_OBJECTS)
 
+  void* birth_program_counter_;
+
   DISALLOW_COPY_AND_ASSIGN(Tracked);
 };
 
 }  // namespace tracked_objects
 
 #endif  // BASE_TRACKED_H_