| /* |
| * Copyright (C) 2021 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| // NOTE: the content of this file is validated via check_flags.py script. |
| // Be mindful when changing structure of MACROs. |
| |
| #include <common/FlagManager.h> |
| |
| #include <SurfaceFlingerProperties.sysprop.h> |
| #include <android-base/parsebool.h> |
| #include <android-base/parseint.h> |
| #include <android-base/properties.h> |
| #include <android-base/stringprintf.h> |
| #include <log/log.h> |
| #include <server_configurable_flags/get_flags.h> |
| |
| #include <android_companion_virtualdevice_flags.h> |
| #include <android_hardware_flags.h> |
| #include <android_os.h> |
| #include <com_android_graphics_libgui_flags.h> |
| #include <com_android_graphics_surfaceflinger_flags.h> |
| #include <com_android_server_display_feature_flags.h> |
| #include <com_android_window_flags.h> |
| |
| namespace android { |
| using namespace com::android::graphics::surfaceflinger; |
| |
| static constexpr const char* kExperimentNamespace = "surface_flinger_native_boot"; |
| |
| FlagManager::~FlagManager() = default; |
| |
| namespace { |
| std::optional<bool> parseBool(const char* str) { |
| base::ParseBoolResult parseResult = base::ParseBool(str); |
| switch (parseResult) { |
| case base::ParseBoolResult::kTrue: |
| return std::make_optional(true); |
| case base::ParseBoolResult::kFalse: |
| return std::make_optional(false); |
| case base::ParseBoolResult::kError: |
| return std::nullopt; |
| } |
| } |
| |
| bool getFlagValue(std::function<bool()> getter, std::optional<bool> overrideValue) { |
| if (overrideValue.has_value()) { |
| return *overrideValue; |
| } |
| |
| return getter(); |
| } |
| |
| } // namespace |
| |
| const FlagManager& FlagManager::getInstance() { |
| return getMutableInstance(); |
| } |
| |
| FlagManager& FlagManager::getMutableInstance() { |
| static FlagManager sInstance; |
| return sInstance; |
| } |
| |
| void FlagManager::markBootCompleted() { |
| mBootCompleted = true; |
| } |
| |
| void FlagManager::setUnitTestMode() { |
| mUnitTestMode = true; |
| |
| // Also set boot completed as we don't really care about it in unit testing |
| mBootCompleted = true; |
| } |
| |
| void FlagManager::dumpFlag(std::string& result, bool aconfig, const char* name, |
| std::function<bool()> getter) const { |
| if (aconfig || mBootCompleted) { |
| base::StringAppendF(&result, "%s: %s\n", name, getter() ? "true" : "false"); |
| } else { |
| base::StringAppendF(&result, "%s: in progress (still booting)\n", name); |
| } |
| } |
| |
| void FlagManager::dump(std::string& result) const { |
| #define DUMP_FLAG_INTERNAL(name, aconfig) \ |
| dumpFlag(result, (aconfig), #name, std::bind(&FlagManager::name, this)) |
| #define DUMP_LEGACY_SERVER_FLAG(name) DUMP_FLAG_INTERNAL(name, false) |
| #define DUMP_ACONFIG_FLAG(name) DUMP_FLAG_INTERNAL(name, true) |
| #define DUMP_SYSPROP_FLAG(name) \ |
| dumpFlag(result, (true), "debug.sf." #name, std::bind(&FlagManager::name, this)) |
| |
| base::StringAppendF(&result, "FlagManager values: \n"); |
| |
| /// Sysprop flags /// |
| DUMP_SYSPROP_FLAG(disable_sched_fifo_sf); |
| DUMP_SYSPROP_FLAG(disable_sched_fifo_sf_binder); |
| DUMP_SYSPROP_FLAG(disable_sched_fifo_sf_sched); |
| DUMP_SYSPROP_FLAG(disable_sched_fifo_re); |
| DUMP_SYSPROP_FLAG(disable_sched_fifo_composer); |
| DUMP_SYSPROP_FLAG(disable_sched_fifo_composer_callback); |
| DUMP_SYSPROP_FLAG(force_agtm_without_luts); |
| DUMP_SYSPROP_FLAG(invalid_hdr_type_for_force_sdr_optin); |
| DUMP_SYSPROP_FLAG(productionize_readback_screenshot); |
| DUMP_SYSPROP_FLAG(stable_edid_ids_for_external_displays_optin); |
| |
| /// Legacy server flags /// |
| DUMP_LEGACY_SERVER_FLAG(test_flag); |
| DUMP_LEGACY_SERVER_FLAG(use_adpf_cpu_hint); |
| DUMP_LEGACY_SERVER_FLAG(use_skia_tracing); |
| |
| /// Trunk stable server (R/W) flags /// |
| /// IMPORTANT - please keep alphabetize to reduce merge conflicts |
| DUMP_ACONFIG_FLAG(adpf_gpu_sf); |
| DUMP_ACONFIG_FLAG(align_adpf_with_sf_opt_policy); |
| DUMP_ACONFIG_FLAG(bugfix_virtual_display_refresh_rate); |
| DUMP_ACONFIG_FLAG(color_transform_translation); |
| DUMP_ACONFIG_FLAG(color_transform_box_shadows_and_border); |
| DUMP_ACONFIG_FLAG(configure_work_duration); |
| DUMP_ACONFIG_FLAG(debug_gpu_present_times); |
| DUMP_ACONFIG_FLAG(disable_transparent_region_hint); |
| DUMP_ACONFIG_FLAG(enable_color_correction_bugfix); |
| DUMP_ACONFIG_FLAG(force_sdr_invalid_hdr_type); |
| DUMP_ACONFIG_FLAG(frontend_caching_v0); |
| DUMP_ACONFIG_FLAG(frametimeline_boottime_in_lambda); |
| DUMP_ACONFIG_FLAG(get_display_known_vsync_sample_enabled); |
| DUMP_ACONFIG_FLAG(graphite_renderengine_preview_rollout); |
| DUMP_ACONFIG_FLAG(graphite_renderengine_preview2_rollout); |
| DUMP_ACONFIG_FLAG(graphite_renderengine_desktop_rollout); |
| DUMP_ACONFIG_FLAG(hwc_buffer_override_skip); |
| DUMP_ACONFIG_FLAG(luts_api); |
| DUMP_ACONFIG_FLAG(md_degrade_hdr); |
| DUMP_ACONFIG_FLAG(mirror_uid_filtering); |
| DUMP_ACONFIG_FLAG(mirror_with_crop); |
| DUMP_ACONFIG_FLAG(monitor_buffer_fences); |
| DUMP_ACONFIG_FLAG(mrr_full_frame_rate_list); |
| DUMP_ACONFIG_FLAG(offload_gpu_composition); |
| DUMP_ACONFIG_FLAG(readback_screenshot); |
| DUMP_ACONFIG_FLAG(re_powered_off_displays_inform_cache_budgets); |
| DUMP_ACONFIG_FLAG(refresh_rate_overlay_on_external_display); |
| DUMP_ACONFIG_FLAG(set_power_mode_async); |
| DUMP_ACONFIG_FLAG(use_content_priority_for_jank_classification); |
| DUMP_ACONFIG_FLAG(use_experimental_jank_classification); |
| DUMP_ACONFIG_FLAG(use_last_vsync_predict); |
| DUMP_ACONFIG_FLAG(vd_aware_scheduler); |
| |
| /// Trunk stable readonly flags /// |
| /// IMPORTANT - please keep alphabetize to reduce merge conflicts |
| DUMP_ACONFIG_FLAG(bugfix_layer_caching_color_inversion_flickering); |
| DUMP_ACONFIG_FLAG(bugfix_resize_virtual_display_surfaces); |
| DUMP_ACONFIG_FLAG(cache_when_source_crop_layer_only_moved); |
| DUMP_ACONFIG_FLAG(connected_display_hdr_v2); |
| DUMP_ACONFIG_FLAG(connected_display_hdr_v3); |
| DUMP_ACONFIG_FLAG(correct_dpi_with_display_size); |
| DUMP_ACONFIG_FLAG(display_command_modeset); |
| DUMP_ACONFIG_FLAG(enable_user_preferred_hdr_mode); |
| DUMP_ACONFIG_FLAG(fence_handling); |
| DUMP_ACONFIG_FLAG(follower_arbitrary_refresh_rate_selection); |
| DUMP_ACONFIG_FLAG(follower_arbitrary_refresh_rate_selection_platform); |
| DUMP_ACONFIG_FLAG(follower_display_backpressure); |
| DUMP_ACONFIG_FLAG(follower_display_backpressure_platform); |
| DUMP_ACONFIG_FLAG(force_slower_follower_gpu_composition); |
| DUMP_ACONFIG_FLAG(force_slower_follower_gpu_composition_platform); |
| DUMP_ACONFIG_FLAG(frame_rate_category_mrr); |
| DUMP_ACONFIG_FLAG(graphite_renderengine); |
| DUMP_ACONFIG_FLAG(local_tonemap_screenshots); |
| DUMP_ACONFIG_FLAG(modeset_multi_display); |
| DUMP_ACONFIG_FLAG(modeset_state_machine); |
| DUMP_ACONFIG_FLAG(no_vsyncs_on_screen_off); |
| DUMP_ACONFIG_FLAG(parse_edid_version_and_input_type_v2); |
| DUMP_ACONFIG_FLAG(protected_if_client); |
| DUMP_ACONFIG_FLAG(renderable_buffer_usage); |
| DUMP_ACONFIG_FLAG(restore_blur_step); |
| DUMP_ACONFIG_FLAG(shader_disk_cache); |
| DUMP_ACONFIG_FLAG(small_blur_region_improvements); |
| DUMP_ACONFIG_FLAG(skip_invisible_windows_in_input); |
| DUMP_ACONFIG_FLAG(stable_edid_ids); |
| DUMP_ACONFIG_FLAG(synced_resolution_switch); |
| DUMP_ACONFIG_FLAG(true_hdr_screenshots); |
| DUMP_ACONFIG_FLAG(virtual_display_content_filtering); |
| DUMP_ACONFIG_FLAG(vulkan_renderengine); |
| DUMP_ACONFIG_FLAG(wb_framebuffersurface2); |
| DUMP_ACONFIG_FLAG(wb_virtualdisplay2); |
| DUMP_ACONFIG_FLAG(window_blur_kawase2_preallocate_buffers); |
| /// IMPORTANT - please keep alphabetize to reduce merge conflicts |
| |
| #undef DUMP_ACONFIG_FLAG |
| #undef DUMP_LEGACY_SERVER_FLAG |
| #undef DUMP_FLAG_INTERVAL |
| } |
| |
| std::optional<bool> FlagManager::getBoolProperty(const char* property) const { |
| return parseBool(base::GetProperty(property, "").c_str()); |
| } |
| |
| bool FlagManager::getServerConfigurableFlag(const char* experimentFlagName) const { |
| const auto value = server_configurable_flags::GetServerConfigurableFlag(kExperimentNamespace, |
| experimentFlagName, ""); |
| const auto res = parseBool(value.c_str()); |
| return res.has_value() && res.value(); |
| } |
| #define FLAG_MANAGER_SYSPROP_FLAG(name, defaultVal) \ |
| bool FlagManager::name() const { \ |
| static const bool kFlagValue = \ |
| base::GetBoolProperty("debug.sf." #name, /* default value*/ defaultVal); \ |
| return kFlagValue; \ |
| } |
| |
| #define FLAG_MANAGER_LEGACY_SERVER_FLAG(name, syspropOverride, serverFlagName) \ |
| bool FlagManager::name() const { \ |
| LOG_ALWAYS_FATAL_IF(!mBootCompleted, \ |
| "Can't read %s before boot completed as it is server writable", \ |
| __func__); \ |
| const auto debugOverride = getBoolProperty(syspropOverride); \ |
| if (debugOverride.has_value()) return debugOverride.value(); \ |
| return getServerConfigurableFlag(serverFlagName); \ |
| } |
| |
| #define FLAG_MANAGER_ACONFIG_INTERNAL(name, syspropOverride, owner) \ |
| bool FlagManager::name() const { \ |
| static const std::optional<bool> debugOverride = getBoolProperty(syspropOverride); \ |
| static const bool value = getFlagValue([] { return owner ::name(); }, debugOverride); \ |
| if (mUnitTestMode) { \ |
| /* \ |
| * When testing, we don't want to rely on the cached `value` or the debugOverride. \ |
| */ \ |
| return owner ::name(); \ |
| } \ |
| return value; \ |
| } |
| |
| #define FLAG_MANAGER_ACONFIG_FLAG(name, syspropOverride) \ |
| FLAG_MANAGER_ACONFIG_INTERNAL(name, syspropOverride, flags) |
| |
| #define FLAG_MANAGER_ACONFIG_FLAG_IMPORTED(name, syspropOverride, owner) \ |
| FLAG_MANAGER_ACONFIG_INTERNAL(name, syspropOverride, owner) |
| |
| /// Debug sysprop flags - default value is always false /// |
| FLAG_MANAGER_SYSPROP_FLAG(disable_sched_fifo_sf, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(disable_sched_fifo_sf_binder, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(disable_sched_fifo_sf_sched, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(disable_sched_fifo_re, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(disable_sched_fifo_composer, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(disable_sched_fifo_composer_callback, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(force_agtm_without_luts, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(invalid_hdr_type_for_force_sdr_optin, /* default */ false); |
| FLAG_MANAGER_SYSPROP_FLAG(productionize_readback_screenshot, /* default */ false) |
| FLAG_MANAGER_SYSPROP_FLAG(stable_edid_ids_for_external_displays_optin, /* default */ false) |
| |
| /// Legacy server flags /// |
| FLAG_MANAGER_LEGACY_SERVER_FLAG(test_flag, "", "") |
| FLAG_MANAGER_LEGACY_SERVER_FLAG(use_adpf_cpu_hint, "debug.sf.enable_adpf_cpu_hint", |
| "AdpfFeature__adpf_cpu_hint") |
| FLAG_MANAGER_LEGACY_SERVER_FLAG(use_skia_tracing, "debug.renderengine.skia_atrace_enabled", |
| "SkiaTracingFeature__use_skia_tracing") |
| |
| /// Trunk stable readonly flags /// |
| /// IMPORTANT - please keep alphabetized to reduce merge conflicts |
| FLAG_MANAGER_ACONFIG_FLAG(cache_when_source_crop_layer_only_moved, |
| "debug.sf.cache_source_crop_only_moved") |
| FLAG_MANAGER_ACONFIG_FLAG(connected_display_hdr_v2, "debug.sf.connected_display_hdr_v2"); |
| FLAG_MANAGER_ACONFIG_FLAG(connected_display_hdr_v3, "debug.sf.connected_display_hdr_v3"); |
| FLAG_MANAGER_ACONFIG_FLAG(correct_dpi_with_display_size, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(display_command_modeset, "debug.sf.display_command_modeset") |
| FLAG_MANAGER_ACONFIG_FLAG(fence_handling, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(follower_arbitrary_refresh_rate_selection, |
| "debug.sf.follower_arbitrary_refresh_rate_selection"); |
| FLAG_MANAGER_ACONFIG_FLAG(follower_arbitrary_refresh_rate_selection_platform, |
| "debug.sf.follower_arbitrary_refresh_rate_selection_platform"); |
| FLAG_MANAGER_ACONFIG_FLAG(follower_display_backpressure, "debug.sf.follower_display_backpressure"); |
| FLAG_MANAGER_ACONFIG_FLAG(follower_display_backpressure_platform, |
| "debug.sf.follower_display_backpressure_platform"); |
| FLAG_MANAGER_ACONFIG_FLAG(force_slower_follower_gpu_composition, |
| "debug.sf.force_slower_follower_gpu_composition"); |
| FLAG_MANAGER_ACONFIG_FLAG(force_slower_follower_gpu_composition_platform, |
| "debug.sf.force_slower_follower_gpu_composition_platform"); |
| FLAG_MANAGER_ACONFIG_FLAG(frame_rate_category_mrr, "debug.sf.frame_rate_category_mrr") |
| FLAG_MANAGER_ACONFIG_FLAG(frametimeline_boottime_in_lambda, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(graphite_renderengine, "debug.renderengine.graphite") |
| FLAG_MANAGER_ACONFIG_FLAG(local_tonemap_screenshots, "debug.sf.local_tonemap_screenshots"); |
| FLAG_MANAGER_ACONFIG_FLAG(modeset_multi_display, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(modeset_state_machine, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(no_vsyncs_on_screen_off, "debug.sf.no_vsyncs_on_screen_off") |
| FLAG_MANAGER_ACONFIG_FLAG(parse_edid_version_and_input_type_v2, |
| "debug.sf.parse_edid_version_and_input_type_v2"); |
| FLAG_MANAGER_ACONFIG_FLAG(protected_if_client, "") |
| FLAG_MANAGER_ACONFIG_FLAG(renderable_buffer_usage, "") |
| FLAG_MANAGER_ACONFIG_FLAG(restore_blur_step, "debug.renderengine.restore_blur_step") |
| FLAG_MANAGER_ACONFIG_FLAG(shader_disk_cache, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(small_blur_region_improvements, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(skip_invisible_windows_in_input, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(stable_edid_ids, "debug.sf.stable_edid_ids") |
| FLAG_MANAGER_ACONFIG_FLAG(synced_resolution_switch, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(true_hdr_screenshots, "debug.sf.true_hdr_screenshots"); |
| FLAG_MANAGER_ACONFIG_FLAG(virtual_display_content_filtering, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(vulkan_renderengine, "debug.renderengine.vulkan") |
| FLAG_MANAGER_ACONFIG_FLAG(wb_framebuffersurface2, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(wb_virtualdisplay2, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(window_blur_kawase2_preallocate_buffers, ""); |
| |
| /// Trunk stable server (R/W) flags /// |
| /// IMPORTANT - please keep alphabetized to reduce merge conflicts |
| FLAG_MANAGER_ACONFIG_FLAG(adpf_gpu_sf, "") |
| FLAG_MANAGER_ACONFIG_FLAG(align_adpf_with_sf_opt_policy, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(bugfix_layer_caching_color_inversion_flickering, |
| "debug.sf.layer_caching_color_inversion_flickering_fix"); |
| FLAG_MANAGER_ACONFIG_FLAG(bugfix_resize_virtual_display_surfaces, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(bugfix_virtual_display_refresh_rate, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(color_transform_box_shadows_and_border, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(color_transform_translation, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(configure_work_duration, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(disable_transparent_region_hint, |
| "debug.sf.disable_transparent_region_hint"); |
| FLAG_MANAGER_ACONFIG_FLAG(enable_color_correction_bugfix, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(force_sdr_invalid_hdr_type, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(frontend_caching_v0, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(get_display_known_vsync_sample_enabled, |
| "debug.sf.get_display_known_vsync_sample_enabled"); |
| FLAG_MANAGER_ACONFIG_FLAG(graphite_renderengine_preview_rollout, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(graphite_renderengine_preview2_rollout, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(graphite_renderengine_desktop_rollout, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(hwc_buffer_override_skip, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(md_degrade_hdr, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(mirror_uid_filtering, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(mirror_with_crop, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(monitor_buffer_fences, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(mrr_full_frame_rate_list, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(offload_gpu_composition, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(re_powered_off_displays_inform_cache_budgets, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(readback_screenshot, "") |
| FLAG_MANAGER_ACONFIG_FLAG(refresh_rate_overlay_on_external_display, "") |
| FLAG_MANAGER_ACONFIG_FLAG(set_power_mode_async, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(use_content_priority_for_jank_classification, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(use_experimental_jank_classification, ""); |
| FLAG_MANAGER_ACONFIG_FLAG(use_last_vsync_predict, "debug.sf.use_last_vsync_predict"); |
| FLAG_MANAGER_ACONFIG_FLAG(vd_aware_scheduler, ""); |
| |
| /// Trunk stable server (R/W) flags from outside SurfaceFlinger /// |
| |
| FLAG_MANAGER_ACONFIG_FLAG_IMPORTED(debug_gpu_present_times, "", |
| com::android::graphics::libgui::flags); |
| FLAG_MANAGER_ACONFIG_FLAG_IMPORTED(luts_api, "", android::hardware::flags); |
| FLAG_MANAGER_ACONFIG_FLAG_IMPORTED(enable_user_preferred_hdr_mode, "", com::android::window::flags); |
| |
| bool FlagManager::follower_arbitrary_refresh_rate_selection_combined() const { |
| return follower_arbitrary_refresh_rate_selection() || |
| follower_arbitrary_refresh_rate_selection_platform(); |
| } |
| |
| bool FlagManager::follower_display_backpressure_combined() const { |
| return follower_display_backpressure() || follower_display_backpressure_platform(); |
| } |
| |
| bool FlagManager::force_slower_follower_gpu_composition_combined() const { |
| return force_slower_follower_gpu_composition() || |
| force_slower_follower_gpu_composition_platform(); |
| } |
| } // namespace android |
