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