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
17 #include "Properties.h"
18
19 #include <android-base/properties.h>
20 #include <cutils/compiler.h>
21 #include <log/log.h>
22
23 #include <algorithm>
24 #include <cstdlib>
25 #include <optional>
26
27 #include "Debug.h"
28 #include "HWUIProperties.sysprop.h"
29 #include "src/core/SkTraceEventCommon.h"
30
31 #ifdef __ANDROID__
32 #include <com_android_graphics_hwui_flags.h>
33 namespace hwui_flags = com::android::graphics::hwui::flags;
34 #else
35 namespace hwui_flags {
clip_surfaceviews()36 constexpr bool clip_surfaceviews() {
37 return false;
38 }
hdr_10bit_plus()39 constexpr bool hdr_10bit_plus() {
40 return false;
41 }
initialize_gl_always()42 constexpr bool initialize_gl_always() {
43 return false;
44 }
45
skip_eglmanager_telemetry()46 constexpr bool skip_eglmanager_telemetry() {
47 return false;
48 }
49
resample_gainmap_regions()50 constexpr bool resample_gainmap_regions() {
51 return false;
52 }
53
query_global_priority()54 constexpr bool query_global_priority() {
55 return false;
56 }
57 } // namespace hwui_flags
58 #endif
59
60 namespace android {
61 namespace uirenderer {
62
63 bool Properties::debugLayersUpdates = false;
64 bool Properties::debugOverdraw = false;
65 bool Properties::debugTraceGpuResourceCategories = false;
66 bool Properties::showDirtyRegions = false;
67 bool Properties::skipEmptyFrames = true;
68 bool Properties::useBufferAge = true;
69 bool Properties::enablePartialUpdates = true;
70 // Default true unless otherwise specified in RenderThread Configuration
71 bool Properties::enableRenderEffectCache = true;
72
73 DebugLevel Properties::debugLevel = kDebugDisabled;
74 OverdrawColorSet Properties::overdrawColorSet = OverdrawColorSet::Default;
75
76 float Properties::overrideLightRadius = -1.0f;
77 float Properties::overrideLightPosY = -1.0f;
78 float Properties::overrideLightPosZ = -1.0f;
79 float Properties::overrideAmbientRatio = -1.0f;
80 int Properties::overrideAmbientShadowStrength = -1;
81 int Properties::overrideSpotShadowStrength = -1;
82
83 ProfileType Properties::sProfileType = ProfileType::None;
84 bool Properties::sDisableProfileBars = false;
85 RenderPipelineType Properties::sRenderPipelineType = RenderPipelineType::NotInitialized;
86 bool Properties::enableHighContrastText = false;
87
88 bool Properties::waitForGpuCompletion = false;
89
90 bool Properties::filterOutTestOverhead = false;
91 bool Properties::disableVsync = false;
92 bool Properties::skpCaptureEnabled = false;
93 bool Properties::enableRTAnimations = true;
94
95 bool Properties::runningInEmulator = false;
96 bool Properties::debuggingEnabled = false;
97 bool Properties::isolatedProcess = false;
98
99 int Properties::contextPriority = 0;
100 float Properties::defaultSdrWhitePoint = 200.f;
101
102 bool Properties::useHintManager = false;
103 int Properties::targetCpuTimePercentage = 70;
104
105 bool Properties::enableWebViewOverlays = true;
106
107 bool Properties::isHighEndGfx = true;
108 bool Properties::isLowRam = false;
109 bool Properties::isSystemOrPersistent = false;
110
111 float Properties::maxHdrHeadroomOn8bit = 5.f; // TODO: Refine this number
112
113 bool Properties::clipSurfaceViews = false;
114 bool Properties::hdr10bitPlus = false;
115 bool Properties::skipTelemetry = false;
116 bool Properties::queryGlobalPriority = false;
117
118 int Properties::timeoutMultiplier = 1;
119
120 StretchEffectBehavior Properties::stretchEffectBehavior = StretchEffectBehavior::ShaderHWUI;
121
122 DrawingEnabled Properties::drawingEnabled = DrawingEnabled::NotInitialized;
123
load()124 bool Properties::load() {
125 bool prevDebugLayersUpdates = debugLayersUpdates;
126 bool prevDebugOverdraw = debugOverdraw;
127
128 debugOverdraw = false;
129 std::string debugOverdrawProperty = base::GetProperty(PROPERTY_DEBUG_OVERDRAW, "");
130 if (debugOverdrawProperty != "") {
131 INIT_LOGD(" Overdraw debug enabled: %s", debugOverdrawProperty.c_str());
132 if (debugOverdrawProperty == "show") {
133 debugOverdraw = true;
134 overdrawColorSet = OverdrawColorSet::Default;
135 } else if (debugOverdrawProperty == "show_deuteranomaly") {
136 debugOverdraw = true;
137 overdrawColorSet = OverdrawColorSet::Deuteranomaly;
138 }
139 }
140
141 sProfileType = ProfileType::None;
142 std::string profileProperty = base::GetProperty(PROPERTY_PROFILE, "");
143 if (profileProperty != "") {
144 if (profileProperty == PROPERTY_PROFILE_VISUALIZE_BARS) {
145 sProfileType = ProfileType::Bars;
146 } else if (profileProperty == "true") {
147 sProfileType = ProfileType::Console;
148 }
149 }
150
151 debugLayersUpdates = base::GetBoolProperty(PROPERTY_DEBUG_LAYERS_UPDATES, false);
152 INIT_LOGD(" Layers updates debug enabled: %d", debugLayersUpdates);
153
154 showDirtyRegions = base::GetBoolProperty(PROPERTY_DEBUG_SHOW_DIRTY_REGIONS, false);
155
156 debugLevel = (DebugLevel)base::GetIntProperty(PROPERTY_DEBUG, (int)kDebugDisabled);
157
158 skipEmptyFrames = base::GetBoolProperty(PROPERTY_SKIP_EMPTY_DAMAGE, true);
159 useBufferAge = base::GetBoolProperty(PROPERTY_USE_BUFFER_AGE, true);
160 enablePartialUpdates = base::GetBoolProperty(PROPERTY_ENABLE_PARTIAL_UPDATES, true);
161
162 filterOutTestOverhead = base::GetBoolProperty(PROPERTY_FILTER_TEST_OVERHEAD, false);
163
164 skpCaptureEnabled = debuggingEnabled && base::GetBoolProperty(PROPERTY_CAPTURE_SKP_ENABLED, false);
165
166 bool skiaBroadTracing = base::GetBoolProperty(PROPERTY_SKIA_TRACING_ENABLED, false);
167 SkAndroidFrameworkTraceUtil::setEnableTracing(skiaBroadTracing);
168 SkAndroidFrameworkTraceUtil::setUsePerfettoTrackEvents(
169 base::GetBoolProperty(PROPERTY_SKIA_USE_PERFETTO_TRACK_EVENTS, false));
170 debugTraceGpuResourceCategories =
171 base::GetBoolProperty(PROPERTY_TRACE_GPU_RESOURCES, skiaBroadTracing);
172
173 runningInEmulator = base::GetBoolProperty(PROPERTY_IS_EMULATOR, false);
174
175 useHintManager = base::GetBoolProperty(PROPERTY_USE_HINT_MANAGER, false);
176 targetCpuTimePercentage = base::GetIntProperty(PROPERTY_TARGET_CPU_TIME_PERCENTAGE, 70);
177 if (targetCpuTimePercentage <= 0 || targetCpuTimePercentage > 100) targetCpuTimePercentage = 70;
178
179 enableWebViewOverlays = base::GetBoolProperty(PROPERTY_WEBVIEW_OVERLAYS_ENABLED, true);
180
181 auto hdrHeadroom = (float)atof(base::GetProperty(PROPERTY_8BIT_HDR_HEADROOM, "").c_str());
182 if (hdrHeadroom >= 1.f) {
183 maxHdrHeadroomOn8bit = std::min(hdrHeadroom, 100.f);
184 }
185
186 // call isDrawingEnabled to force loading of the property
187 isDrawingEnabled();
188
189 clipSurfaceViews =
190 base::GetBoolProperty("debug.hwui.clip_surfaceviews", hwui_flags::clip_surfaceviews());
191 hdr10bitPlus = hwui_flags::hdr_10bit_plus();
192 queryGlobalPriority = hwui_flags::query_global_priority();
193
194 timeoutMultiplier = android::base::GetIntProperty("ro.hw_timeout_multiplier", 1);
195 skipTelemetry = base::GetBoolProperty(PROPERTY_SKIP_EGLMANAGER_TELEMETRY,
196 hwui_flags::skip_eglmanager_telemetry());
197
198 return (prevDebugLayersUpdates != debugLayersUpdates) || (prevDebugOverdraw != debugOverdraw);
199 }
200
overrideProperty(const char * name,const char * value)201 void Properties::overrideProperty(const char* name, const char* value) {
202 if (!strcmp(name, "disableProfileBars")) {
203 sDisableProfileBars = !strcmp(value, "true");
204 ALOGD("profile bars %s", sDisableProfileBars ? "disabled" : "enabled");
205 return;
206 } else if (!strcmp(name, "ambientRatio")) {
207 overrideAmbientRatio = std::min(std::max(atof(value), 0.0), 10.0);
208 ALOGD("ambientRatio = %.2f", overrideAmbientRatio);
209 return;
210 } else if (!strcmp(name, "lightRadius")) {
211 overrideLightRadius = std::min(std::max(atof(value), 0.0), 3000.0);
212 ALOGD("lightRadius = %.2f", overrideLightRadius);
213 return;
214 } else if (!strcmp(name, "lightPosY")) {
215 overrideLightPosY = std::min(std::max(atof(value), 0.0), 3000.0);
216 ALOGD("lightPos Y = %.2f", overrideLightPosY);
217 return;
218 } else if (!strcmp(name, "lightPosZ")) {
219 overrideLightPosZ = std::min(std::max(atof(value), 0.0), 3000.0);
220 ALOGD("lightPos Z = %.2f", overrideLightPosZ);
221 return;
222 } else if (!strcmp(name, "ambientShadowStrength")) {
223 overrideAmbientShadowStrength = atoi(value);
224 ALOGD("ambient shadow strength = 0x%x out of 0xff", overrideAmbientShadowStrength);
225 return;
226 } else if (!strcmp(name, "spotShadowStrength")) {
227 overrideSpotShadowStrength = atoi(value);
228 ALOGD("spot shadow strength = 0x%x out of 0xff", overrideSpotShadowStrength);
229 return;
230 }
231 ALOGD("failed overriding property %s to %s", name, value);
232 }
233
getProfileType()234 ProfileType Properties::getProfileType() {
235 if (CC_UNLIKELY(sDisableProfileBars && sProfileType == ProfileType::Bars))
236 return ProfileType::None;
237 return sProfileType;
238 }
239
peekRenderPipelineType()240 RenderPipelineType Properties::peekRenderPipelineType() {
241 // If sRenderPipelineType has been locked, just return the locked type immediately.
242 if (sRenderPipelineType != RenderPipelineType::NotInitialized) {
243 return sRenderPipelineType;
244 }
245 bool useVulkan = use_vulkan().value_or(false);
246 std::string rendererProperty = base::GetProperty(PROPERTY_RENDERER, useVulkan ? "skiavk" : "skiagl");
247 if (rendererProperty == "skiavk") {
248 return RenderPipelineType::SkiaVulkan;
249 }
250 return RenderPipelineType::SkiaGL;
251 }
252
getRenderPipelineType()253 RenderPipelineType Properties::getRenderPipelineType() {
254 sRenderPipelineType = peekRenderPipelineType();
255 return sRenderPipelineType;
256 }
257
overrideRenderPipelineType(RenderPipelineType type)258 void Properties::overrideRenderPipelineType(RenderPipelineType type) {
259 // If we're doing actual rendering then we can't change the renderer after it's been set.
260 // Unit tests can freely change this as often as it wants, though, as there's no actual
261 // GL rendering happening
262 if (sRenderPipelineType != RenderPipelineType::NotInitialized) {
263 LOG_ALWAYS_FATAL_IF(sRenderPipelineType != type,
264 "Trying to change pipeline but it's already set");
265 return;
266 }
267 sRenderPipelineType = type;
268 }
269
setDrawingEnabled(bool newDrawingEnabled)270 void Properties::setDrawingEnabled(bool newDrawingEnabled) {
271 drawingEnabled = newDrawingEnabled ? DrawingEnabled::On : DrawingEnabled::Off;
272 enableRTAnimations = newDrawingEnabled;
273 }
274
isDrawingEnabled()275 bool Properties::isDrawingEnabled() {
276 if (drawingEnabled == DrawingEnabled::NotInitialized) {
277 bool drawingEnabledProp = base::GetBoolProperty(PROPERTY_DRAWING_ENABLED, true);
278 drawingEnabled = drawingEnabledProp ? DrawingEnabled::On : DrawingEnabled::Off;
279 enableRTAnimations = drawingEnabledProp;
280 }
281 return drawingEnabled == DrawingEnabled::On;
282 }
283
initializeGlAlways()284 bool Properties::initializeGlAlways() {
285 return base::GetBoolProperty(PROPERTY_INITIALIZE_GL_ALWAYS, hwui_flags::initialize_gl_always());
286 }
287
resampleGainmapRegions()288 bool Properties::resampleGainmapRegions() {
289 static bool sResampleGainmapRegions = base::GetBoolProperty(
290 "debug.hwui.resample_gainmap_regions", hwui_flags::resample_gainmap_regions());
291 return sResampleGainmapRegions;
292 }
293
294 } // namespace uirenderer
295 } // namespace android
296