1 /* 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" 20 #include "FrameMetricsReporter.h" 21 #include "ProfileData.h" 22 #include "ProfileDataContainer.h" 23 #include "renderthread/TimeLord.h" 24 #include "utils/RingBuffer.h" 25 26 #include <cutils/compiler.h> 27 28 #include <array> 29 #include <memory> 30 31 namespace android { 32 namespace uirenderer { 33 34 enum 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 44 struct ProfileDataDescription { 45 JankTrackerType type; 46 std::string name; 47 }; 48 49 // TODO: Replace DrawProfiler with this 50 class JankTracker { 51 public: 52 explicit JankTracker(ProfileDataContainer* globalData); 53 setDescription(JankTrackerType type,const std::string && name)54 void setDescription(JankTrackerType type, const std::string&& name) { 55 mDescription.type = type; 56 mDescription.name = name; 57 } 58 startFrame()59 FrameInfo* startFrame() { return &mFrames.next(); } 60 void finishFrame(FrameInfo& frame, std::unique_ptr<FrameMetricsReporter>& reporter, 61 int64_t frameNumber, int32_t surfaceId); 62 63 // Calculates the 'legacy' jank information, i.e. with outdated refresh rate information and 64 // without GPU completion or deadlined information. 65 void calculateLegacyJank(FrameInfo& frame); dumpStats(int fd)66 void dumpStats(int fd) NO_THREAD_SAFETY_ANALYSIS { dumpData(fd, &mDescription, mData.get()); } 67 void dumpFrames(int fd); 68 void reset(); 69 70 // Exposed for FrameInfoVisualizer 71 // TODO: Figure out a better way to handle this frames()72 RingBuffer<FrameInfo, 120>& frames() { return mFrames; } 73 74 private: 75 void recomputeThresholds(int64_t frameInterval); 76 static void dumpData(int fd, const ProfileDataDescription* description, 77 const ProfileData* data); 78 79 // Last frame budget for which mThresholds were computed. 80 int64_t mThresholdsFrameBudget GUARDED_BY(mDataMutex); 81 std::array<int64_t, NUM_BUCKETS> mThresholds GUARDED_BY(mDataMutex); 82 83 int64_t mFrameIntervalLegacy; 84 nsecs_t mSwapDeadlineLegacy = -1; 85 // The amount of time we will erase from the total duration to account 86 // for SF vsync offsets with HWC2 blocking dequeueBuffers. 87 // (Vsync + mDequeueBlockTolerance) is the point at which we expect 88 // SF to have released the buffer normally, so we will forgive up to that 89 // point in time by comparing to (IssueDrawCommandsStart + DequeueDuration) 90 // This is only used if we are in pipelined mode and are using HWC2, 91 // otherwise it's 0. 92 nsecs_t mDequeueTimeForgivenessLegacy = 0; 93 94 nsecs_t mNextFrameStartUnstuffed GUARDED_BY(mDataMutex) = -1; 95 ProfileDataContainer mData GUARDED_BY(mDataMutex); 96 ProfileDataContainer* mGlobalData GUARDED_BY(mDataMutex); 97 ProfileDataDescription mDescription; 98 99 // Ring buffer large enough for 2 seconds worth of frames 100 RingBuffer<FrameInfo, 120> mFrames; 101 102 // Mutex to protect acccess to mData and mGlobalData obtained from mGlobalData->getDataMutex 103 std::mutex& mDataMutex; 104 }; 105 106 } /* namespace uirenderer */ 107 } /* namespace android */ 108 109 #endif /* JANKTRACKER_H_ */ 110