260 строк · 13 КиБ
code/crates/chl-wine/src/shader_cache.rs
| 1 | //! Очистка шейдерных кэшей — драйверных и своего общего кэша DXVK/VKD3D. |
| 2 | //! |
| 3 | //! Паритет с `on_clear_shader_cache()` StartWine (`sw_func.py:2652-2717`): |
| 4 | //! те же каталоги (пути определены в `sw_data.py:204-212`), то же поведение — |
| 5 | //! очищается **содержимое** каждого каталога, а сам каталог остаётся: |
| 6 | //! `if cache.exists(): for cache in cache.iterdir(): rmtree/unlink` |
| 7 | //! (`sw_func.py:2654-2701` и далее). Это не «безопасный выбор из двух», а |
| 8 | //! именно то, что делает StartWine — драйверы и DXVK пересоздают файлы |
| 9 | //! кэша сами при следующем запуске, но и папку целиком удалять незачем. |
| 10 | //! |
| 11 | //! Список каталогов у StartWine: |
| 12 | //! |
| 13 | //! | что | путь | sw_data.py | |
| 14 | //! |---|---|---| |
| 15 | //! | Mesa | `~/.cache/mesa_shader_cache` | :205 | |
| 16 | //! | Mesa (shader factory) | `~/.cache/mesa_shader_cache_sf` | :206 | |
| 17 | //! | Mesa (disk cache DB) | `~/.cache/mesa_shader_cache_db` | :207 | |
| 18 | //! | RADV | `~/.cache/radv_builtin_shaders` | :208 | |
| 19 | //! | OpenGL общий | `~/.cache/gl_shader_cache` | :209 | |
| 20 | //! | NVIDIA OpenGL | `~/.nv/GLCache` | :210 | |
| 21 | //! | NVIDIA | `~/.cache/nvidia` | :211 | |
| 22 | //! | GStreamer | `~/.cache/gstreamer-1.0` | :204, используется в :2710 | |
| 23 | //! |
| 24 | //! `gstreamer-1.0` в задаче на порт не упомянут явно, но в самой функции |
| 25 | //! StartWine он чистится наравне с остальными (`sw_func.py:2710-2715) — |
| 26 | //! паритет должен быть с кодом, а не с его пересказом, поэтому он тоже здесь. |
| 27 | //! |
| 28 | //! Отдельно — один общий каталог per-game кэшей DXVK/VKD3D, сразу для ВСЕХ |
| 29 | //! игр: `{root}/data/tmp/vulkan_shader_cache` (`sw_vulkan_shader_cache`, |
| 30 | //! `sw_data.py:212`, `sw_tmp = sw_data_dir.joinpath("tmp")` — `:172`). |
| 31 | //! У самого Chimera-Launcher путь кэша одной игры устроен ровно так же — |
| 32 | //! `{root}/data/tmp/vulkan_shader_cache/{game}` (`chl_runtime::env::build`, |
| 33 | //! `env.rs:228`) — здесь берётся каталог на уровень выше, чтобы одной |
| 34 | //! операцией очистить сразу все игры: `on_clear_shader_cache` тоже не |
| 35 | //! разбирает, что чьё, а просто обходит общий каталог. |
| 36 | |
| 37 | use std::path::{Path, PathBuf}; |
| 38 | |
| 39 | use anyhow::{Context, Result}; |
| 40 | |
| 41 | /// Один каталог кэша, подлежащий очистке. |
| 42 | #[derive(Debug, Clone)] |
| 43 | pub struct CacheDir { |
| 44 | /// Короткое имя для отчёта пользователю. |
| 45 | pub label: &'static str, |
| 46 | pub path: PathBuf, |
| 47 | } |
| 48 | |
| 49 | /// Тот же каталог, но с посчитанным размером — для показа перед удалением. |
| 50 | #[derive(Debug, Clone)] |
| 51 | pub struct Surveyed { |
| 52 | pub label: &'static str, |
| 53 | pub path: PathBuf, |
| 54 | /// Каталога может не быть вовсе: кэш появляется только после первого |
| 55 | /// использования (пример: `GLCache` без видеокарты NVIDIA в системе). |
| 56 | pub exists: bool, |
| 57 | /// Место, занятое содержимым, в байтах — по выделенным блокам, как `du`. |
| 58 | pub bytes: u64, |
| 59 | } |
| 60 | |
| 61 | /// Итог очистки одного каталога. |
| 62 | #[derive(Debug)] |
| 63 | pub struct ClearOutcome { |
| 64 | pub label: &'static str, |
| 65 | pub path: PathBuf, |
| 66 | pub result: Result<()>, |
| 67 | } |
| 68 | |
| 69 | /// Драйверные кэши уровня диска — общие для всех игр, от Wine не зависят. |
| 70 | /// |
| 71 | /// Источник списка и путей: см. doc-комментарий модуля. |
| 72 | pub fn driver_caches(home: &Path) -> Vec<CacheDir> { |
| 73 | vec![ |
| 74 | CacheDir { label: "mesa_shader_cache", path: home.join(".cache/mesa_shader_cache") }, |
| 75 | CacheDir { label: "mesa_shader_cache_sf", path: home.join(".cache/mesa_shader_cache_sf") }, |
| 76 | CacheDir { label: "mesa_shader_cache_db", path: home.join(".cache/mesa_shader_cache_db") }, |
| 77 | CacheDir { label: "radv_builtin_shaders", path: home.join(".cache/radv_builtin_shaders") }, |
| 78 | CacheDir { label: "gl_shader_cache", path: home.join(".cache/gl_shader_cache") }, |
| 79 | CacheDir { label: "GLCache (NVIDIA)", path: home.join(".nv/GLCache") }, |
| 80 | CacheDir { label: "nvidia", path: home.join(".cache/nvidia") }, |
| 81 | CacheDir { label: "gstreamer-1.0", path: home.join(".cache/gstreamer-1.0") }, |
| 82 | ] |
| 83 | } |
| 84 | |
| 85 | /// Общий каталог per-game кэшей DXVK/VKD3D — сразу все игры, без деления. |
| 86 | /// |
| 87 | /// Путь на уровень выше того, что кладёт в окружение одной игры |
| 88 | /// `chl_runtime::env::build` (`{root}/data/tmp/vulkan_shader_cache/{game}`, |
| 89 | /// `env.rs:228`) — ровно так задумано, см. doc-комментарий модуля. |
| 90 | pub fn vulkan_shader_cache(install_root: &Path) -> CacheDir { |
| 91 | CacheDir { |
| 92 | label: "vulkan_shader_cache (все игры)", |
| 93 | path: install_root.join("data/tmp/vulkan_shader_cache"), |
| 94 | } |
| 95 | } |
| 96 | |
| 97 | /// Полный список того, что чистит эта фича: драйверные кэши плюс общий |
| 98 | /// каталог per-game кэшей DXVK/VKD3D. |
| 99 | pub fn all(home: &Path, install_root: &Path) -> Vec<CacheDir> { |
| 100 | let mut dirs = driver_caches(home); |
| 101 | dirs.push(vulkan_shader_cache(install_root)); |
| 102 | dirs |
| 103 | } |
| 104 | |
| 105 | /// Считает размер каждого каталога, ничего не удаляя — чтобы показать, |
| 106 | /// что будет удалено, до того как это произойдёт. |
| 107 | pub fn survey(dirs: &[CacheDir]) -> Vec<Surveyed> { |
| 108 | dirs.iter() |
| 109 | .map(|d| { |
| 110 | let exists = d.path.is_dir(); |
| 111 | let bytes = if exists { dir_blocks(&d.path) } else { 0 }; |
| 112 | Surveyed { label: d.label, path: d.path.clone(), exists, bytes } |
| 113 | }) |
| 114 | .collect() |
| 115 | } |
| 116 | |
| 117 | /// Чистит содержимое каждого каталога, оставляя сам каталог на месте. |
| 118 | /// |
| 119 | /// Не останавливается на первой ошибке: каталоги независимы (один может |
| 120 | /// быть занят игрой, другой — без прав на запись), и одна неудача не должна |
| 121 | /// мешать очистить остальное. Список результатов — по одному на каталог, в |
| 122 | /// том же порядке, что и `dirs`. |
| 123 | pub fn clear(dirs: &[CacheDir]) -> Vec<ClearOutcome> { |
| 124 | dirs.iter() |
| 125 | .map(|d| ClearOutcome { |
| 126 | label: d.label, |
| 127 | path: d.path.clone(), |
| 128 | result: clear_contents(&d.path), |
| 129 | }) |
| 130 | .collect() |
| 131 | } |
| 132 | |
| 133 | /// Удаляет содержимое каталога, не трогая сам каталог. |
| 134 | /// |
| 135 | /// Несуществующий каталог — не ошибка: кэш мог не появиться ни разу. Так же |
| 136 | /// ведёт себя и StartWine — `if cache.exists():` перед каждым каталогом. |
| 137 | fn clear_contents(path: &Path) -> Result<()> { |
| 138 | if !path.is_dir() { |
| 139 | return Ok(()); |
| 140 | } |
| 141 | let entries = |
| 142 | std::fs::read_dir(path).with_context(|| format!("не читается {}", path.display()))?; |
| 143 | for entry in entries { |
| 144 | let entry = |
| 145 | entry.with_context(|| format!("не читается запись в {}", path.display()))?; |
| 146 | let p = entry.path(); |
| 147 | let file_type = entry |
| 148 | .file_type() |
| 149 | .with_context(|| format!("не определяется тип {}", p.display()))?; |
| 150 | if file_type.is_dir() { |
| 151 | std::fs::remove_dir_all(&p) |
| 152 | .with_context(|| format!("не удаляется {}", p.display()))?; |
| 153 | } else { |
| 154 | std::fs::remove_file(&p).with_context(|| format!("не удаляется {}", p.display()))?; |
| 155 | } |
| 156 | } |
| 157 | Ok(()) |
| 158 | } |
| 159 | |
| 160 | /// Место на диске, занятое каталогом, по выделенным блокам — тот же приём, |
| 161 | /// что и `crate::snapshot::dir_blocks`: явный стек вместо рекурсии, чтобы не |
| 162 | /// зависеть от глубины дерева. |
| 163 | fn dir_blocks(path: &Path) -> u64 { |
| 164 | use std::os::unix::fs::MetadataExt; |
| 165 | let mut total = 0; |
| 166 | let mut stack = vec![path.to_path_buf()]; |
| 167 | while let Some(dir) = stack.pop() { |
| 168 | let Ok(entries) = std::fs::read_dir(&dir) else { continue }; |
| 169 | for e in entries.flatten() { |
| 170 | let Ok(meta) = e.metadata() else { continue }; |
| 171 | if meta.is_dir() { |
| 172 | stack.push(e.path()); |
| 173 | } |
| 174 | total += meta.blocks() * 512; |
| 175 | } |
| 176 | } |
| 177 | total |
| 178 | } |
| 179 | |
| 180 | #[cfg(test)] |
| 181 | mod tests { |
| 182 | use super::*; |
| 183 | |
| 184 | fn scratch(name: &str) -> PathBuf { |
| 185 | let d = std::env::temp_dir().join(format!("chl-test-shader-cache-{name}")); |
| 186 | std::fs::remove_dir_all(&d).ok(); |
| 187 | std::fs::create_dir_all(&d).unwrap(); |
| 188 | d |
| 189 | } |
| 190 | |
| 191 | #[test] |
| 192 | fn список_совпадает_с_startwine_по_числу_каталогов() { |
| 193 | // 8 драйверных (sw_data.py:204-211) + свой общий vulkan_shader_cache. |
| 194 | let home = scratch("список"); |
| 195 | let root = home.join("root"); |
| 196 | assert_eq!(all(&home, &root).len(), 9); |
| 197 | } |
| 198 | |
| 199 | #[test] |
| 200 | fn несуществующий_каталог_не_ошибка() { |
| 201 | let home = scratch("нет-каталога"); |
| 202 | let root = home.join("root"); |
| 203 | let dirs = all(&home, &root); |
| 204 | |
| 205 | let surveyed = survey(&dirs); |
| 206 | assert!(surveyed.iter().all(|s| !s.exists && s.bytes == 0)); |
| 207 | |
| 208 | // Очистка каталогов, которых нет, тоже не должна падать. |
| 209 | let outcomes = clear(&dirs); |
| 210 | assert!(outcomes.iter().all(|o| o.result.is_ok())); |
| 211 | } |
| 212 | |
| 213 | #[test] |
| 214 | fn размер_считается_и_очистка_убирает_содержимое_но_не_каталог() { |
| 215 | let home = scratch("размер-и-очистка"); |
| 216 | let mesa = home.join(".cache/mesa_shader_cache"); |
| 217 | std::fs::create_dir_all(mesa.join("подкаталог")).unwrap(); |
| 218 | std::fs::write(mesa.join("файл.bin"), vec![0u8; 4096]).unwrap(); |
| 219 | std::fs::write(mesa.join("подкаталог/вложенный.bin"), vec![0u8; 4096]).unwrap(); |
| 220 | |
| 221 | let root = home.join("root"); |
| 222 | let dirs = driver_caches(&home); |
| 223 | let surveyed = survey(&dirs); |
| 224 | let mesa_entry = surveyed.iter().find(|s| s.label == "mesa_shader_cache").unwrap(); |
| 225 | assert!(mesa_entry.exists); |
| 226 | assert!(mesa_entry.bytes > 0, "непустой кэш должен показать ненулевой размер"); |
| 227 | |
| 228 | let outcomes = clear(&dirs); |
| 229 | assert!(outcomes.iter().all(|o| o.result.is_ok()), "{outcomes:?}"); |
| 230 | |
| 231 | // Каталог остался — StartWine чистит содержимое, а не сам каталог. |
| 232 | assert!(mesa.is_dir(), "каталог кэша должен остаться на месте"); |
| 233 | assert_eq!(std::fs::read_dir(&mesa).unwrap().count(), 0, "содержимое должно исчезнуть"); |
| 234 | |
| 235 | let _ = root; |
| 236 | } |
| 237 | |
| 238 | #[test] |
| 239 | fn общий_кэш_всех_игр_не_делится_по_играм() { |
| 240 | let home = scratch("общий-кэш-игр"); |
| 241 | let root = home.join("root"); |
| 242 | let shared = vulkan_shader_cache(&root); |
| 243 | assert!(shared.path.ends_with("data/tmp/vulkan_shader_cache")); |
| 244 | |
| 245 | std::fs::create_dir_all(shared.path.join("ИграА")).unwrap(); |
| 246 | std::fs::write(shared.path.join("ИграА/state.bin"), vec![0u8; 1024]).unwrap(); |
| 247 | std::fs::create_dir_all(shared.path.join("ИграБ")).unwrap(); |
| 248 | std::fs::write(shared.path.join("ИграБ/state.bin"), vec![0u8; 1024]).unwrap(); |
| 249 | |
| 250 | let outcome = clear(std::slice::from_ref(&shared)); |
| 251 | assert!(outcome[0].result.is_ok()); |
| 252 | assert!(shared.path.is_dir()); |
| 253 | assert_eq!( |
| 254 | std::fs::read_dir(&shared.path).unwrap().count(), |
| 255 | 0, |
| 256 | "очистка общего каталога не должна щадить ни одну из игр" |
| 257 | ); |
| 258 | } |
| 259 | } |
| 260 |