blob: f8013ab6b6c4a922b621496169d531bab275f336 [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 FRAMEINFO_H_
17#define FRAMEINFO_H_
18
19#include "utils/Macros.h"
20
21#include <cutils/compiler.h>
22#include <utils/Timers.h>
23
24#include <memory.h>
John Reck4db3d172015-06-02 15:58:43 -070025#include <string>
John Reckba6adf62015-02-19 14:36:50 -080026
27namespace android {
28namespace uirenderer {
29
30#define UI_THREAD_FRAME_INFO_SIZE 9
31
John Reckc87be992015-02-20 10:57:22 -080032enum class FrameInfoIndex {
Chris Craik1b54fb22015-06-02 17:40:58 -070033 Flags = 0,
34 IntendedVsync,
35 Vsync,
36 OldestInputEvent,
37 NewestInputEvent,
38 HandleInputStart,
39 AnimationStart,
40 PerformTraversalsStart,
41 DrawStart,
John Reckba6adf62015-02-19 14:36:50 -080042 // End of UI frame info
43
John Reckbe3fba02015-07-06 13:49:58 -070044 SyncQueued,
45
Chris Craik1b54fb22015-06-02 17:40:58 -070046 SyncStart,
47 IssueDrawCommandsStart,
48 SwapBuffers,
49 FrameCompleted,
John Reckba6adf62015-02-19 14:36:50 -080050
51 // Must be the last value!
Chris Craik1b54fb22015-06-02 17:40:58 -070052 NumIndexes
John Reckc87be992015-02-20 10:57:22 -080053};
John Reckba6adf62015-02-19 14:36:50 -080054
John Reck2a8bb052015-06-03 09:52:01 -070055extern const std::string FrameInfoNames[];
John Reck4db3d172015-06-02 15:58:43 -070056
Chris Craik1b54fb22015-06-02 17:40:58 -070057namespace FrameInfoFlags {
58 enum {
59 WindowLayoutChanged = 1 << 0,
60 RTAnimation = 1 << 1,
61 SurfaceCanvas = 1 << 2,
62 SkippedFrame = 1 << 3,
63 };
John Reckc87be992015-02-20 10:57:22 -080064};
John Reckba6adf62015-02-19 14:36:50 -080065
66class ANDROID_API UiFrameInfoBuilder {
67public:
68 UiFrameInfoBuilder(int64_t* buffer) : mBuffer(buffer) {
69 memset(mBuffer, 0, UI_THREAD_FRAME_INFO_SIZE * sizeof(int64_t));
70 }
71
72 UiFrameInfoBuilder& setVsync(nsecs_t vsyncTime, nsecs_t intendedVsync) {
Chris Craik1b54fb22015-06-02 17:40:58 -070073 set(FrameInfoIndex::Vsync) = vsyncTime;
74 set(FrameInfoIndex::IntendedVsync) = intendedVsync;
John Reckbf3c6022015-06-02 15:55:00 -070075 // Pretend the other fields are all at vsync, too, so that naive
76 // duration calculations end up being 0 instead of very large
Chris Craik1b54fb22015-06-02 17:40:58 -070077 set(FrameInfoIndex::HandleInputStart) = vsyncTime;
78 set(FrameInfoIndex::AnimationStart) = vsyncTime;
79 set(FrameInfoIndex::PerformTraversalsStart) = vsyncTime;
80 set(FrameInfoIndex::DrawStart) = vsyncTime;
John Reckba6adf62015-02-19 14:36:50 -080081 return *this;
82 }
83
Chris Craik1b54fb22015-06-02 17:40:58 -070084 UiFrameInfoBuilder& addFlag(int frameInfoFlag) {
85 set(FrameInfoIndex::Flags) |= static_cast<uint64_t>(frameInfoFlag);
John Reckba6adf62015-02-19 14:36:50 -080086 return *this;
87 }
88
89private:
John Reckc87be992015-02-20 10:57:22 -080090 inline int64_t& set(FrameInfoIndex index) {
91 return mBuffer[static_cast<int>(index)];
92 }
93
John Reckba6adf62015-02-19 14:36:50 -080094 int64_t* mBuffer;
95};
96
97class FrameInfo {
98public:
99 void importUiThreadInfo(int64_t* info);
100
101 void markSyncStart() {
Chris Craik1b54fb22015-06-02 17:40:58 -0700102 set(FrameInfoIndex::SyncStart) = systemTime(CLOCK_MONOTONIC);
John Reckba6adf62015-02-19 14:36:50 -0800103 }
104
105 void markIssueDrawCommandsStart() {
Chris Craik1b54fb22015-06-02 17:40:58 -0700106 set(FrameInfoIndex::IssueDrawCommandsStart) = systemTime(CLOCK_MONOTONIC);
John Reckba6adf62015-02-19 14:36:50 -0800107 }
108
109 void markSwapBuffers() {
Chris Craik1b54fb22015-06-02 17:40:58 -0700110 set(FrameInfoIndex::SwapBuffers) = systemTime(CLOCK_MONOTONIC);
John Reckba6adf62015-02-19 14:36:50 -0800111 }
112
113 void markFrameCompleted() {
Chris Craik1b54fb22015-06-02 17:40:58 -0700114 set(FrameInfoIndex::FrameCompleted) = systemTime(CLOCK_MONOTONIC);
John Reckba6adf62015-02-19 14:36:50 -0800115 }
116
Chris Craik1b54fb22015-06-02 17:40:58 -0700117 void addFlag(int frameInfoFlag) {
118 set(FrameInfoIndex::Flags) |= static_cast<uint64_t>(frameInfoFlag);
John Reck240ff622015-04-28 13:50:00 -0700119 }
120
John Reck41300272015-06-03 14:42:34 -0700121 inline int64_t operator[](FrameInfoIndex index) const {
John Reckbe3fba02015-07-06 13:49:58 -0700122 return get(index);
John Reckba6adf62015-02-19 14:36:50 -0800123 }
124
John Reck41300272015-06-03 14:42:34 -0700125 inline int64_t operator[](int index) const {
Chris Craik1b54fb22015-06-02 17:40:58 -0700126 if (index < 0 || index >= static_cast<int>(FrameInfoIndex::NumIndexes)) return 0;
John Reckc87be992015-02-20 10:57:22 -0800127 return mFrameInfo[index];
John Reckba6adf62015-02-19 14:36:50 -0800128 }
129
John Reck41300272015-06-03 14:42:34 -0700130 inline int64_t duration(FrameInfoIndex start, FrameInfoIndex end) const {
John Reckbe3fba02015-07-06 13:49:58 -0700131 int64_t endtime = get(end);
132 int64_t starttime = get(start);
John Reck41300272015-06-03 14:42:34 -0700133 int64_t gap = endtime - starttime;
134 gap = starttime > 0 ? gap : 0;
John Reckbe3fba02015-07-06 13:49:58 -0700135 if (end > FrameInfoIndex::SyncQueued &&
136 start < FrameInfoIndex::SyncQueued) {
137 // Need to subtract out the time spent in a stalled state
138 // as this will be captured by the previous frame's info
139 int64_t offset = get(FrameInfoIndex::SyncStart)
140 - get(FrameInfoIndex::SyncQueued);
141 if (offset > 0) {
142 gap -= offset;
143 }
144 }
John Reck41300272015-06-03 14:42:34 -0700145 return gap > 0 ? gap : 0;
146 }
147
148 inline int64_t totalDuration() const {
149 return duration(FrameInfoIndex::IntendedVsync, FrameInfoIndex::FrameCompleted);
150 }
151
John Reckc87be992015-02-20 10:57:22 -0800152 inline int64_t& set(FrameInfoIndex index) {
153 return mFrameInfo[static_cast<int>(index)];
154 }
155
John Reckbe3fba02015-07-06 13:49:58 -0700156 inline int64_t get(FrameInfoIndex index) const {
157 if (index == FrameInfoIndex::NumIndexes) return 0;
158 return mFrameInfo[static_cast<int>(index)];
159 }
160
161private:
Chris Craik1b54fb22015-06-02 17:40:58 -0700162 int64_t mFrameInfo[static_cast<int>(FrameInfoIndex::NumIndexes)];
John Reckba6adf62015-02-19 14:36:50 -0800163};
164
165} /* namespace uirenderer */
166} /* namespace android */
167
168#endif /* FRAMEINFO_H_ */