components/metrics/profiler/tracking_synchronizer_observer.h

   1 // Copyright (c) 2012 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 #ifndef COMPONENTS_METRICS_PROFILER_TRACKING_SYNCHRONIZER_OBSERVER_H_
   6 #define COMPONENTS_METRICS_PROFILER_TRACKING_SYNCHRONIZER_OBSERVER_H_
   7
   8 #include <vector>
   9
  10 #include "base/process/process_handle.h"
  11 #include "components/metrics/proto/chrome_user_metrics_extension.pb.h"
  12 #include "content/public/common/process_type.h"
  13
  14 namespace base {
  15 class TimeDelta;
  16 }
  17
  18 namespace tracked_objects {
  19 struct ProcessDataPhaseSnapshot;
  20 }
  21
  22 namespace metrics {
  23
  24 // Set of profiling events, in no guaranteed order. Implemented as a vector
  25 // because we don't need to have an efficient .find() on it, so vector<> is more
  26 // efficient.
  27 typedef std::vector<ProfilerEventProto::ProfilerEvent> ProfilerEvents;
  28
  29 // Observer for notifications from the TrackingSynchronizer class.
  30 class TrackingSynchronizerObserver {
  31  public:
  32   // TODO(vadimt): Consider isherman@ idea: I'd change the phase_start and
  33   // phase_finish from TimeDeltas to TimeTicks.  And I'd omit the |past_events|
  34   // list -- either in favor of a single ProfilerEvent that corresponds to the
  35   // phase, or a method on the TrackingSynchronizer that can translate a
  36   // profiling_phase to a ProfilerEvent.
  37
  38   // Received |process_data_phase| for profiling phase |profiling_phase| from a
  39   // single process of |process_type|. The phase start and finish times,
  40   // relative to the start time are |phase_start| and
  41   // |phase_finish|. All profiling phases prior to the reported one have already
  42   // completed, and each completion was associated with an instance of
  43   // ProfilerEventProto::ProfilerEvent. |past_events| contains events associated
  44   // with completions of phases prior to the reported one.
  45   // The observer should assume there might be more data coming until
  46   // FinishedReceivingData() is called.
  47   virtual void ReceivedProfilerData(
  48       const tracked_objects::ProcessDataPhaseSnapshot& process_data_phase,
  49       base::ProcessId process_id,
  50       content::ProcessType process_type,
  51       int profiling_phase,
  52       base::TimeDelta phase_start,
  53       base::TimeDelta phase_finish,
  54       const ProfilerEvents& past_events) = 0;
  55
  56   // The observer should not expect any more calls to |ReceivedProfilerData()|
  57   // (without re-registering).  This is sent either when data from all processes
  58   // has been gathered, or when the request times out.
  59   virtual void FinishedReceivingProfilerData() {}
  60
  61  protected:
  62   TrackingSynchronizerObserver() {}
  63   virtual ~TrackingSynchronizerObserver() {}
  64
  65  private:
  66   DISALLOW_COPY_AND_ASSIGN(TrackingSynchronizerObserver);
  67 };
  68
  69 }  // namespace metrics
  70
  71 #endif  // COMPONENTS_METRICS_PROFILER_TRACKING_SYNCHRONIZER_OBSERVER_H_