mesa/src/vulkan/wsi
Antonio Ospite 222b85328e mesa: replace most occurrences of getenv() with os_get_option()
The standard way to query options in mesa is `os_get_option()` which
abstracts platform-specific mechanisms to get config variables.

However in quite a few places `getenv()` is still used and this may
preclude controlling some options on some systems.

For instance it is not generally possible to use `MESA_DEBUG` on
Android.

So replace most `getenv()` occurrences with  `os_get_option()` to
support configuration options more consistently across different
platforms.

Do the same with `secure_getenv()` replacing it with
`os_get_option_secure()`.

The bulk of the proposed changes are mechanically performed by the
following script:

-----------------------------------------------------------------------
  #!/bin/sh

  set -e

  replace() {

    # Don't replace in some files, for example where `os_get_option` is defined,
    # or in external files
    EXCLUDE_FILES_PATTERN='(src/util/os_misc.c|src/util/u_debug.h|src/gtest/include/gtest/internal/gtest-port.h)'

    # Don't replace some "system" variables
    EXCLUDE_VARS_PATTERN='("XDG|"DISPLAY|"HOME|"TMPDIR|"POSIXLY_CORRECT)'

    git grep "[=!( ]$1(" -- src/ | cut -d ':' -f 1 | sort | uniq | \
      grep -v -E "$EXCLUDE_FILES_PATTERN" | \
      while read -r file;
      do
        # Don't replace usages of XDG_* variables or HOME
        sed -E -e "/$EXCLUDE_VARS_PATTERN/!s/([=!\( ])$1\(/\1$2\(/g" -i "$file";
      done
  }

  # Add const to os_get_option results, to avoid warning about discarded qualifier:
  #   warning: initialization discards ‘const’ qualifier from pointer target type [-Wdiscarded-qualifiers]
  # but also errors in some cases:
  #   error: invalid conversion from ‘const char*’ to ‘char*’ [-fpermissive]
  add_const_results() {
    git grep -l -P '(?<!const )char.*os_get_option' | \
      while read -r file;
      do
        sed -e '/^\s*const/! s/\(char.*os_get_option\)/const \1/g' -i "$file"
      done
  }

  replace 'secure_getenv' 'os_get_option_secure'

  replace 'getenv' 'os_get_option'

  add_const_results
-----------------------------------------------------------------------

After this, the `#include "util/os_misc.h"` is also added in files where
`os_get_option()` was not used before.

And since the replacements from the script above generated some new
`-Wdiscarded-qualifiers` warnings, those have been addressed as well,
generally by declaring `os_get_option()` results as `const char *` and
adjusting some function declarations.

Finally some replacements caused new errors like:

-----------------------------------------------------------------------
../src/gallium/auxiliary/gallivm/lp_bld_misc.cpp:127:31: error: no matching function for call to 'strtok'
  127 |          for (n = 0, option = strtok(env_llc_options, " "); option; n++, option = strtok(NULL, " ")) {
      |                               ^~~~~~
/android-ndk-r27c/toolchains/llvm/prebuilt/linux-x86_64/bin/../sysroot/usr/include/string.h:124:17: note: candidate function not viable: 1st argument ('const char *') would lose const qualifier
  124 | char* _Nullable strtok(char* _Nullable __s, const char* _Nonnull __delimiter);
      |                 ^      ~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------------

Those have been addressed too, copying the const string returned by
`os_get_option()` so that it could be modified.

In particular, the error above has been fixed  by copying the `const
char *env_llc_options` variable in
`src/gallium/auxiliary/gallivm/lp_bld_misc.cpp` to a `char *` which can
be tokenized using `strtok()`.

Reviewed-by: Eric Engestrom <eric@igalia.com>
Reviewed-by: Yonggang Luo <luoyonggang@gmail.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/38128>
2025-11-06 04:36:13 +00:00
..
meson.build x11: Add an x11_xlib_display_is_thread_safe() helper 2025-07-16 01:32:56 +00:00
wsi_common.c mesa: replace most occurrences of getenv() with os_get_option() 2025-11-06 04:36:13 +00:00
wsi_common.h wsi/metal: Backend addition for drivers built on top of Metal 2025-10-13 20:17:17 +00:00
wsi_common_display.c wsi/display: Fix vkGetRandROutputDisplayEXT when connector is not leased yet. 2025-10-14 18:57:33 +00:00
wsi_common_display.h
wsi_common_drm.c wsi: Fix the flagging of dma_buf_sync_file for the amdgpu workaround. 2025-10-20 03:58:47 +00:00
wsi_common_drm.h vk/wsi: C++-proof wsi_common_drm.h 2023-03-24 15:49:25 +00:00
wsi_common_headless.c vulkan/wsi/headless: clean up headless wsi device and headers 2025-08-10 07:16:46 +00:00
wsi_common_metal.c wsi/metal: Backend addition for drivers built on top of Metal 2025-10-13 20:17:17 +00:00
wsi_common_metal_layer.h wsi/metal: Disable reference counting 2025-10-13 20:17:16 +00:00
wsi_common_metal_layer.m docs: update/fix vk spec urls 2025-10-22 09:23:34 +02:00
wsi_common_private.h Revert "wsi: Implements scaling controls for DRI3 presentation." 2025-10-16 09:41:00 +00:00
wsi_common_queue.h vulkan/wsi/queue: Use mtx_t and u_cnd_monotonic 2024-07-08 22:09:06 +00:00
wsi_common_wayland.c treewide: use UTIL_DYNARRAY_INIT 2025-11-04 13:39:48 +00:00
wsi_common_win32.cpp vulkan/wsi: Support alpha swapchains on win32 2024-11-13 04:26:46 +00:00
wsi_common_x11.c Revert "wsi: Implements scaling controls for DRI3 presentation." 2025-10-16 09:41:00 +00:00