Home | History | Annotate | Download | only in profiler 
      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 #ifndef BASE_PROFILER_SCOPED_PROFILE_H_
      7 #define BASE_PROFILER_SCOPED_PROFILE_H_
      8 
      9 //------------------------------------------------------------------------------
     10 // ScopedProfile provides basic helper functions for profiling a short
     11 // region of code within a scope.  It is separate from the related ThreadData
     12 // class so that it can be included without much other cruft, and provide the
     13 // macros listed below.
     14 
     15 #include "base/base_export.h"
     16 #include "base/location.h"
     17 #include "base/macros.h"
     18 #include "base/profiler/tracked_time.h"
     19 #include "base/tracked_objects.h"
     20 
     21 #define PASTE_LINE_NUMBER_ON_NAME(name, line) name##line
     22 
     23 #define LINE_BASED_VARIABLE_NAME_FOR_PROFILING                                 \
     24     PASTE_LINE_NUMBER_ON_NAME(some_profiler_variable_, __LINE__)
     25 
     26 // Defines the containing scope as a profiled region. This allows developers to
     27 // profile their code and see results on their about:profiler page, as well as
     28 // on the UMA dashboard.
     29 #define TRACK_RUN_IN_THIS_SCOPED_REGION(dispatch_function_name)            \
     30   ::tracked_objects::ScopedProfile LINE_BASED_VARIABLE_NAME_FOR_PROFILING( \
     31       FROM_HERE_WITH_EXPLICIT_FUNCTION(#dispatch_function_name),           \
     32       ::tracked_objects::ScopedProfile::ENABLED)
     33 
     34 // Same as TRACK_RUN_IN_THIS_SCOPED_REGION except that there's an extra param
     35 // which is concatenated with the function name for better filtering.
     36 #define TRACK_SCOPED_REGION(category_name, dispatch_function_name)         \
     37   ::tracked_objects::ScopedProfile LINE_BASED_VARIABLE_NAME_FOR_PROFILING( \
     38       FROM_HERE_WITH_EXPLICIT_FUNCTION(                                    \
     39           "[" category_name "]" dispatch_function_name),                   \
     40       ::tracked_objects::ScopedProfile::ENABLED)
     41 
     42 namespace tracked_objects {
     43 class Births;
     44 
     45 class BASE_EXPORT ScopedProfile {
     46  public:
     47   // Mode of operation. Specifies whether ScopedProfile should be a no-op or
     48   // needs to create and tally a task.
     49   enum Mode {
     50     DISABLED,  // Do nothing.
     51     ENABLED    // Create and tally a task.
     52   };
     53 
     54   ScopedProfile(const Location& location, Mode mode);
     55   ~ScopedProfile();
     56 
     57  private:
     58   Births* birth_;  // Place in code where tracking started.
     59   TaskStopwatch stopwatch_;
     60 
     61   DISALLOW_COPY_AND_ASSIGN(ScopedProfile);
     62 };
     63 
     64 }  // namespace tracked_objects
     65 
     66 #endif  // BASE_PROFILER_SCOPED_PROFILE_H_
     67