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 "Debug.h"
20 #include "log/log_main.h"
21 #ifdef __ANDROID__
22 #include "HWUIProperties.sysprop.h"
23 #endif
24 #include "SkTraceEventCommon.h"
25 
26 #include <algorithm>
27 #include <cstdlib>
28 #include <optional>
29 
30 #include <android-base/properties.h>
31 #include <cutils/compiler.h>
32 #include <log/log.h>
33 
34 namespace android {
35 namespace uirenderer {
36 
37 #ifndef __ANDROID__ // Layoutlib does not compile HWUIProperties.sysprop as it depends on cutils properties
use_vulkan()38 std::optional<bool> use_vulkan() {
39     return base::GetBoolProperty("ro.hwui.use_vulkan", false);
40 }
41 
render_ahead()42 std::optional<std::int32_t> render_ahead() {
43     return base::GetIntProperty("ro.hwui.render_ahead", 0);
44 }
45 #endif
46 
47 bool Properties::debugLayersUpdates = false;
48 bool Properties::debugOverdraw = false;
49 bool Properties::showDirtyRegions = false;
50 bool Properties::skipEmptyFrames = true;
51 bool Properties::useBufferAge = true;
52 bool Properties::enablePartialUpdates = true;
53 // Default true unless otherwise specified in RenderThread Configuration
54 bool Properties::enableRenderEffectCache = true;
55 
56 DebugLevel Properties::debugLevel = kDebugDisabled;
57 OverdrawColorSet Properties::overdrawColorSet = OverdrawColorSet::Default;
58 
59 float Properties::overrideLightRadius = -1.0f;
60 float Properties::overrideLightPosY = -1.0f;
61 float Properties::overrideLightPosZ = -1.0f;
62 float Properties::overrideAmbientRatio = -1.0f;
63 int Properties::overrideAmbientShadowStrength = -1;
64 int Properties::overrideSpotShadowStrength = -1;
65 
66 ProfileType Properties::sProfileType = ProfileType::None;
67 bool Properties::sDisableProfileBars = false;
68 RenderPipelineType Properties::sRenderPipelineType = RenderPipelineType::NotInitialized;
69 bool Properties::enableHighContrastText = false;
70 
71 bool Properties::waitForGpuCompletion = false;
72 bool Properties::forceDrawFrame = false;
73 
74 bool Properties::filterOutTestOverhead = false;
75 bool Properties::disableVsync = false;
76 bool Properties::skpCaptureEnabled = false;
77 bool Properties::enableRTAnimations = true;
78 
79 bool Properties::runningInEmulator = false;
80 bool Properties::debuggingEnabled = false;
81 bool Properties::isolatedProcess = false;
82 
83 int Properties::contextPriority = 0;
84 float Properties::defaultSdrWhitePoint = 200.f;
85 
86 bool Properties::useHintManager = true;
87 int Properties::targetCpuTimePercentage = 70;
88 
89 bool Properties::enableWebViewOverlays = true;
90 
91 StretchEffectBehavior Properties::stretchEffectBehavior = StretchEffectBehavior::ShaderHWUI;
92 
load()93 bool Properties::load() {
94     bool prevDebugLayersUpdates = debugLayersUpdates;
95     bool prevDebugOverdraw = debugOverdraw;
96 
97     debugOverdraw = false;
98     std::string debugOverdrawProperty = base::GetProperty(PROPERTY_DEBUG_OVERDRAW, "");
99     if (debugOverdrawProperty != "") {
100         INIT_LOGD("  Overdraw debug enabled: %s", debugOverdrawProperty);
101         if (debugOverdrawProperty == "show") {
102             debugOverdraw = true;
103             overdrawColorSet = OverdrawColorSet::Default;
104         } else if (debugOverdrawProperty == "show_deuteranomaly") {
105             debugOverdraw = true;
106             overdrawColorSet = OverdrawColorSet::Deuteranomaly;
107         }
108     }
109 
110     sProfileType = ProfileType::None;
111     std::string profileProperty = base::GetProperty(PROPERTY_PROFILE, "");
112     if (profileProperty != "") {
113         if (profileProperty == PROPERTY_PROFILE_VISUALIZE_BARS) {
114             sProfileType = ProfileType::Bars;
115         } else if (profileProperty == "true") {
116             sProfileType = ProfileType::Console;
117         }
118     }
119 
120     debugLayersUpdates = base::GetBoolProperty(PROPERTY_DEBUG_LAYERS_UPDATES, false);
121     INIT_LOGD("  Layers updates debug enabled: %d", debugLayersUpdates);
122 
123     showDirtyRegions = base::GetBoolProperty(PROPERTY_DEBUG_SHOW_DIRTY_REGIONS, false);
124 
125     debugLevel = (DebugLevel)base::GetIntProperty(PROPERTY_DEBUG, (int)kDebugDisabled);
126 
127     skipEmptyFrames = base::GetBoolProperty(PROPERTY_SKIP_EMPTY_DAMAGE, true);
128     useBufferAge = base::GetBoolProperty(PROPERTY_USE_BUFFER_AGE, true);
129     enablePartialUpdates = base::GetBoolProperty(PROPERTY_ENABLE_PARTIAL_UPDATES, true);
130 
131     filterOutTestOverhead = base::GetBoolProperty(PROPERTY_FILTER_TEST_OVERHEAD, false);
132 
133     skpCaptureEnabled = debuggingEnabled && base::GetBoolProperty(PROPERTY_CAPTURE_SKP_ENABLED, false);
134 
135     SkAndroidFrameworkTraceUtil::setEnableTracing(
136             base::GetBoolProperty(PROPERTY_SKIA_ATRACE_ENABLED, false));
137 
138     runningInEmulator = base::GetBoolProperty(PROPERTY_IS_EMULATOR, false);
139 
140     useHintManager = base::GetBoolProperty(PROPERTY_USE_HINT_MANAGER, true);
141     targetCpuTimePercentage = base::GetIntProperty(PROPERTY_TARGET_CPU_TIME_PERCENTAGE, 70);
142     if (targetCpuTimePercentage <= 0 || targetCpuTimePercentage > 100) targetCpuTimePercentage = 70;
143 
144     enableWebViewOverlays = base::GetBoolProperty(PROPERTY_WEBVIEW_OVERLAYS_ENABLED, true);
145 
146     return (prevDebugLayersUpdates != debugLayersUpdates) || (prevDebugOverdraw != debugOverdraw);
147 }
148 
overrideProperty(const char * name,const char * value)149 void Properties::overrideProperty(const char* name, const char* value) {
150     if (!strcmp(name, "disableProfileBars")) {
151         sDisableProfileBars = !strcmp(value, "true");
152         ALOGD("profile bars %s", sDisableProfileBars ? "disabled" : "enabled");
153         return;
154     } else if (!strcmp(name, "ambientRatio")) {
155         overrideAmbientRatio = std::min(std::max(atof(value), 0.0), 10.0);
156         ALOGD("ambientRatio = %.2f", overrideAmbientRatio);
157         return;
158     } else if (!strcmp(name, "lightRadius")) {
159         overrideLightRadius = std::min(std::max(atof(value), 0.0), 3000.0);
160         ALOGD("lightRadius = %.2f", overrideLightRadius);
161         return;
162     } else if (!strcmp(name, "lightPosY")) {
163         overrideLightPosY = std::min(std::max(atof(value), 0.0), 3000.0);
164         ALOGD("lightPos Y = %.2f", overrideLightPosY);
165         return;
166     } else if (!strcmp(name, "lightPosZ")) {
167         overrideLightPosZ = std::min(std::max(atof(value), 0.0), 3000.0);
168         ALOGD("lightPos Z = %.2f", overrideLightPosZ);
169         return;
170     } else if (!strcmp(name, "ambientShadowStrength")) {
171         overrideAmbientShadowStrength = atoi(value);
172         ALOGD("ambient shadow strength = 0x%x out of 0xff", overrideAmbientShadowStrength);
173         return;
174     } else if (!strcmp(name, "spotShadowStrength")) {
175         overrideSpotShadowStrength = atoi(value);
176         ALOGD("spot shadow strength = 0x%x out of 0xff", overrideSpotShadowStrength);
177         return;
178     }
179     ALOGD("failed overriding property %s to %s", name, value);
180 }
181 
getProfileType()182 ProfileType Properties::getProfileType() {
183     if (CC_UNLIKELY(sDisableProfileBars && sProfileType == ProfileType::Bars))
184         return ProfileType::None;
185     return sProfileType;
186 }
187 
peekRenderPipelineType()188 RenderPipelineType Properties::peekRenderPipelineType() {
189     // If sRenderPipelineType has been locked, just return the locked type immediately.
190     if (sRenderPipelineType != RenderPipelineType::NotInitialized) {
191         return sRenderPipelineType;
192     }
193     bool useVulkan = use_vulkan().value_or(false);
194     std::string rendererProperty = base::GetProperty(PROPERTY_RENDERER, useVulkan ? "skiavk" : "skiagl");
195     if (rendererProperty == "skiavk") {
196         return RenderPipelineType::SkiaVulkan;
197     }
198     return RenderPipelineType::SkiaGL;
199 }
200 
getRenderPipelineType()201 RenderPipelineType Properties::getRenderPipelineType() {
202     sRenderPipelineType = peekRenderPipelineType();
203     return sRenderPipelineType;
204 }
205 
overrideRenderPipelineType(RenderPipelineType type,bool inUnitTest)206 void Properties::overrideRenderPipelineType(RenderPipelineType type, bool inUnitTest) {
207     // If we're doing actual rendering then we can't change the renderer after it's been set.
208     // Unit tests can freely change this as often as it wants.
209     LOG_ALWAYS_FATAL_IF(sRenderPipelineType != RenderPipelineType::NotInitialized &&
210                                 sRenderPipelineType != type && !inUnitTest,
211                         "Trying to change pipeline but it's already set.");
212     sRenderPipelineType = type;
213 }
214 
215 }  // namespace uirenderer
216 }  // namespace android
217