1 /* 2 * Copyright (C) 2010 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 #ifndef ANDROID_HWUI_PROPERTIES_H 18 #define ANDROID_HWUI_PROPERTIES_H 19 20 #include <cutils/compiler.h> 21 22 /** 23 * This file contains the list of system properties used to configure libhwui. 24 */ 25 26 namespace android { 27 namespace uirenderer { 28 29 /////////////////////////////////////////////////////////////////////////////// 30 // Compile-time properties 31 /////////////////////////////////////////////////////////////////////////////// 32 33 // Textures used by layers must have dimensions multiples of this number 34 #define LAYER_SIZE 64 35 36 // Defines the size in bits of the stencil buffer for the framebuffer 37 // Note: Only 1 bit is required for clipping but more bits are required 38 // to properly implement overdraw debugging 39 #define STENCIL_BUFFER_SIZE 8 40 41 /////////////////////////////////////////////////////////////////////////////// 42 // Debug properties 43 /////////////////////////////////////////////////////////////////////////////// 44 45 /** 46 * Debug level for app developers. The value is a numeric value defined 47 * by the DebugLevel enum below. 48 */ 49 #define PROPERTY_DEBUG "debug.hwui.level" 50 51 /** 52 * Debug levels. Debug levels are used as flags. 53 */ 54 enum DebugLevel { 55 kDebugDisabled = 0, 56 kDebugMemory = 1, 57 kDebugCaches = 2, 58 kDebugMoreCaches = kDebugMemory | kDebugCaches 59 }; 60 61 /** 62 * Used to enable/disable layers update debugging. The accepted values are 63 * "true" and "false". The default value is "false". 64 */ 65 #define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates" 66 67 /** 68 * Used to enable/disable overdraw debugging. 69 * 70 * The accepted values are 71 * "show", to show overdraw 72 * "show_deuteranomaly", to show overdraw if you suffer from Deuteranomaly 73 * "count", to show an overdraw counter 74 * "false", to disable overdraw debugging 75 * 76 * The default value is "false". 77 */ 78 #define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw" 79 80 /** 81 * System property used to enable or disable hardware rendering profiling. 82 * The default value of this property is assumed to be false. 83 * 84 * When profiling is enabled, the adb shell dumpsys gfxinfo command will 85 * output extra information about the time taken to execute by the last 86 * frames. 87 * 88 * Possible values: 89 * "true", to enable profiling 90 * "visual_bars", to enable profiling and visualize the results on screen 91 * "false", to disable profiling 92 */ 93 #define PROPERTY_PROFILE "debug.hwui.profile" 94 #define PROPERTY_PROFILE_VISUALIZE_BARS "visual_bars" 95 96 /** 97 * Turn on to draw dirty regions every other frame. 98 * 99 * Possible values: 100 * "true", to enable dirty regions debugging 101 * "false", to disable dirty regions debugging 102 */ 103 #define PROPERTY_DEBUG_SHOW_DIRTY_REGIONS "debug.hwui.show_dirty_regions" 104 105 /** 106 * Setting this property will enable or disable the dropping of frames with 107 * empty damage. Default is "true". 108 */ 109 #define PROPERTY_SKIP_EMPTY_DAMAGE "debug.hwui.skip_empty_damage" 110 111 /** 112 * Controls whether or not HWUI will use the EGL_EXT_buffer_age extension 113 * to do partial invalidates. Setting this to "false" will fall back to 114 * using BUFFER_PRESERVED instead 115 * Default is "true" 116 */ 117 #define PROPERTY_USE_BUFFER_AGE "debug.hwui.use_buffer_age" 118 119 /** 120 * Setting this to "false" will force HWUI to always do full-redraws of the surface. 121 * This will disable the use of EGL_EXT_buffer_age and BUFFER_PRESERVED. 122 * Default is "true" 123 */ 124 #define PROPERTY_ENABLE_PARTIAL_UPDATES "debug.hwui.use_partial_updates" 125 126 #define PROPERTY_FILTER_TEST_OVERHEAD "debug.hwui.filter_test_overhead" 127 128 /** 129 * Indicates whether PBOs can be used to back pixel buffers. 130 * Accepted values are "true" and "false". Default is true. 131 */ 132 #define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "debug.hwui.use_gpu_pixel_buffers" 133 134 /** 135 * Allows to set rendering pipeline mode to OpenGL (default), Skia OpenGL 136 * or Vulkan. 137 */ 138 #define PROPERTY_RENDERER "debug.hwui.renderer" 139 140 /** 141 * Allows to collect a recording of Skia drawing commands. 142 */ 143 #define PROPERTY_CAPTURE_SKP_ENABLED "debug.hwui.capture_skp_enabled" 144 145 /** 146 * Might split Skia's GPU resource utilization into separate tracing tracks (slow). 147 * 148 * Aggregate total and purgeable numbers will still be reported under a "misc" track when this is 149 * disabled, they just won't be split into distinct categories. Results may vary depending on GPU 150 * backend/API, and the category mappings defined in ATraceMemoryDump's hardcoded sResourceMap. 151 */ 152 #define PROPERTY_TRACE_GPU_RESOURCES "debug.hwui.trace_gpu_resources" 153 154 /** 155 * Allows broad recording of Skia drawing commands. 156 * 157 * If disabled, a very minimal set of trace events *may* be recorded. 158 * If enabled, a much broader set of trace events *may* be recorded. 159 * 160 * In either case, trace events are only recorded if an appropriately configured tracing session is 161 * active. 162 * 163 * Use debug.hwui.skia_use_perfetto_track_events to determine if ATrace (default) or Perfetto is 164 * used as the tracing backend. 165 */ 166 #define PROPERTY_SKIA_TRACING_ENABLED "debug.hwui.skia_tracing_enabled" 167 168 /** 169 * Switches Skia's tracing to use Perfetto's Track Event system instead of ATrace. 170 * 171 * If disabled, ATrace will be used by default, which will record trace events from any of Skia's 172 * tracing categories if overall system tracing is active and the "gfx" and "view" ATrace categories 173 * are enabled. 174 * 175 * If enabled, then Perfetto's Track Event system will be used instead, which will only record if an 176 * active Perfetto tracing session is targeting the correct apps and Skia tracing categories with 177 * the Track Event data source enabled. This approach may be used to selectively filter out 178 * undesired Skia tracing categories, and events will contain more data fields. 179 */ 180 #define PROPERTY_SKIA_USE_PERFETTO_TRACK_EVENTS "debug.hwui.skia_use_perfetto_track_events" 181 182 /** 183 * Defines how many frames in a sequence to capture. 184 */ 185 #define PROPERTY_CAPTURE_SKP_FRAMES "debug.hwui.capture_skp_frames" 186 187 /** 188 * File name and location, where a SKP recording will be saved. 189 */ 190 #define PROPERTY_CAPTURE_SKP_FILENAME "debug.hwui.skp_filename" 191 192 /** 193 * Controls whether HWUI will send timing hints to HintManager for 194 * better CPU scheduling. Accepted values are "true" and "false". 195 */ 196 #define PROPERTY_USE_HINT_MANAGER "debug.hwui.use_hint_manager" 197 198 /** 199 * Percentage of frame time that's used for CPU work. The rest is 200 * reserved for GPU work. This is used with use_hint_manager to 201 * provide timing hints to HintManager. Accepted values are 202 * integer from 1-100. 203 */ 204 #define PROPERTY_TARGET_CPU_TIME_PERCENTAGE "debug.hwui.target_cpu_time_percent" 205 206 /** 207 * Property for whether this is running in the emulator. 208 */ 209 #define PROPERTY_IS_EMULATOR "ro.boot.qemu" 210 211 /** 212 * Turns on the Skia GPU option "reduceOpsTaskSplitting" which improves GPU 213 * efficiency but may increase VRAM consumption. Default is "true". 214 */ 215 #define PROPERTY_REDUCE_OPS_TASK_SPLITTING "renderthread.skia.reduceopstasksplitting" 216 217 /** 218 * Enable WebView Overlays feature. 219 */ 220 #define PROPERTY_WEBVIEW_OVERLAYS_ENABLED "debug.hwui.webview_overlays_enabled" 221 222 /** 223 * Property for globally GL drawing state. Can be overridden per process with 224 * setDrawingEnabled. 225 */ 226 #define PROPERTY_DRAWING_ENABLED "debug.hwui.drawing_enabled" 227 228 #define PROPERTY_MEMORY_POLICY "debug.hwui.app_memory_policy" 229 230 #define PROPERTY_8BIT_HDR_HEADROOM "debug.hwui.8bit_hdr_headroom" 231 232 /** 233 * Whether to initialize GL even when HWUI is running Vulkan. 234 */ 235 #define PROPERTY_INITIALIZE_GL_ALWAYS "debug.hwui.initialize_gl_always" 236 237 /////////////////////////////////////////////////////////////////////////////// 238 // Misc 239 /////////////////////////////////////////////////////////////////////////////// 240 241 // Converts a number of mega-bytes into bytes 242 #define MB(s) ((s)*1024 * 1024) 243 // Converts a number of kilo-bytes into bytes 244 #define KB(s) ((s)*1024) 245 246 enum class ProfileType { None, Console, Bars }; 247 248 enum class OverdrawColorSet { Default = 0, Deuteranomaly }; 249 250 enum class RenderPipelineType { SkiaGL, SkiaVulkan, SkiaCpu, NotInitialized = 128 }; 251 252 enum class StretchEffectBehavior { 253 ShaderHWUI, // Stretch shader in HWUI only, matrix scale in SF 254 Shader, // Stretch shader in both HWUI and SF 255 UniformScale // Uniform scale stretch everywhere 256 }; 257 258 enum class DrawingEnabled { NotInitialized, On, Off }; 259 260 /** 261 * Renderthread-only singleton which manages several static rendering properties. Most of these 262 * are driven by system properties which are queried once at initialization, and again if init() 263 * is called. 264 */ 265 class Properties { 266 public: 267 static bool load(); 268 269 static bool debugLayersUpdates; 270 static bool debugOverdraw; 271 static bool debugTraceGpuResourceCategories; 272 static bool showDirtyRegions; 273 // TODO: Remove after stabilization period 274 static bool skipEmptyFrames; 275 static bool useBufferAge; 276 static bool enablePartialUpdates; 277 static bool enableRenderEffectCache; 278 279 // TODO: Move somewhere else? 280 static constexpr float textGamma = 1.45f; 281 282 static DebugLevel debugLevel; 283 static OverdrawColorSet overdrawColorSet; 284 285 // Override the value for a subset of properties in this class 286 static void overrideProperty(const char* name, const char* value); 287 288 static float overrideLightRadius; 289 static float overrideLightPosY; 290 static float overrideLightPosZ; 291 static float overrideAmbientRatio; 292 static int overrideAmbientShadowStrength; 293 static int overrideSpotShadowStrength; 294 295 static ProfileType getProfileType(); 296 static RenderPipelineType peekRenderPipelineType(); 297 static RenderPipelineType getRenderPipelineType(); 298 299 static bool enableHighContrastText; 300 301 // Should be used only by test apps 302 static bool waitForGpuCompletion; 303 static bool forceDrawFrame; 304 305 // Should only be set by automated tests to try and filter out 306 // any overhead they add 307 static bool filterOutTestOverhead; 308 309 // Workaround a device lockup in edge cases by switching to async mode 310 // instead of the default vsync (b/38372997). Only system_server should hit this. 311 // Any existing RenderProxy & Surface combination will be unaffected, only things 312 // created after changing this. 313 static bool disableVsync; 314 315 static bool skpCaptureEnabled; 316 317 // For experimentation b/68769804 318 static bool enableRTAnimations; 319 320 // Used for testing only to change the render pipeline. 321 static void overrideRenderPipelineType(RenderPipelineType); 322 323 static bool runningInEmulator; 324 325 static bool debuggingEnabled; 326 static bool isolatedProcess; 327 328 static int contextPriority; 329 330 static float defaultSdrWhitePoint; 331 332 static bool useHintManager; 333 static int targetCpuTimePercentage; 334 335 static bool enableWebViewOverlays; 336 337 static bool isHighEndGfx; 338 static bool isLowRam; 339 static bool isSystemOrPersistent; 340 341 static float maxHdrHeadroomOn8bit; 342 343 static bool clipSurfaceViews; 344 static bool hdr10bitPlus; 345 getStretchEffectBehavior()346 static StretchEffectBehavior getStretchEffectBehavior() { 347 return stretchEffectBehavior; 348 } 349 setIsHighEndGfx(bool isHighEndGfx)350 static void setIsHighEndGfx(bool isHighEndGfx) { 351 Properties::isHighEndGfx = isHighEndGfx; 352 stretchEffectBehavior = isHighEndGfx ? 353 StretchEffectBehavior::ShaderHWUI : 354 StretchEffectBehavior::UniformScale; 355 } 356 setIsLowRam(bool isLowRam)357 static void setIsLowRam(bool isLowRam) { Properties::isLowRam = isLowRam; } 358 setIsSystemOrPersistent(bool isSystemOrPersistent)359 static void setIsSystemOrPersistent(bool isSystemOrPersistent) { 360 Properties::isSystemOrPersistent = isSystemOrPersistent; 361 } 362 363 /** 364 * Used for testing. Typical configuration of stretch behavior is done 365 * through setIsHighEndGfx 366 */ setStretchEffectBehavior(StretchEffectBehavior behavior)367 static void setStretchEffectBehavior(StretchEffectBehavior behavior) { 368 stretchEffectBehavior = behavior; 369 } 370 371 // Represents if drawing is enabled. Should only be Off in headless testing environments 372 static DrawingEnabled drawingEnabled; 373 static bool isDrawingEnabled(); 374 static void setDrawingEnabled(bool enable); 375 376 static bool initializeGlAlways(); 377 378 private: 379 static StretchEffectBehavior stretchEffectBehavior; 380 static ProfileType sProfileType; 381 static bool sDisableProfileBars; 382 static RenderPipelineType sRenderPipelineType; 383 }; // class Caches 384 385 } // namespace uirenderer 386 } // namespace android 387 388 #endif // ANDROID_HWUI_PROPERTIES_H 389