1 // Copyright 2013 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.
5 #ifndef COMPONENTS_STARTUP_METRIC_UTILS_STARTUP_METRIC_UTILS_H_
6 #define COMPONENTS_STARTUP_METRIC_UTILS_STARTUP_METRIC_UTILS_H_
10 #include "base/time/time.h"
12 // Utility functions to support metric collection for browser startup.
14 namespace startup_metric_utils {
16 // Returns true if any UI other than the browser window has been displayed
17 // so far. Useful to test if UI has been displayed before the first browser
18 // window was shown, which would invalidate any surrounding timing metrics.
19 bool WasNonBrowserUIDisplayed();
21 // Call this when displaying UI that might potentially delay the appearance
22 // of the initial browser window on Chrome startup.
24 // Note on usage: This function is idempotent and its overhead is low enough
25 // in comparison with UI display that it's OK to call it on every
26 // UI invocation regardless of whether the browser window has already
27 // been displayed or not.
28 void SetNonBrowserUIDisplayed();
30 // Call this as early as possible in the startup process to record a
32 void RecordMainEntryPointTime();
34 #if defined(OS_ANDROID)
35 // On Android the entry point time is the time at which the Java code starts.
36 // This is recorded on the Java side, and then passed to the C++ side once the
37 // C++ library is loaded and running.
38 void RecordSavedMainEntryPointTime(const base::Time& entry_point_time);
41 // Called just before the message loop is about to start. Entry point to record
43 // |is_first_run| - is the current launch part of a first run.
44 void OnBrowserStartupComplete(bool is_first_run);
46 // Called when the initial page load has finished in order to record startup
48 void OnInitialPageLoadComplete();
50 // Scoper that records the time period before it's destructed in a histogram
51 // with the given name. The histogram is only recorded for slow chrome startups.
52 // Useful for trying to figure out what parts of Chrome cause slow startup.
53 class ScopedSlowStartupUMA {
55 explicit ScopedSlowStartupUMA(const std::string& histogram_name)
56 : start_time_(base::TimeTicks::Now()),
57 histogram_name_(histogram_name) {}
59 ~ScopedSlowStartupUMA();
62 const base::TimeTicks start_time_;
63 const std::string histogram_name_;
65 DISALLOW_COPY_AND_ASSIGN(ScopedSlowStartupUMA);
68 } // namespace startup_metric_utils
70 #endif // COMPONENTS_STARTUP_METRIC_UTILS_STARTUP_METRIC_UTILS_H_