blob: 08059268f03ec3ed4cd3a799a7f978d526411dde [file] [log] [blame]
John Reckba6adf62015-02-19 14:36:50 -08001/*
2 * Copyright (C) 2015 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#ifndef JANKTRACKER_H_
17#define JANKTRACKER_H_
18
19#include "FrameInfo.h"
John Reck7075c792017-07-05 14:03:43 -070020#include "ProfileData.h"
John Reck34781b22017-07-05 16:39:36 -070021#include "ProfileDataContainer.h"
John Reckba6adf62015-02-19 14:36:50 -080022#include "renderthread/TimeLord.h"
23#include "utils/RingBuffer.h"
24
John Reckedc524c2015-03-18 15:24:33 -070025#include <cutils/compiler.h>
John Reck2d5b8d72016-07-28 15:36:11 -070026#include <ui/DisplayInfo.h>
John Reckedc524c2015-03-18 15:24:33 -070027
John Reckb36016c2015-03-11 08:50:53 -070028#include <array>
John Reckba6adf62015-02-19 14:36:50 -080029#include <memory>
30
31namespace android {
32namespace uirenderer {
33
John Reckdf1742e2017-01-19 15:56:21 -080034enum class JankTrackerType {
35 // The default, means there's no description set
36 Generic,
37 // The profile data represents a package
38 Package,
39 // The profile data is for a specific window
40 Window,
41};
42
43// Metadata about the ProfileData being collected
44struct ProfileDataDescription {
45 JankTrackerType type;
46 std::string name;
47};
48
John Reckba6adf62015-02-19 14:36:50 -080049// TODO: Replace DrawProfiler with this
50class JankTracker {
51public:
John Reck34781b22017-07-05 16:39:36 -070052 explicit JankTracker(ProfileDataContainer* globalData, const DisplayInfo& displayInfo);
John Reckba6adf62015-02-19 14:36:50 -080053
John Reckdf1742e2017-01-19 15:56:21 -080054 void setDescription(JankTrackerType type, const std::string&& name) {
55 mDescription.type = type;
56 mDescription.name = name;
57 }
58
John Reck34781b22017-07-05 16:39:36 -070059 FrameInfo* startFrame() { return &mFrames.next(); }
60 void finishFrame(const FrameInfo& frame);
Stan Iliev7203e1f2019-07-25 13:12:02 -040061 void finishGpuDraw(const FrameInfo& frame);
John Reckba6adf62015-02-19 14:36:50 -080062
John Reck34781b22017-07-05 16:39:36 -070063 void dumpStats(int fd) { dumpData(fd, &mDescription, mData.get()); }
64 void dumpFrames(int fd);
John Reckba6adf62015-02-19 14:36:50 -080065 void reset();
66
John Reck34781b22017-07-05 16:39:36 -070067 // Exposed for FrameInfoVisualizer
68 // TODO: Figure out a better way to handle this
69 RingBuffer<FrameInfo, 120>& frames() { return mFrames; }
John Reckedc524c2015-03-18 15:24:33 -070070
John Reckba6adf62015-02-19 14:36:50 -080071private:
John Reckedc524c2015-03-18 15:24:33 -070072 void setFrameInterval(nsecs_t frameIntervalNanos);
John Recke70c5752015-03-06 14:40:50 -080073
John Reck1bcacfd2017-11-03 10:12:19 -070074 static void dumpData(int fd, const ProfileDataDescription* description,
75 const ProfileData* data);
John Reckedc524c2015-03-18 15:24:33 -070076
John Reckb36016c2015-03-11 08:50:53 -070077 std::array<int64_t, NUM_BUCKETS> mThresholds;
John Reckba6adf62015-02-19 14:36:50 -080078 int64_t mFrameInterval;
John Reck0e486472018-03-19 14:06:16 -070079 nsecs_t mSwapDeadline;
John Reck2d5b8d72016-07-28 15:36:11 -070080 // The amount of time we will erase from the total duration to account
81 // for SF vsync offsets with HWC2 blocking dequeueBuffers.
82 // (Vsync + mDequeueBlockTolerance) is the point at which we expect
83 // SF to have released the buffer normally, so we will forgive up to that
84 // point in time by comparing to (IssueDrawCommandsStart + DequeueDuration)
85 // This is only used if we are in pipelined mode and are using HWC2,
86 // otherwise it's 0.
87 nsecs_t mDequeueTimeForgiveness = 0;
John Reck34781b22017-07-05 16:39:36 -070088 ProfileDataContainer mData;
89 ProfileDataContainer* mGlobalData;
John Reckdf1742e2017-01-19 15:56:21 -080090 ProfileDataDescription mDescription;
John Reck34781b22017-07-05 16:39:36 -070091
92 // Ring buffer large enough for 2 seconds worth of frames
93 RingBuffer<FrameInfo, 120> mFrames;
John Reckba6adf62015-02-19 14:36:50 -080094};
95
96} /* namespace uirenderer */
97} /* namespace android */
98
99#endif /* JANKTRACKER_H_ */