blob: cffb61ee10a3d280aa206eebd22e2f96a53d3311 [file] [log] [blame]
Adithya Srinivasanf279e042020-08-17 14:56:27 -07001/*
2 * Copyright 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#pragma once
18
Dominik Laskowskif6b4ba62021-11-09 12:46:10 -080019#include <atomic>
20#include <chrono>
21#include <deque>
22#include <memory>
23#include <mutex>
24#include <optional>
25#include <string>
26
Ady Abraham22c7b5c2020-09-22 19:33:40 -070027#include <gui/ISurfaceComposer.h>
Jorim Jaggi5814ab82020-12-03 20:45:58 +010028#include <gui/JankInfo.h>
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -070029#include <gui/LayerMetadata.h>
Adithya Srinivasan01189672020-10-20 14:23:05 -070030#include <perfetto/trace/android/frame_timeline_event.pbzero.h>
31#include <perfetto/tracing.h>
Adithya Srinivasanf279e042020-08-17 14:56:27 -070032#include <ui/FenceTime.h>
33#include <utils/RefBase.h>
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -070034#include <utils/String16.h>
Adithya Srinivasanf279e042020-08-17 14:56:27 -070035#include <utils/Timers.h>
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -070036#include <utils/Vector.h>
Adithya Srinivasanf279e042020-08-17 14:56:27 -070037
Dominik Laskowskif6b4ba62021-11-09 12:46:10 -080038#include <scheduler/Fps.h>
39
40#include "../TimeStats/TimeStats.h"
Adithya Srinivasanf279e042020-08-17 14:56:27 -070041
Alec Mouri9a29e672020-09-14 12:39:14 -070042namespace android::frametimeline {
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -070043
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -080044class FrameTimelineTest;
45
46using namespace std::chrono_literals;
47
48// Metadata indicating how the frame was presented w.r.t expected present time.
49enum class FramePresentMetadata : int8_t {
50 // Frame was presented on time
51 OnTimePresent,
52 // Frame was presented late
53 LatePresent,
54 // Frame was presented early
55 EarlyPresent,
56 // Unknown/initial state
57 UnknownPresent,
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -070058};
59
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -080060// Metadata comparing the frame's actual finish time to the expected deadline.
61enum class FrameReadyMetadata : int8_t {
62 // App/SF finished on time. Early finish is treated as on time since the goal of any component
63 // is to finish before the deadline.
64 OnTimeFinish,
65 // App/SF finished work later than expected
66 LateFinish,
67 // Unknown/initial state
68 UnknownFinish,
69};
70
71// Metadata comparing the frame's actual start time to the expected start time.
72enum class FrameStartMetadata : int8_t {
73 // App/SF started on time
74 OnTimeStart,
75 // App/SF started later than expected
76 LateStart,
77 // App/SF started earlier than expected
78 EarlyStart,
79 // Unknown/initial state
80 UnknownStart,
81};
Adithya Srinivasanf279e042020-08-17 14:56:27 -070082
83/*
84 * Collection of timestamps that can be used for both predictions and actual times.
85 */
86struct TimelineItem {
87 TimelineItem(const nsecs_t startTime = 0, const nsecs_t endTime = 0,
88 const nsecs_t presentTime = 0)
89 : startTime(startTime), endTime(endTime), presentTime(presentTime) {}
90
91 nsecs_t startTime;
92 nsecs_t endTime;
93 nsecs_t presentTime;
Ady Abraham55fa7272020-09-30 19:19:27 -070094
95 bool operator==(const TimelineItem& other) const {
96 return startTime == other.startTime && endTime == other.endTime &&
97 presentTime == other.presentTime;
98 }
99
100 bool operator!=(const TimelineItem& other) const { return !(*this == other); }
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700101};
102
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800103struct JankClassificationThresholds {
104 // The various thresholds for App and SF. If the actual timestamp falls within the threshold
105 // compared to prediction, we treat it as on time.
106 nsecs_t presentThreshold = std::chrono::duration_cast<std::chrono::nanoseconds>(2ms).count();
Adithya Srinivasan54996e22021-06-25 22:26:45 +0000107 nsecs_t deadlineThreshold = std::chrono::duration_cast<std::chrono::nanoseconds>(0ms).count();
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800108 nsecs_t startThreshold = std::chrono::duration_cast<std::chrono::nanoseconds>(2ms).count();
109};
110
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700111/*
112 * TokenManager generates a running number token for a set of predictions made by VsyncPredictor. It
113 * saves these predictions for a short period of time and returns the predictions for a given token,
114 * if it hasn't expired.
115 */
116class TokenManager {
117public:
118 virtual ~TokenManager() = default;
119
120 // Generates a token for the given set of predictions. Stores the predictions for 120ms and
121 // destroys it later.
Adithya Srinivasan5f683cf2020-09-15 14:21:04 -0700122 virtual int64_t generateTokenForPredictions(TimelineItem&& prediction) = 0;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800123
124 // Returns the stored predictions for a given token, if the predictions haven't expired.
125 virtual std::optional<TimelineItem> getPredictionsForToken(int64_t token) const = 0;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700126};
127
128enum class PredictionState {
129 Valid, // Predictions obtained successfully from the TokenManager
130 Expired, // TokenManager no longer has the predictions
131 None, // Predictions are either not present or didn't come from TokenManager
132};
133
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000134/*
135 * Trace cookie is used to send start and end timestamps of <Surface/Display>Frames separately
136 * without needing to resend all the other information. We send all info to perfetto, along with a
137 * new cookie, in the start of a frame. For the corresponding end, we just send the same cookie.
138 * This helps in reducing the amount of data emitted by the producer.
139 */
140class TraceCookieCounter {
141public:
142 int64_t getCookieForTracing();
143
144private:
145 // Friend class for testing
146 friend class android::frametimeline::FrameTimelineTest;
147
148 std::atomic<int64_t> mTraceCookie = 0;
149};
150
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700151class SurfaceFrame {
152public:
153 enum class PresentState {
154 Presented, // Buffer was latched and presented by SurfaceFlinger
155 Dropped, // Buffer was dropped by SurfaceFlinger
156 Unknown, // Initial state, SurfaceFlinger hasn't seen this buffer yet
157 };
158
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800159 // Only FrameTimeline can construct a SurfaceFrame as it provides Predictions(through
160 // TokenManager), Thresholds and TimeStats pointer.
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000161 SurfaceFrame(const FrameTimelineInfo& frameTimelineInfo, pid_t ownerPid, uid_t ownerUid,
Alec Mouriadebf5c2021-01-05 12:57:36 -0800162 int32_t layerId, std::string layerName, std::string debugName,
163 PredictionState predictionState, TimelineItem&& predictions,
164 std::shared_ptr<TimeStats> timeStats, JankClassificationThresholds thresholds,
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -0700165 TraceCookieCounter* traceCookieCounter, bool isBuffer, GameMode);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800166 ~SurfaceFrame() = default;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700167
Sally Qi438eb7d2023-12-05 18:59:32 -0800168 bool isSelfJanky() const;
169
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800170 // Returns std::nullopt if the frame hasn't been classified yet.
171 // Used by both SF and FrameTimeline.
172 std::optional<int32_t> getJankType() const;
Ying Wei96eb5352023-11-21 17:37:21 +0000173 std::optional<JankSeverityType> getJankSeverityType() const;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700174
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800175 // Functions called by SF
176 int64_t getToken() const { return mToken; };
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000177 int32_t getInputEventId() const { return mInputEventId; };
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800178 TimelineItem getPredictions() const { return mPredictions; };
Adithya Srinivasan5f683cf2020-09-15 14:21:04 -0700179 // Actual timestamps of the app are set individually at different functions.
180 // Start time (if the app provides) and Queue time are accessible after queueing the frame,
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000181 // whereas Acquire Fence time is available only during latch. Drop time is available at the time
182 // the buffer was dropped.
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800183 void setActualStartTime(nsecs_t actualStartTime);
184 void setActualQueueTime(nsecs_t actualQueueTime);
185 void setAcquireFenceTime(nsecs_t acquireFenceTime);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000186 void setDropTime(nsecs_t dropTime);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800187 void setPresentState(PresentState presentState, nsecs_t lastLatchTime = 0);
Alec Mouri7d436ec2021-01-27 20:40:50 -0800188 void setRenderRate(Fps renderRate);
Pascal Muetschardac7bcd92023-10-03 15:05:36 +0200189 // Return the render rate if it exists, otherwise returns the DisplayFrame's render rate.
190 Fps getRenderRate() const;
Adithya Srinivasanb6a2fa12021-03-13 00:23:09 +0000191 void setGpuComposition();
Jorim Jaggi9c03b502020-11-24 23:51:31 +0100192
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000193 // When a bufferless SurfaceFrame is promoted to a buffer SurfaceFrame, we also have to update
194 // isBuffer.
195 void promoteToBuffer();
196
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800197 // Functions called by FrameTimeline
198 // BaseTime is the smallest timestamp in this SurfaceFrame.
199 // Used for dumping all timestamps relative to the oldest, making it easy to read.
200 nsecs_t getBaseTime() const;
201 // Sets the actual present time, appropriate metadata and classifies the jank.
Alec Mouri363faf02021-01-29 16:34:55 -0800202 // displayRefreshRate, displayDeadlineDelta, and displayPresentDelta are propagated from the
203 // display frame.
204 void onPresent(nsecs_t presentTime, int32_t displayFrameJankType, Fps refreshRate,
Pascal Muetschardac7bcd92023-10-03 15:05:36 +0200205 Fps displayFrameRenderRate, nsecs_t displayDeadlineDelta,
206 nsecs_t displayPresentDelta);
Ady Abraham14beed72024-05-15 17:16:45 -0700207 // Sets the frame as none janky as there was no real display frame.
208 void onCommitNotComposited(Fps refreshRate, Fps displayFrameRenderRate);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800209 // All the timestamps are dumped relative to the baseTime
210 void dump(std::string& result, const std::string& indent, nsecs_t baseTime) const;
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000211 // Dumps only the layer, token, is buffer, jank metadata, prediction and present states.
212 std::string miniDump() const;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800213 // Emits a packet for perfetto tracing. The function body will be executed only if tracing is
214 // enabled. The displayFrameToken is needed to link the SurfaceFrame to the corresponding
Ady Abraham57f8e182022-03-08 15:54:33 -0800215 // DisplayFrame at the trace processor side. monoBootOffset is the difference
216 // between SYSTEM_TIME_BOOTTIME and SYSTEM_TIME_MONOTONIC.
Ady Abraham43a68c32024-09-04 19:21:20 -0700217 void trace(int64_t displayFrameToken, nsecs_t monoBootOffset,
218 bool filterFramesBeforeTraceStarts) const;
Jorim Jaggi9c03b502020-11-24 23:51:31 +0100219
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000220 // Getter functions used only by FrameTimelineTests and SurfaceFrame internally
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800221 TimelineItem getActuals() const;
222 pid_t getOwnerPid() const { return mOwnerPid; };
Alec Mouriadebf5c2021-01-05 12:57:36 -0800223 int32_t getLayerId() const { return mLayerId; };
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000224 PredictionState getPredictionState() const;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800225 PresentState getPresentState() const;
226 FrameReadyMetadata getFrameReadyMetadata() const;
227 FramePresentMetadata getFramePresentMetadata() const;
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000228 nsecs_t getDropTime() const;
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000229 bool getIsBuffer() const;
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000230
231 // For prediction expired frames, this delta is subtracted from the actual end time to get a
232 // start time decent enough to see in traces.
233 // TODO(b/172587309): Remove this when we have actual start times.
234 static constexpr nsecs_t kPredictionExpiredStartTimeDelta =
235 std::chrono::duration_cast<std::chrono::nanoseconds>(2ms).count();
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800236
237private:
Ady Abraham43a68c32024-09-04 19:21:20 -0700238 void tracePredictions(int64_t displayFrameToken, nsecs_t monoBootOffset,
239 bool filterFramesBeforeTraceStarts) const;
240 void traceActuals(int64_t displayFrameToken, nsecs_t monoBootOffset,
241 bool filterFramesBeforeTraceStarts) const;
Adithya Srinivasan7c4ac7a2021-03-08 23:48:03 +0000242 void classifyJankLocked(int32_t displayFrameJankType, const Fps& refreshRate,
Ady Abrahame96e79f2024-05-20 18:00:39 +0000243 Fps displayFrameRenderRate, nsecs_t* outDeadlineDelta) REQUIRES(mMutex);
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000244
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800245 const int64_t mToken;
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000246 const int32_t mInputEventId;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800247 const pid_t mOwnerPid;
248 const uid_t mOwnerUid;
249 const std::string mLayerName;
250 const std::string mDebugName;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800251 const int32_t mLayerId;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800252 PresentState mPresentState GUARDED_BY(mMutex);
253 const PredictionState mPredictionState;
254 const TimelineItem mPredictions;
255 TimelineItem mActuals GUARDED_BY(mMutex);
256 std::shared_ptr<TimeStats> mTimeStats;
257 const JankClassificationThresholds mJankClassificationThresholds;
258 nsecs_t mActualQueueTime GUARDED_BY(mMutex) = 0;
Adithya Srinivasan061c14c2021-02-11 01:19:47 +0000259 nsecs_t mDropTime GUARDED_BY(mMutex) = 0;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800260 mutable std::mutex mMutex;
261 // Bitmask for the type of jank
262 int32_t mJankType GUARDED_BY(mMutex) = JankType::None;
Ying Wei96eb5352023-11-21 17:37:21 +0000263 // Enum for the severity of jank
264 JankSeverityType mJankSeverityType GUARDED_BY(mMutex) = JankSeverityType::None;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800265 // Indicates if this frame was composited by the GPU or not
266 bool mGpuComposition GUARDED_BY(mMutex) = false;
Pascal Muetschardac7bcd92023-10-03 15:05:36 +0200267 // Refresh rate for this frame.
268 Fps mDisplayFrameRenderRate GUARDED_BY(mMutex);
Alec Mouri7d436ec2021-01-27 20:40:50 -0800269 // Rendering rate for this frame.
270 std::optional<Fps> mRenderRate GUARDED_BY(mMutex);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800271 // Enum for the type of present
272 FramePresentMetadata mFramePresentMetadata GUARDED_BY(mMutex) =
273 FramePresentMetadata::UnknownPresent;
274 // Enum for the type of finish
275 FrameReadyMetadata mFrameReadyMetadata GUARDED_BY(mMutex) = FrameReadyMetadata::UnknownFinish;
276 // Time when the previous buffer from the same layer was latched by SF. This is used in checking
277 // for BufferStuffing where the current buffer is expected to be ready but the previous buffer
278 // was latched instead.
279 nsecs_t mLastLatchTime GUARDED_BY(mMutex) = 0;
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000280 // TraceCookieCounter is used to obtain the cookie for sendig trace packets to perfetto. Using a
281 // reference here because the counter is owned by FrameTimeline, which outlives SurfaceFrame.
282 TraceCookieCounter& mTraceCookieCounter;
Adithya Srinivasan785addd2021-03-09 00:38:00 +0000283 // Tells if the SurfaceFrame is representing a buffer or a transaction without a
284 // buffer(animations)
285 bool mIsBuffer;
Adithya Srinivasan58069dc2021-06-04 20:37:02 +0000286 // GameMode from the layer. Used in metrics.
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -0700287 GameMode mGameMode = GameMode::Unsupported;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700288};
289
290/*
291 * Maintains a history of SurfaceFrames grouped together by the vsync time in which they were
292 * presented
293 */
294class FrameTimeline {
295public:
296 virtual ~FrameTimeline() = default;
Adithya Srinivasan5f683cf2020-09-15 14:21:04 -0700297 virtual TokenManager* getTokenManager() = 0;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700298
Adithya Srinivasan01189672020-10-20 14:23:05 -0700299 // Initializes the Perfetto DataSource that emits DisplayFrame and SurfaceFrame events. Test
300 // classes can avoid double registration by mocking this function.
301 virtual void onBootFinished() = 0;
302
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700303 // Create a new surface frame, set the predictions based on a token and return it to the caller.
Alec Mouri9a29e672020-09-14 12:39:14 -0700304 // Debug name is the human-readable debugging string for dumpsys.
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000305 virtual std::shared_ptr<SurfaceFrame> createSurfaceFrameForToken(
306 const FrameTimelineInfo& frameTimelineInfo, pid_t ownerPid, uid_t ownerUid,
Adithya Srinivasan58069dc2021-06-04 20:37:02 +0000307 int32_t layerId, std::string layerName, std::string debugName, bool isBuffer,
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -0700308 GameMode) = 0;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700309
310 // Adds a new SurfaceFrame to the current DisplayFrame. Frames from multiple layers can be
311 // composited into one display frame.
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800312 virtual void addSurfaceFrame(std::shared_ptr<SurfaceFrame> surfaceFrame) = 0;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700313
314 // The first function called by SF for the current DisplayFrame. Fetches SF predictions based on
315 // the token and sets the actualSfWakeTime for the current DisplayFrame.
Pascal Muetschardac7bcd92023-10-03 15:05:36 +0200316 virtual void setSfWakeUp(int64_t token, nsecs_t wakeupTime, Fps refreshRate,
317 Fps renderRate) = 0;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700318
Adithya Srinivasan36b01af2021-04-07 22:29:47 +0000319 // Sets the sfPresentTime and finalizes the current DisplayFrame. Tracks the
Adithya Srinivasanb6a2fa12021-03-13 00:23:09 +0000320 // given present fence until it's signaled, and updates the present timestamps of all presented
Adithya Srinivasan36b01af2021-04-07 22:29:47 +0000321 // SurfaceFrames in that vsync. If a gpuFence was also provided, its tracked in the
322 // corresponding DisplayFrame.
Adithya Srinivasanb6a2fa12021-03-13 00:23:09 +0000323 virtual void setSfPresent(nsecs_t sfPresentTime, const std::shared_ptr<FenceTime>& presentFence,
Adithya Srinivasan36b01af2021-04-07 22:29:47 +0000324 const std::shared_ptr<FenceTime>& gpuFence) = 0;
Adithya Srinivasan5f683cf2020-09-15 14:21:04 -0700325
Ady Abraham14beed72024-05-15 17:16:45 -0700326 // Tells FrameTimeline that a frame was committed but not composited. This is used to flush
327 // all the associated surface frames.
328 virtual void onCommitNotComposited() = 0;
329
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -0700330 // Args:
331 // -jank : Dumps only the Display Frames that are either janky themselves
332 // or contain janky Surface Frames.
333 // -all : Dumps the entire list of DisplayFrames and the SurfaceFrames contained within
334 virtual void parseArgs(const Vector<String16>& args, std::string& result) = 0;
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700335
336 // Sets the max number of display frames that can be stored. Called by SF backdoor.
Josh Gaoade0f672023-01-17 14:59:04 -0800337 virtual void setMaxDisplayFrames(uint32_t size) = 0;
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700338
Alec Mouriadebf5c2021-01-05 12:57:36 -0800339 // Computes the historical fps for the provided set of layer IDs
340 // The fps is compted from the linear timeline of present timestamps for DisplayFrames
341 // containing at least one layer ID.
Josh Gaoade0f672023-01-17 14:59:04 -0800342 virtual float computeFps(const std::unordered_set<int32_t>& layerIds) = 0;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800343
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700344 // Restores the max number of display frames to default. Called by SF backdoor.
345 virtual void reset() = 0;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700346};
347
348namespace impl {
349
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700350class TokenManager : public android::frametimeline::TokenManager {
351public:
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000352 TokenManager() : mCurrentToken(FrameTimelineInfo::INVALID_VSYNC_ID + 1) {}
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700353 ~TokenManager() = default;
354
355 int64_t generateTokenForPredictions(TimelineItem&& predictions) override;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800356 std::optional<TimelineItem> getPredictionsForToken(int64_t token) const override;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700357
358private:
359 // Friend class for testing
360 friend class android::frametimeline::FrameTimelineTest;
361
362 void flushTokens(nsecs_t flushTime) REQUIRES(mMutex);
363
Adithya Srinivasanbed4c4f2021-05-03 20:24:46 +0000364 std::map<int64_t, TimelineItem> mPredictions GUARDED_BY(mMutex);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700365 int64_t mCurrentToken GUARDED_BY(mMutex);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800366 mutable std::mutex mMutex;
Adithya Srinivasanbed4c4f2021-05-03 20:24:46 +0000367 static constexpr size_t kMaxTokens = 500;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700368};
369
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700370class FrameTimeline : public android::frametimeline::FrameTimeline {
371public:
Adithya Srinivasan01189672020-10-20 14:23:05 -0700372 class FrameTimelineDataSource : public perfetto::DataSource<FrameTimelineDataSource> {
Ady Abraham43a68c32024-09-04 19:21:20 -0700373 public:
374 nsecs_t getStartTime() const { return mTraceStartTime; }
375
376 private:
377 void OnSetup(const SetupArgs&) override {};
378 void OnStart(const StartArgs&) override { mTraceStartTime = systemTime(); };
379 void OnStop(const StopArgs&) override {};
380
381 nsecs_t mTraceStartTime = 0;
Adithya Srinivasan01189672020-10-20 14:23:05 -0700382 };
383
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800384 /*
385 * DisplayFrame should be used only internally within FrameTimeline. All members and methods are
386 * guarded by FrameTimeline's mMutex.
387 */
388 class DisplayFrame {
389 public:
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000390 DisplayFrame(std::shared_ptr<TimeStats> timeStats, JankClassificationThresholds thresholds,
Adithya Srinivasan82eef322021-04-10 00:06:04 +0000391 TraceCookieCounter* traceCookieCounter);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800392 virtual ~DisplayFrame() = default;
393 // Dumpsys interface - dumps only if the DisplayFrame itself is janky or is at least one
394 // SurfaceFrame is janky.
395 void dumpJank(std::string& result, nsecs_t baseTime, int displayFrameCount) const;
396 // Dumpsys interface - dumps all data irrespective of jank
397 void dumpAll(std::string& result, nsecs_t baseTime) const;
398 // Emits a packet for perfetto tracing. The function body will be executed only if tracing
Ady Abraham57f8e182022-03-08 15:54:33 -0800399 // is enabled. monoBootOffset is the difference between SYSTEM_TIME_BOOTTIME
400 // and SYSTEM_TIME_MONOTONIC.
Sally Qi438eb7d2023-12-05 18:59:32 -0800401 nsecs_t trace(pid_t surfaceFlingerPid, nsecs_t monoBootOffset,
Ady Abraham43a68c32024-09-04 19:21:20 -0700402 nsecs_t previousPredictionPresentTime,
403 bool filterFramesBeforeTraceStarts) const;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800404 // Sets the token, vsyncPeriod, predictions and SF start time.
Pascal Muetschardac7bcd92023-10-03 15:05:36 +0200405 void onSfWakeUp(int64_t token, Fps refreshRate, Fps renderRate,
406 std::optional<TimelineItem> predictions, nsecs_t wakeUpTime);
Adithya Srinivasan115ac692021-03-06 01:21:30 +0000407 // Sets the appropriate metadata and classifies the jank.
Adithya Srinivasan57dc81d2021-04-14 17:31:41 +0000408 void onPresent(nsecs_t signalTime, nsecs_t previousPresentTime);
Ady Abraham14beed72024-05-15 17:16:45 -0700409 // Flushes all the surface frames as those were not generating any actual display frames.
410 void onCommitNotComposited();
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800411 // Adds the provided SurfaceFrame to the current display frame.
412 void addSurfaceFrame(std::shared_ptr<SurfaceFrame> surfaceFrame);
413
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800414 void setPredictions(PredictionState predictionState, TimelineItem predictions);
415 void setActualStartTime(nsecs_t actualStartTime);
416 void setActualEndTime(nsecs_t actualEndTime);
Adithya Srinivasan36b01af2021-04-07 22:29:47 +0000417 void setGpuFence(const std::shared_ptr<FenceTime>& gpuFence);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800418
419 // BaseTime is the smallest timestamp in a DisplayFrame.
420 // Used for dumping all timestamps relative to the oldest, making it easy to read.
421 nsecs_t getBaseTime() const;
422
423 // Functions to be used only in testing.
424 TimelineItem getActuals() const { return mSurfaceFlingerActuals; };
425 TimelineItem getPredictions() const { return mSurfaceFlingerPredictions; };
Adithya Srinivasan939cd4d2021-02-23 06:18:13 +0000426 FrameStartMetadata getFrameStartMetadata() const { return mFrameStartMetadata; };
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800427 FramePresentMetadata getFramePresentMetadata() const { return mFramePresentMetadata; };
428 FrameReadyMetadata getFrameReadyMetadata() const { return mFrameReadyMetadata; };
429 int32_t getJankType() const { return mJankType; }
Ying Wei96eb5352023-11-21 17:37:21 +0000430 JankSeverityType getJankSeverityType() const { return mJankSeverityType; }
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800431 const std::vector<std::shared_ptr<SurfaceFrame>>& getSurfaceFrames() const {
432 return mSurfaceFrames;
433 }
434
435 private:
436 void dump(std::string& result, nsecs_t baseTime) const;
Ady Abraham43a68c32024-09-04 19:21:20 -0700437 void tracePredictions(pid_t surfaceFlingerPid, nsecs_t monoBootOffset,
438 bool filterFramesBeforeTraceStarts) const;
439 void traceActuals(pid_t surfaceFlingerPid, nsecs_t monoBootOffset,
440 bool filterFramesBeforeTraceStarts) const;
Sally Qiaa107742023-09-29 14:53:14 -0700441 void addSkippedFrame(pid_t surfaceFlingerPid, nsecs_t monoBootOffset,
Ady Abraham43a68c32024-09-04 19:21:20 -0700442 nsecs_t previousActualPresentTime,
443 bool filterFramesBeforeTraceStarts) const;
Adithya Srinivasan57dc81d2021-04-14 17:31:41 +0000444 void classifyJank(nsecs_t& deadlineDelta, nsecs_t& deltaToVsync,
445 nsecs_t previousPresentTime);
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800446
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000447 int64_t mToken = FrameTimelineInfo::INVALID_VSYNC_ID;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800448
449 /* Usage of TimelineItem w.r.t SurfaceFlinger
450 * startTime Time when SurfaceFlinger wakes up to handle transactions and buffer updates
451 * endTime Time when SurfaceFlinger sends a composited frame to Display
452 * presentTime Time when the composited frame was presented on screen
453 */
454 TimelineItem mSurfaceFlingerPredictions;
455 TimelineItem mSurfaceFlingerActuals;
456 std::shared_ptr<TimeStats> mTimeStats;
457 const JankClassificationThresholds mJankClassificationThresholds;
458
459 // Collection of predictions and actual values sent over by Layers
460 std::vector<std::shared_ptr<SurfaceFrame>> mSurfaceFrames;
461
462 PredictionState mPredictionState = PredictionState::None;
463 // Bitmask for the type of jank
464 int32_t mJankType = JankType::None;
Ying Wei96eb5352023-11-21 17:37:21 +0000465 // Enum for the severity of jank
466 JankSeverityType mJankSeverityType = JankSeverityType::None;
Adithya Srinivasan36b01af2021-04-07 22:29:47 +0000467 // A valid gpu fence indicates that the DisplayFrame was composited by the GPU
468 std::shared_ptr<FenceTime> mGpuFence = FenceTime::NO_FENCE;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800469 // Enum for the type of present
470 FramePresentMetadata mFramePresentMetadata = FramePresentMetadata::UnknownPresent;
471 // Enum for the type of finish
472 FrameReadyMetadata mFrameReadyMetadata = FrameReadyMetadata::UnknownFinish;
473 // Enum for the type of start
474 FrameStartMetadata mFrameStartMetadata = FrameStartMetadata::UnknownStart;
475 // The refresh rate (vsync period) in nanoseconds as seen by SF during this DisplayFrame's
476 // timeline
Alec Mouri7d436ec2021-01-27 20:40:50 -0800477 Fps mRefreshRate;
Pascal Muetschardac7bcd92023-10-03 15:05:36 +0200478 // The current render rate for this DisplayFrame.
479 Fps mRenderRate;
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000480 // TraceCookieCounter is used to obtain the cookie for sendig trace packets to perfetto.
481 // Using a reference here because the counter is owned by FrameTimeline, which outlives
482 // DisplayFrame.
483 TraceCookieCounter& mTraceCookieCounter;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800484 };
485
486 FrameTimeline(std::shared_ptr<TimeStats> timeStats, pid_t surfaceFlingerPid,
Ady Abraham43a68c32024-09-04 19:21:20 -0700487 JankClassificationThresholds thresholds = {}, bool useBootTimeClock = true,
488 bool filterFramesBeforeTraceStarts = true);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700489 ~FrameTimeline() = default;
490
Adithya Srinivasan5f683cf2020-09-15 14:21:04 -0700491 frametimeline::TokenManager* getTokenManager() override { return &mTokenManager; }
Siarhei Vishniakoufc434ac2021-01-13 10:28:00 -1000492 std::shared_ptr<SurfaceFrame> createSurfaceFrameForToken(
493 const FrameTimelineInfo& frameTimelineInfo, pid_t ownerPid, uid_t ownerUid,
Adithya Srinivasan58069dc2021-06-04 20:37:02 +0000494 int32_t layerId, std::string layerName, std::string debugName, bool isBuffer,
Dominik Laskowskif5d0ea52021-09-26 17:27:01 -0700495 GameMode) override;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800496 void addSurfaceFrame(std::shared_ptr<frametimeline::SurfaceFrame> surfaceFrame) override;
Pascal Muetschardac7bcd92023-10-03 15:05:36 +0200497 void setSfWakeUp(int64_t token, nsecs_t wakeupTime, Fps refreshRate, Fps renderRate) override;
Adithya Srinivasanb6a2fa12021-03-13 00:23:09 +0000498 void setSfPresent(nsecs_t sfPresentTime, const std::shared_ptr<FenceTime>& presentFence,
Adithya Srinivasan36b01af2021-04-07 22:29:47 +0000499 const std::shared_ptr<FenceTime>& gpuFence = FenceTime::NO_FENCE) override;
Ady Abraham14beed72024-05-15 17:16:45 -0700500 void onCommitNotComposited() override;
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -0700501 void parseArgs(const Vector<String16>& args, std::string& result) override;
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700502 void setMaxDisplayFrames(uint32_t size) override;
Alec Mouriadebf5c2021-01-05 12:57:36 -0800503 float computeFps(const std::unordered_set<int32_t>& layerIds) override;
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700504 void reset() override;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700505
Adithya Srinivasan01189672020-10-20 14:23:05 -0700506 // Sets up the perfetto tracing backend and data source.
507 void onBootFinished() override;
508 // Registers the data source with the perfetto backend. Called as part of onBootFinished()
509 // and should not be called manually outside of tests.
510 void registerDataSource();
511
512 static constexpr char kFrameTimelineDataSource[] = "android.surfaceflinger.frametimeline";
513
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700514private:
515 // Friend class for testing
516 friend class android::frametimeline::FrameTimelineTest;
517
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700518 void flushPendingPresentFences() REQUIRES(mMutex);
Ady Abrahamfcb16862022-10-10 14:35:21 -0700519 std::optional<size_t> getFirstSignalFenceIndex() const REQUIRES(mMutex);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700520 void finalizeCurrentDisplayFrame() REQUIRES(mMutex);
Adithya Srinivasan8fc601d2020-09-25 13:51:09 -0700521 void dumpAll(std::string& result);
522 void dumpJank(std::string& result);
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700523
524 // Sliding window of display frames. TODO(b/168072834): compare perf with fixed size array
525 std::deque<std::shared_ptr<DisplayFrame>> mDisplayFrames GUARDED_BY(mMutex);
526 std::vector<std::pair<std::shared_ptr<FenceTime>, std::shared_ptr<DisplayFrame>>>
527 mPendingPresentFences GUARDED_BY(mMutex);
528 std::shared_ptr<DisplayFrame> mCurrentDisplayFrame GUARDED_BY(mMutex);
529 TokenManager mTokenManager;
Adithya Srinivasan05bd2d12021-01-11 18:49:58 +0000530 TraceCookieCounter mTraceCookieCounter;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800531 mutable std::mutex mMutex;
Ady Abraham57f8e182022-03-08 15:54:33 -0800532 const bool mUseBootTimeClock;
Ady Abraham43a68c32024-09-04 19:21:20 -0700533 const bool mFilterFramesBeforeTraceStarts;
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700534 uint32_t mMaxDisplayFrames;
Alec Mouri9a29e672020-09-14 12:39:14 -0700535 std::shared_ptr<TimeStats> mTimeStats;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800536 const pid_t mSurfaceFlingerPid;
Sally Qi438eb7d2023-12-05 18:59:32 -0800537 nsecs_t mPreviousActualPresentTime = 0;
538 nsecs_t mPreviousPredictionPresentTime = 0;
Adithya Srinivasan9b2ca3e2020-11-10 10:14:17 -0800539 const JankClassificationThresholds mJankClassificationThresholds;
Adithya Srinivasan2d736322020-10-01 16:53:48 -0700540 static constexpr uint32_t kDefaultMaxDisplayFrames = 64;
Adithya Srinivasan01189672020-10-20 14:23:05 -0700541 // The initial container size for the vector<SurfaceFrames> inside display frame. Although
542 // this number doesn't represent any bounds on the number of surface frames that can go in a
543 // display frame, this is a good starting size for the vector so that we can avoid the
544 // internal vector resizing that happens with push_back.
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700545 static constexpr uint32_t kNumSurfaceFramesInitial = 10;
Adithya Srinivasanf279e042020-08-17 14:56:27 -0700546};
547
548} // namespace impl
549} // namespace android::frametimeline