Project Chimera
Меню

Исходники

341 строк · 19 КиБ

RUNLIB-ENV-MAP.md

1# Что каждая настройка делает с окружением
2
3Спецификация для порта `sw_runlib` в `chl-runtime` (фаза 0). Отвечает на
4вопрос «какие переменные окружения выставляет настройка X», без которого
5побайтовое сравнение с bash-версией невозможно.
6
7Снято с `~/Games/StartWine/data/scripts/sw_runlib` версии 423, 3 883 строки.
8
9## Как получено и чему тут можно верить
10
11Карта извлечена скриптом [`tools/extract-env-map.py`](tools/extract-env-map.py),
12а не чтением глазами. Воспроизвести:
13
14```
15python3 tools/extract-env-map.py \
16 ~/Games/StartWine/data/scripts/sw_runlib
17```
18
19> **Парсер эвристический, и это важно.** Bash полноценно не разбирается:
20> отслеживается только вложенность `if`/`fi` от строки с условием, плюс
21> переключение на ветку `else`. Отсюда два известных искажения:
22>
23> 1. **Переоценка для больших блоков.** Где вложенность считается неверно
24> (однострочные `if`, `case`), в список настройки попадают `export` из
25> соседних блоков. Ярче всего видно на `SW_USE_OPENGL`: часть строк
26> оттуда принадлежит блокам ниже.
27> 2. **Динамические значения не раскрываются.** `$(basename ...)`,
28> `$(grep ...)` и подстановки переменных оставлены как есть — их надо
29> вычислять в рантайме, а не подставлять статикой.
30>
31> Поэтому у каждого эффекта в квадратных скобках стоит **номер строки в
32> `sw_runlib`**. Перед реализацией каждой настройки строку надо открыть и
33> проверить глазами. Карта — указатель, куда смотреть, а не готовая истина.
34
35## Три категории настроек
36
37Все 53 настройки реестра (`chl-core/src/settings.rs`) разложены по механизму
38действия. Перекрёстная проверка сошлась: **настроек, которые `sw_runlib`
39использует, а реестр не знает, — ноль.**
40
41### А. Владеют своим блоком и выставляют переменные — 29
42
43Их карта ниже. Это основная работа `chl-runtime`.
44
45### Б. Подставляются значением внутрь чужого `export` — 9
46
47Своего блока нет, поэтому в карте ниже они не отдельными разделами:
48
49| Настройка | Куда подставляется |
50|---|---|
51| `SW_USE_WINE` | `WINEDIR` |
52| `SW_USE_WINEARCH` | `WINEARCH` |
53| `SW_USE_DXVK_VER` | `DXVK_VER` |
54| `SW_USE_VKD3D_VER` | `VKD3D_VER` |
55| `SW_USE_FPS_LIMIT` | `DXVK_FRAME_RATE` (в блоке `SW_USE_DXVK_HUD`) **и** `MANGOHUD_CONFIG` (в блоке `SW_USE_MANGOHUD`) — своей реализации нет |
56| `SW_USE_FSR_MODE` | `WINE_FULLSCREEN_FSR_MODE` (внутри блока `SW_USE_FSR`) |
57| `SW_USE_LAUNCH_PARAMETERS` | `LAUNCH_PARAMETERS` |
58| `SW_USE_MANGOHUD_CONFIG` | подставляется **внутрь** жёстко заданной строки `MANGOHUD_CONFIG` (строка 1002) |
59| `SW_USE_WINE_CPU_TOPOLOGY` | `WINE_CPU_TOPOLOGY` |
60
61> **Ловушка, которую легко пропустить при переписывании: у ограничения FPS
62> нет собственной реализации.** `SW_USE_FPS_LIMIT` встречается в `sw_runlib`
63> ровно дважды, и оба раза внутри чужого блока:
64>
65> - строка 998 — `fps_limit=${SW_USE_FPS_LIMIT}+0` внутри блока
66> `SW_USE_MANGOHUD`, то есть частью конфига MangoHud;
67> - строка 1163 — `DXVK_FRAME_RATE` внутри блока `SW_USE_DXVK_HUD`.
68>
69> Безусловной ветки нет. Значит **выключи и MangoHud, и оверлей DXVK — и
70> настройка «ограничить FPS» перестаёт работать молча.** На практике обычно
71> спасает MangoHud, включённый по умолчанию, поэтому баг не бросается в
72> глаза. Но настройка уровня «простой» не должна зависеть от экспертного
73> оверлея.
74>
75> Как быть в `chl-runtime`: сделать ограничение независимым, а расхождение
76> с bash зафиксировать явно — иначе побайтовое сравнение будет требовать
77> воспроизводить баг. Это первый известный случай, где паритет и
78> правильность расходятся; такие места надо перечислять, а не решать молча.
79>
80> Побочно: `+0` в `fps_limit=X+0` — это список из двух пределов MangoHud,
81> переключаемый по Shift_L+F1, то есть «X либо без ограничения». При `X=0`
82> получается `0+0`, то есть без ограничения в обоих положениях.
83
84### В. Действуют не через окружение — 15
85
86Символические ссылки, оверрайды DLL, правки реестра, генерация конфигов,
87выбор сборки Wine. Порт каждой — отдельная задача, не часть сборки окружения:
88
89`SW_USE_CONTROLLER`, `SW_USE_D3D_PLUGINS`, `SW_USE_DGVOODOO2`,
90`SW_USE_DISABLE_UPDATE_PFX`, `SW_USE_DXVK_GE`, `SW_USE_VKD3D_GE`,
91`SW_USE_LANG_MODE`, `SW_USE_NVAPI_DISABLE`,
92`SW_USE_REGEDIT_PATCH`, `SW_USE_VIRTUAL_DESKTOP`, `SW_USE_VKBASALT_CAS`,
93`SW_USE_VKBASALT_EFFECTS`, `SW_USE_WINDOWS_VER`, `SW_USE_WINEDLLOVERRIDES`,
94`SW_USE_WINE_MONO`.
95
96Заметки по некоторым:
97
98- `SW_USE_LANG_MODE` — задаёт `LANG` напрямую (строка 1431), но не в блоке
99 `if` по себе, поэтому в категорию А не попал.
100- `SW_USE_D3D_PLUGINS` — симлинки d3dx9_24…d3dx9_43 плюс **симметричный
101 обратный оверрайд** при выключении (строка 568). Не «ничего не делать», а
102 противоположный выбор.
103- `SW_USE_MANGOHUD_CONFIG` — не заменяет конфиг MangoHud, а **дописывается
104 внутрь** жёстко заданной в коде строки (строка 1002 внутри блока со строки
105 989). То есть пользователь может только добавить показатели к базовому
106 набору, но не убрать из него — например `no_display` и `position=top-right`
107 заданы жёстко и не переопределяются.
108
109## Объём порта в цифрах
110
111| Что | Сколько |
112|---|---|
113| Строк bash в `sw_runlib` | 3 883 |
114| Блоков, условных на `SW_USE_*` | 188 |
115| Инструкций `export` всего | 421 |
116| Переменных окружения, которые runlib выставляет | ~120 |
117| Настроек с эффектом на окружение | 29 |
118| Настроек-значений внутри чужих `export` | 9 |
119| Настроек вне окружения (симлинки, реестр, конфиги) | 15 |
120
121---
122
123# Карта
124
125Формат: под каждой настройкой — условие с номером строки, затем эффекты.
126`ИНАЧЕ:` помечает ветку `else` — там `unset` означает противоположное
127действие, а не то же самое.
128
129```
130## SW_USE_BACKUP_UPDATE_PERIOD
131 условие (строка 1403): "${SW_USE_BACKUP_UPDATE_PERIOD}" != 0
132 export SOURCE_DIR="${START_WINE_PATH}/data/app_saves" [1405]
133 export FULL_BACKUP_FILE="${START_WINE_PATH}/data/pfx_backup/saves_backup.iso" [1406]
134
135## SW_USE_BATTLEYE
136 условие (строка 1208): "${SW_USE_BATTLEYE}" == 1
137 export PROTON_BATTLEYE_RUNTIME="${START_WINE_PATH}/data/tools/utils/Proton BattlEye Runtime" [1209]
138 ИНАЧЕ: unset PROTON_BATTLEYE_RUNTIME [1212]
139
140## SW_USE_DLSS
141 условие (строка 1092): "${SW_USE_DLSS}" == 1
142 export DXVK_NVAPIHACK=0 [1094]
143 export DXVK_ENABLE_NVAPI=1 [1095]
144 export SW_USE_NVAPI_DISABLE=0 [1096]
145
146## SW_USE_DRI_PRIME
147 условие (строка 1197): "${SW_USE_DRI_PRIME}" == 1
148 export DRI_PRIME=1 [1198]
149 export __NV_PRIME_RENDER_OFFLOAD=1 [1199]
150
151## SW_USE_DXVK_HUD
152 условие (строка 1162): "${SW_USE_DXVK_HUD}" == 1
153 export DXVK_FRAME_RATE="${SW_USE_FPS_LIMIT}" [1163]
154 export DXVK_HUD="devinfo,fps,version,api,scale=0.9" [1164]
155
156## SW_USE_EASYANTICHEAT
157 условие (строка 1215): "${SW_USE_EASYANTICHEAT}" == 1
158 export PROTON_EAC_RUNTIME="${START_WINE_PATH}/data/tools/utils/Proton EasyAntiCheat Runtime" [1216]
159 ИНАЧЕ: unset PROTON_EAC_RUNTIME [1218]
160
161## SW_USE_ENABLE_VKBASALT
162 условие (строка 1167): "${SW_USE_ENABLE_VKBASALT}" == 1
163 export ENABLE_VKBASALT=1 [1168]
164 export VKBASALT_LOG_LEVEL="none" [1169]
165 export VKBASALT_LOG_FILE="${START_WINE_PATH}/data/tmp/logs/vkBasalt.log" [1170]
166 export VKBASALT_CONFIG_FILE="${START_WINE_PATH}/data/tools/utils/config/vkBasalt.conf" [1171]
167
168## SW_USE_ESYNC
169 условие (строка 1037): "${SW_USE_ESYNC}" == 1
170 export WINEESYNC=1 [1038]
171 ИНАЧЕ: unset WINEESYNC [1040]
172
173## SW_USE_FSR
174 условие (строка 1179): "${SW_USE_FSR}" == 1
175 export WINE_FULLSCREEN_FSR=1 [1180]
176 export WINE_FULLSCREEN_FSR_STRENGTH=3 [1181]
177 export WINE_FULLSCREEN_INTEGER_SCALING=0 [1182]
178 export FULLSCREEN_PRESERVE_WINDOW_SIZE=1 [1183]
179 export WINE_FULLSCREEN_FSR_MODE="${SW_USE_FSR_MODE}" [1184]
180 ИНАЧЕ: unset WINE_FULLSCREEN_FSR [1186]
181 ИНАЧЕ: unset WINE_FULLSCREEN_FSR_STRENGTH [1186]
182
183## SW_USE_FSYNC
184 условие (строка 1030): "${SW_USE_FSYNC}" == 1
185 export WINEFSYNC=1 [1031]
186 export WINEFSYNC_FUTEX2=1 [1032]
187 ИНАЧЕ: unset WINEFSYNC [1034]
188 ИНАЧЕ: unset WINEFSYNC_FUTEX2 [1034]
189
190## SW_USE_GALLIUM_HUD
191 условие (строка 1480): "${SW_USE_GALLIUM_HUD}" == 1
192 export GALLIUM_HUD_PERIOD=0.1 [1481]
193 export GALLIUM_HUD=".d.w320fps+.d.w320frametime+.d.w320cpu+.d.w320GPU-load+.d.w320memory-clock+.d.w320VRAM-usage+.d.w320temperature" [1482]
194
195## SW_USE_HDR
196 условие (строка 1191): "${SW_USE_HDR}" == 1
197 export DXVK_HDR=1 [1192]
198 ИНАЧЕ: unset DXVK_HDR [1194]
199
200## SW_USE_HIDE_NVIDIA_GPU
201 условие (строка 1226): "${SW_USE_HIDE_NVIDIA_GPU}" == 1
202 export WINE_HIDE_NVIDIA_GPU=1 [1227]
203
204## SW_USE_LARGE_ADDRESS_AWARE
205 условие (строка 1138): "${SW_USE_LARGE_ADDRESS_AWARE}" == 1
206 export WINE_LARGE_ADDRESS_AWARE=1 [1139]
207 ИНАЧЕ: unset WINE_LARGE_ADDRESS_AWARE [1141]
208
209## SW_USE_LOSSLESS_FG
210 условие (строка 1048): "${SW_USE_LOSSLESS_FG}" == 1
211 export ENABLE_LSFG=1 [1049]
212 export LSFG_PROCESS=$(basename "${SW_GAME_EXE}") [1050]
213 export LSFGVK_CONFIG="${HOME}/.config/lsfg-vk/conf.toml" [1051]
214 export LSFG_CHECK_EXE=$(grep -o "${LSFG_PROCESS}" "${LSFGVK_CONFIG}") [1071]
215 ИНАЧЕ: export DISABLE_LSFG=1 [1089]
216
217## SW_USE_MANGOHUD
218 условие (строка 981): "${SW_USE_MANGOHUD}" == 1
219 export MANGOHUD=1 [982]
220 export MANGOHUD_LOG_LEVEL="off" [983]
221 export SW_RUN_MANGOHUD="mangohud" [984]
222 export SW_HUD_SIZE="$("$CRIER" --hud)" [987]
223 export MANGOHUD_CONFIG="fps_color_change,\ [989]
224
225## SW_USE_MESA_OVERLAY_HUD
226 условие (строка 1573): "${SW_USE_MESA_OVERLAY_HUD}" == 1
227 export VK_LAYER_MESA_OVERLAY_CONFIG="output_file=${START_WINE_PATH}/data/tmp/stats/${SW_GAME_NAME}.txt" [1574]
228 ИНАЧЕ: export VK_LAYER_MESA_OVERLAY_CONFIG="no_display=1,output_file=${START_WINE_PATH}/data/tmp/stats/${SW_GAME_NAME}.txt" [1577]
229
230## SW_USE_NTSYNC
231 условие (строка 1024): "${SW_USE_NTSYNC}" == 1
232 export WINENTSYNC=1 [1025]
233 ИНАЧЕ: unset WINENTSYNC [1027]
234
235## SW_USE_OLD_GL_STRING
236 условие (строка 1043): "${SW_USE_OLD_GL_STRING}" == 1
237 export MESA_EXTENSION_MAX_YEAR="2003" [1044]
238
239## SW_USE_OPENGL
240 условие (строка 1456): "${SW_USE_OPENGL}" == 1
241 unset VK_INSTANCE_LAYERS [1458]
242 unset VK_LOADER_LAYERS_ENABLE [1458]
243 export GALLIUM_HUD_PERIOD=0.1 [1481]
244 export GALLIUM_HUD=".d.w320fps+.d.w320frametime+.d.w320cpu+.d.w320GPU-load+.d.w320memory-clock+.d.w320VRAM-usage+.d.w320temperature" [1482]
245 ИНАЧЕ: export DXVK_CONFIG_FILE="${START_WINE_PATH}/data/tools/utils/config/dxvk.conf" [1548]
246 ИНАЧЕ: export DXVK_STATE_CACHE_PATH="${START_WINE_PATH}/data/tmp/vulkan_shader_cache/${SW_GAME_NAME}" [1549]
247 ИНАЧЕ: export DXVK_SHADER_CACHE_PATH="${START_WINE_PATH}/data/tmp/vulkan_shader_cache/${SW_GAME_NAME}" [1550]
248 ИНАЧЕ: export DXVK_STATE_CACHE=1 [1551]
249 ИНАЧЕ: export DXVK_SHADER_CACHE=1 [1552]
250 ИНАЧЕ: export DXVK_LOG_LEVEL="none" [1553]
251 ИНАЧЕ: export DXVK_LOG_PATH="none" [1554]
252 ИНАЧЕ: unset DXVK_DEBUG [1555]
253 ИНАЧЕ: export VKD3D_SHADER_CACHE_PATH="${START_WINE_PATH}/data/tmp/vulkan_shader_cache/${SW_GAME_NAME}" [1557]
254 ИНАЧЕ: export VKD3D_FEATURE_LEVEL="12_0" [1558]
255 ИНАЧЕ: export VKD3D_SHADER_DEBUG="none" [1559]
256 ИНАЧЕ: export VKD3D_DEBUG="none" [1560]
257 ИНАЧЕ: export DXVK_STATE_CACHE=0 [1562]
258 ИНАЧЕ: export DXVK_SHADER_CACHE=0 [1563]
259 ИНАЧЕ: unset DXVK_CONFIG_FILE [1564]
260 ИНАЧЕ: unset DXVK_STATE_CACHE_PATH [1564]
261 ИНАЧЕ: unset DXVK_SHADER_CACHE_PATH [1564]
262 ИНАЧЕ: export VK_LAYER_MESA_OVERLAY_CONFIG="output_file=${START_WINE_PATH}/data/tmp/stats/${SW_GAME_NAME}.txt" [1574]
263 ИНАЧЕ: export VK_LAYER_MESA_OVERLAY_CONFIG="no_display=1,output_file=${START_WINE_PATH}/data/tmp/stats/${SW_GAME_NAME}.txt" [1577]
264
265## SW_USE_PFX
266 условие (строка 1719): "${SW_USE_PFX}" == "pfx_default"
267 ИНАЧЕ: export REIN_PFX=1 [1734]
268 ИНАЧЕ: export REIN_PFX=1 [1753]
269 условие (строка 1730): ! -f "${START_WINE_PATH}/data/pfx_backup/${SW_USE_PFX}.iso"
270 export REIN_PFX=1 [1734]
271 ИНАЧЕ: export REIN_PFX=1 [1753]
272
273## SW_USE_SHADER_CACHE
274 условие (строка 1241): "${SW_USE_SHADER_CACHE}" == 1
275 export __GL_SHADER_DISK_CACHE=1 [1242]
276 export __GL_SHADER_DISK_CACHE_SIZE="10737418240" [1243]
277 export MESA_DISK_CACHE_SINGLE_FILE=1 [1245]
278 export MESA_SHADER_CACHE_SIZE="10737418240" [1246]
279 ИНАЧЕ: export __GL_SHADER_DISK_CACHE=0 [1248]
280 ИНАЧЕ: export MESA_SHADER_CACHE_DISABLE=1 [1249]
281 ИНАЧЕ: unset __GL_SHADER_DISK_CACHE_SIZE [1250]
282 ИНАЧЕ: unset __GL_SHADER_DISK_CACHE_PATH [1250]
283 условие (строка 1546): "${SW_USE_SHADER_CACHE}" == 1
284 export DXVK_CONFIG_FILE="${START_WINE_PATH}/data/tools/utils/config/dxvk.conf" [1548]
285 export DXVK_STATE_CACHE_PATH="${START_WINE_PATH}/data/tmp/vulkan_shader_cache/${SW_GAME_NAME}" [1549]
286 export DXVK_SHADER_CACHE_PATH="${START_WINE_PATH}/data/tmp/vulkan_shader_cache/${SW_GAME_NAME}" [1550]
287 export DXVK_STATE_CACHE=1 [1551]
288 export DXVK_SHADER_CACHE=1 [1552]
289 export DXVK_LOG_LEVEL="none" [1553]
290 export DXVK_LOG_PATH="none" [1554]
291 unset DXVK_DEBUG [1555]
292 export VKD3D_SHADER_CACHE_PATH="${START_WINE_PATH}/data/tmp/vulkan_shader_cache/${SW_GAME_NAME}" [1557]
293 export VKD3D_FEATURE_LEVEL="12_0" [1558]
294 export VKD3D_SHADER_DEBUG="none" [1559]
295 export VKD3D_DEBUG="none" [1560]
296 ИНАЧЕ: export DXVK_STATE_CACHE=0 [1562]
297 ИНАЧЕ: export DXVK_SHADER_CACHE=0 [1563]
298 ИНАЧЕ: unset DXVK_CONFIG_FILE [1564]
299 ИНАЧЕ: unset DXVK_STATE_CACHE_PATH [1564]
300 ИНАЧЕ: unset DXVK_SHADER_CACHE_PATH [1564]
301
302## SW_USE_STAGING_SHARED_MEMORY
303 условие (строка 1156): "${SW_USE_STAGING_SHARED_MEMORY}" == 1
304 export STAGING_SHARED_MEMORY=1 [1157]
305 ИНАЧЕ: unset STAGING_SHARED_MEMORY [1159]
306
307## SW_USE_STAGING_WRITECOPY
308 условие (строка 1144): "${SW_USE_STAGING_WRITECOPY}" == 1
309 export STAGING_WRITECOPY=1 [1145]
310 ИНАЧЕ: unset STAGING_WRITECOPY [1147]
311
312## SW_USE_VSYNC_DISABLE
313 условие (строка 1221): "${SW_USE_VSYNC_DISABLE}" == 1
314 export __GL_SYNC_TO_VBLANK=0 [1223]
315
316## SW_USE_WAYLAND
317 условие (строка 1011): "${SW_USE_WAYLAND}" == 1
318 export WINE_USE_WAYLAND=1 [1013]
319 export WINE_WAYLAND_HACKS=1 [1014]
320 unset WINE_USE_WAYLAND [1018]
321 unset WINE_WAYLAND_HACKS [1018]
322 ИНАЧЕ: unset WINE_USE_WAYLAND [1021]
323 ИНАЧЕ: unset WINE_WAYLAND_HACKS [1021]
324
325## SW_USE_WINEDBG_DISABLE
326 условие (строка 1132): "${SW_USE_WINEDBG_DISABLE}" == 1
327 export WINEDEBUG="-all" [1133]
328 export WINE_DO_NOT_CREATE_DUMP=1 [1134]
329
330## SW_USE_WINE_SIMULATE_WRITECOPY
331 условие (строка 1150): "${SW_USE_WINE_SIMULATE_WRITECOPY}" == 1
332 export WINE_SIMULATE_WRITECOPY=1 [1151]
333 ИНАЧЕ: unset WINE_SIMULATE_WRITECOPY [1153]
334
335## SW_USE_WOW64
336 условие (строка 843): "${SW_USE_WOW64}" == 1 && -d "${WINEDIR}/bin-wow64"
337 export SW_WINE_BIN="bin-wow64" [844]
338 ИНАЧЕ: export SW_WINE_BIN="bin" [846]
339
340```
341