1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_ASH_ARC_TRACING_ARC_APP_PERFORMANCE_TRACING_H_
#define CHROME_BROWSER_ASH_ARC_TRACING_ARC_APP_PERFORMANCE_TRACING_H_
#include <stdint.h>
#include <map>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "chrome/browser/ash/app_list/arc/arc_app_list_prefs.h"
#include "chrome/browser/ash/arc/tracing/arc_app_performance_tracing_session.h"
#include "chrome/browser/ash/arc/tracing/uma_perf_reporting.h"
#include "chromeos/ash/experiences/arc/mojom/metrics.mojom.h"
#include "components/exo/surface_observer.h"
#include "components/keyed_service/core/keyed_service.h"
#include "ui/aura/window_observer.h"
#include "ui/display/display_observer.h"
#include "ui/wm/public/activation_change_observer.h"
namespace aura {
class Window;
} // namespace aura
namespace content {
class BrowserContext;
} // namespace content
namespace arc {
class ArcAppPerformanceTracingSession;
class ArcBridgeService;
// Service that monitors ARC++ apps, measures and reports performance metrics
// for the set of predefined apps. Also report GFX metrics jankiness results.
class ArcAppPerformanceTracing : public KeyedService,
public wm::ActivationChangeObserver,
public aura::WindowObserver,
public ArcAppListPrefs::Observer,
public exo::SurfaceObserver,
public display::DisplayObserver {
public:
using CustomSessionReadyCallback = base::RepeatingCallback<void()>;
ArcAppPerformanceTracing(content::BrowserContext* context,
ArcBridgeService* bridge);
ArcAppPerformanceTracing(const ArcAppPerformanceTracing&) = delete;
ArcAppPerformanceTracing& operator=(const ArcAppPerformanceTracing&) = delete;
~ArcAppPerformanceTracing() override;
// Returns singleton instance for the given BrowserContext,
// or nullptr if the browser |context| is not allowed to use ARC++.
static ArcAppPerformanceTracing* GetForBrowserContext(
content::BrowserContext* context);
static ArcAppPerformanceTracing* GetForBrowserContextForTesting(
content::BrowserContext* context);
static void SetFocusAppForTesting(const std::string& package_name,
const std::string& activity,
const std::string& category);
void SetCustomSessionReadyCallbackForTesting(
CustomSessionReadyCallback callback);
// KeyedService:
void Shutdown() override;
// Starts custom tracing. Returns true if tracing was successfully started.
bool StartCustomTracing();
// Stops custom tracing and returns tracing results.
base::Value::Dict StopCustomTracing();
// wm::ActivationChangeObserver:
void OnWindowActivated(ActivationReason reason,
aura::Window* gained_active,
aura::Window* lost_active) override;
// aura::WindowObserver:
void OnWindowDestroying(aura::Window* window) override;
void OnWindowPropertyChanged(aura::Window* window,
const void* key,
intptr_t old) override;
// ArcAppListPrefs::Observer:
void OnTaskCreated(int32_t task_id,
const std::string& package_name,
const std::string& activity,
const std::string& intent,
int32_t session_id) override;
void OnTaskDestroyed(int32_t task_id) override;
// exo::SurfaceObserver:
void OnCommit(exo::Surface* surface) override;
void OnSurfaceDestroying(exo::Surface* surface) override;
// display::DisplayObserver:
void OnDisplayMetricsChanged(const display::Display& display,
uint32_t changed_metrics) override;
void HandleActiveAppRendered(base::Time timestamp);
// Returns active tracing session or nullptr.
ArcAppPerformanceTracingSession* session() { return session_.get(); }
static void EnsureFactoryBuilt();
static TicksNowCallback* ticks_now_callback();
static void reset_ticks_now_callback();
private:
// May be start tracing session if all conditions are met. Window creating is
// controlled by Wayland protocol implementation and task creation is reported
// using mojom. That introduces the race and following conditions must be met
// to start the tracing.
// * Active window is ARC++ window.
// * Task information exists for the window.
// * ARC++ app is in set of predefined apps eligible for tracing.
// * User has app syncing enabled and no sync passphrase.
// * Stats reporting is enabled for user.
// This does nothing if session was already started.
// This is called each time when ARC++ window gets active or ARC++ task
// creation is reported.
void MaybeStartTracing();
// Stops jankiness and session tracing session if either was active and
// cancels any scheduled session.
void MaybeCancelTracing();
// Checks if |active_window_| is an ARC task, and if so, observes its root
// surface and records its task ID in |active_task_|.
void TrackIfTaskIsActive();
// Detaches observer from |active_window_| and resets
// |active_window_|.
void DetachActiveWindow();
// Starts timer for jankiness tracing. Called by OnWindowActivation() and
// FinalizeJankinessTracing().
void StartJankinessTracing();
// Retrieves and reports jankiness metrics and restarts timer. May be called
// early by OnWindowActivation() and OnWindowDestroying().
// In this case, |stopped_early| is set to true.
void FinalizeJankinessTracing(bool stopped_early);
// Callback for jankiness results. Reports results to UMA.
// Note: Results are cumulative. Uses task_id_to_gfx_metrics_
// values for delta calculations.
void OnGfxMetrics(const std::string& package_name,
mojom::GfxMetricsPtr metrics_ptr);
// Unowned pointers.
const raw_ptr<content::BrowserContext> context_;
// Currently active window.
raw_ptr<aura::Window> active_window_ = nullptr;
// Maps active tasks to app id and package name.
std::map<int, std::pair<std::string, std::string>> task_id_to_app_id_;
// Set of tasks that have already rendered first frame.
std::set<int> rendered_tasks_;
// Maps tasks to most recent GFX jankiness results. Used for delta
// calculation.
std::map<std::string, mojom::GfxMetrics> package_name_to_gfx_metrics_;
UmaPerfReporting reporting_;
std::optional<base::Value::Dict> custom_trace_result_;
void OnCustomTraceDone(const std::optional<PerfTraceResult>& result);
// Keeps current active tracing session associated with |active_window_|.
std::unique_ptr<ArcAppPerformanceTracingSession> session_;
// Callback to call when custom session is ready for testing.
CustomSessionReadyCallback custom_session_ready_callback_;
// Timer for jankiness tracing.
base::OneShotTimer jankiness_timer_;
// Currently-observed window which may be traced.
struct ActiveTask;
std::unique_ptr<ActiveTask> active_task_;
base::WeakPtrFactory<ArcAppPerformanceTracing> weak_ptr_factory_;
};
} // namespace arc
#endif // CHROME_BROWSER_ASH_ARC_TRACING_ARC_APP_PERFORMANCE_TRACING_H_
|