mirror of
https://github.com/MaSzyna-EU07/StarterNG.git
synced 2026-11-16 21:14:10 +01:00
Merge pull request #51 from MaSzyna-EU07/fix/noavx2-exe
fix: without AVX2 the starter starts the simulator built without it
This commit is contained in:
82
StarterNG.Tests/ExecutableNoAvx2Tests.cs
Normal file
82
StarterNG.Tests/ExecutableNoAvx2Tests.cs
Normal file
@@ -0,0 +1,82 @@
|
||||
using StarterNG.Domain.Settings;
|
||||
using StarterNG.Infrastructure.Settings;
|
||||
using StarterNG.Tests.Fakes;
|
||||
|
||||
namespace StarterNG.Tests;
|
||||
|
||||
public class ExecutableNoAvx2Tests
|
||||
{
|
||||
private const string Elf = "\u007fELF binary";
|
||||
private static readonly DateTime Older = new(2026, 11, 1, 0, 0, 0, DateTimeKind.Utc);
|
||||
private static readonly DateTime Newer = new(2026, 11, 15, 0, 0, 0, DateTimeKind.Utc);
|
||||
|
||||
private static InMemoryFileSystem With(params string[] names)
|
||||
{
|
||||
var files = new InMemoryFileSystem();
|
||||
foreach (string name in names)
|
||||
files.WithExecutable(TestInstallation.At(name), Elf);
|
||||
return files;
|
||||
}
|
||||
|
||||
private static string Automatic(InMemoryFileSystem files, bool lacksAvx2) =>
|
||||
Path.GetFileName(new TestInstallation(files, lacksAvx2: lacksAvx2).Executables
|
||||
.Resolve(new SimulatorSettings(), out _));
|
||||
|
||||
[Theory]
|
||||
[InlineData("eu07_noavx2", true)]
|
||||
[InlineData("eu07-x64_2026-11-15_abc1234_noavx2.exe", true)]
|
||||
[InlineData("EU07_NOAVX2.EXE", true)]
|
||||
[InlineData("eu07", false)]
|
||||
[InlineData("eu07-x64_2026-11-15_abc1234.exe", false)]
|
||||
[InlineData("eu07_noavx2_old.exe", false)]
|
||||
public void A_build_without_avx2_is_known_by_the_end_of_its_name(string name, bool noAvx2) =>
|
||||
Assert.Equal(noAvx2, ExecutableLocator.IsNoAvx2(name));
|
||||
|
||||
[Fact]
|
||||
public void Without_avx2_the_build_without_it_is_chosen_over_the_canonical_one() =>
|
||||
Assert.Equal("eu07_noavx2", Automatic(With("eu07", "eu07_noavx2"), lacksAvx2: true));
|
||||
|
||||
[Fact]
|
||||
public void With_avx2_the_build_made_for_it_stays_first() =>
|
||||
Assert.Equal("eu07", Automatic(With("eu07", "eu07_noavx2"), lacksAvx2: false));
|
||||
|
||||
[Fact]
|
||||
public void With_avx2_a_build_without_it_is_used_when_it_is_the_only_one() =>
|
||||
Assert.Equal("eu07_noavx2", Automatic(With("eu07_noavx2"), lacksAvx2: false));
|
||||
|
||||
[Fact]
|
||||
public void Without_avx2_the_newest_build_without_it_is_chosen()
|
||||
{
|
||||
var files = With("eu07_2026-11-01_aaa_noavx2", "eu07_2026-11-15_bbb_noavx2")
|
||||
.WrittenAt(TestInstallation.At("eu07_2026-11-01_aaa_noavx2"), Older)
|
||||
.WrittenAt(TestInstallation.At("eu07_2026-11-15_bbb_noavx2"), Newer);
|
||||
|
||||
Assert.Equal("eu07_2026-11-15_bbb_noavx2", Automatic(files, lacksAvx2: true));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Without_avx2_and_no_build_without_it_the_usual_choice_stands() =>
|
||||
Assert.Equal("eu07", Automatic(With("eu07-dev", "eu07"), lacksAvx2: true));
|
||||
|
||||
[Fact]
|
||||
public void Only_a_build_with_avx2_on_a_processor_without_it_will_not_run()
|
||||
{
|
||||
var lacking = new TestInstallation(lacksAvx2: true).Executables;
|
||||
var able = new TestInstallation(lacksAvx2: false).Executables;
|
||||
|
||||
Assert.True(lacking.WillNotRunHere("eu07.exe"));
|
||||
Assert.False(lacking.WillNotRunHere("eu07-x64_noavx2.exe"));
|
||||
Assert.False(able.WillNotRunHere("eu07.exe"));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void The_newest_build_without_avx2_is_offered_by_name()
|
||||
{
|
||||
var files = With("eu07", "eu07_2026-11-01_aaa_noavx2", "eu07_2026-11-15_bbb_noavx2")
|
||||
.WrittenAt(TestInstallation.At("eu07_2026-11-01_aaa_noavx2"), Older)
|
||||
.WrittenAt(TestInstallation.At("eu07_2026-11-15_bbb_noavx2"), Newer);
|
||||
|
||||
Assert.Equal("eu07_2026-11-15_bbb_noavx2", new TestInstallation(files).Executables.NewestNoAvx2());
|
||||
Assert.Null(new TestInstallation(With("eu07")).Executables.NewestNoAvx2());
|
||||
}
|
||||
}
|
||||
@@ -14,7 +14,7 @@ public sealed class TestInstallation
|
||||
{
|
||||
public const string Root = "game";
|
||||
|
||||
public TestInstallation(InMemoryFileSystem? files = null, DateTime? now = null)
|
||||
public TestInstallation(InMemoryFileSystem? files = null, DateTime? now = null, bool lacksAvx2 = false)
|
||||
{
|
||||
Files = files ?? new InMemoryFileSystem();
|
||||
Paths = new GamePaths(Root);
|
||||
@@ -35,7 +35,8 @@ public sealed class TestInstallation
|
||||
SettingsPaths.VehicleCacheDirectory());
|
||||
Library = new GameLibrary(VehicleCache, Sceneries, MiniTextures, Physics, Log);
|
||||
|
||||
Executables = new ExecutableLocator(Files, Paths, Environment, Log);
|
||||
// The processor of the machine running the tests is not the one tested.
|
||||
Executables = new ExecutableLocator(Files, Paths, Environment, Log, lacksAvx2);
|
||||
SettingsStore = new SettingsStore(Files, Clock, Log, SettingsPaths, new SettingsSerializer(), Executables);
|
||||
Tapes = new HaslerTapes(Files, Paths, Log, Clock, new TimetableLocator(Files), () => SimulatorRunning);
|
||||
}
|
||||
|
||||
@@ -207,8 +207,12 @@ public partial class App : Avalonia.Application
|
||||
if (check.ExecutableMissing())
|
||||
await main.OfferExecutablePickAsync();
|
||||
|
||||
if (CpuFeatures.LacksAvx2 && AppServices.Current.Settings.CpuNotice)
|
||||
await main.ShowCpuNoticeAsync();
|
||||
// A build without AVX2 in the folder is started instead, and needs no notice.
|
||||
var services = AppServices.Current;
|
||||
if (services.Settings.CpuNotice
|
||||
&& services.Executables.Resolve(services.Settings, out _) is var executable
|
||||
&& services.Executables.WillNotRunHere(executable))
|
||||
await main.ShowCpuNoticeAsync(executable);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
@@ -22,15 +22,37 @@ public sealed class ExecutableLocator
|
||||
private string? _wine;
|
||||
private bool _wineLookedUp;
|
||||
private string? _missingPickLogged;
|
||||
private readonly bool _lacksAvx2;
|
||||
|
||||
public ExecutableLocator(IFileSystem files, IGamePaths paths, IEnvironment environment, IDiagnosticsLog log)
|
||||
/// <param name="lacksAvx2">Whether this processor runs no AVX2; asked of it when left out.</param>
|
||||
public ExecutableLocator(IFileSystem files, IGamePaths paths, IEnvironment environment, IDiagnosticsLog log,
|
||||
bool? lacksAvx2 = null)
|
||||
{
|
||||
_files = files;
|
||||
_paths = paths;
|
||||
_environment = environment;
|
||||
_log = log;
|
||||
_lacksAvx2 = lacksAvx2 ?? CpuFeatures.LacksAvx2;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The end of the name of a simulator built without AVX2, last before any extension:
|
||||
/// eu07-x64_2026-11-15_abc1234_noavx2.exe, eu07_noavx2. It runs on any x86-64 processor.
|
||||
/// </summary>
|
||||
public const string NoAvx2Suffix = "_noavx2";
|
||||
|
||||
public static bool IsNoAvx2(string path) =>
|
||||
Path.GetFileNameWithoutExtension(path).EndsWith(NoAvx2Suffix, StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
/// <summary>
|
||||
/// Whether <paramref name="executable"/> stops at its first instruction here: a build
|
||||
/// with AVX2 on a processor without it. Such a processor is told so before a start.
|
||||
/// </summary>
|
||||
public bool WillNotRunHere(string executable) => _lacksAvx2 && !IsNoAvx2(executable);
|
||||
|
||||
/// <summary>The newest build without AVX2 in the installation, or null where there is none.</summary>
|
||||
public string? NewestNoAvx2() => ListCandidates().FirstOrDefault(IsNoAvx2);
|
||||
|
||||
public string CanonicalName => _environment.IsWindows ? "eu07.exe" : "eu07";
|
||||
|
||||
/// <summary>
|
||||
@@ -71,7 +93,8 @@ public sealed class ExecutableLocator
|
||||
{
|
||||
var candidates = _files.GetFiles(_paths.Root, "eu07*")
|
||||
.Where(IsCandidate)
|
||||
.OrderBy(path => IsExeOnLinux(path) ? 1 : 0)
|
||||
.OrderBy(Rank)
|
||||
.ThenByDescending(path => _lacksAvx2 && IsNoAvx2(path) ? _files.GetLastWriteTimeUtc(path) : DateTime.MinValue)
|
||||
.ThenBy(path => string.Equals(Path.GetFileName(path), CanonicalName,
|
||||
StringComparison.OrdinalIgnoreCase) ? 0 : 1)
|
||||
.ThenBy(path => Path.GetFileName(path).Length);
|
||||
@@ -101,6 +124,18 @@ public sealed class ExecutableLocator
|
||||
return CanonicalName;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The order of the search. Without AVX2 a build without it comes first, the newest of
|
||||
/// them, even through Wine: the others stop at once. With AVX2 one is the last resort,
|
||||
/// as the build made for the processor runs faster; native before Wine either way.
|
||||
/// </summary>
|
||||
private int Rank(string path)
|
||||
{
|
||||
int wine = IsExeOnLinux(path) ? 1 : 0;
|
||||
int noAvx2 = IsNoAvx2(path) ? 1 : 0;
|
||||
return _lacksAvx2 ? (1 - noAvx2) * 2 + wine : wine * 2 + noAvx2;
|
||||
}
|
||||
|
||||
public List<string> ListCandidates(string? directory = null)
|
||||
{
|
||||
try
|
||||
|
||||
@@ -521,11 +521,34 @@ public partial class MainWindow : Window
|
||||
private const string SimulatorBuildGuide = "https://github.com/MaSzyna-EU07/maszyna#getting-started";
|
||||
|
||||
/// <summary>
|
||||
/// Tells a user whose processor lacks AVX2 that the published simulator will
|
||||
/// not run, and where the instructions for a build of their own are.
|
||||
/// Tells a user whose processor lacks AVX2 that the simulator that would start will
|
||||
/// not run. With a build without AVX2 in the folder, chosen away from by hand, the
|
||||
/// notice offers to go back to the automatic choice, which takes it; with none, it
|
||||
/// says what such a build is called and where the instructions for one's own are.
|
||||
/// </summary>
|
||||
public async Task ShowCpuNoticeAsync()
|
||||
public async Task ShowCpuNoticeAsync(string executable)
|
||||
{
|
||||
var services = AppServices.Current;
|
||||
if (services.Executables.NewestNoAvx2() is { } noAvx2)
|
||||
{
|
||||
var (useIt, quiet) = await MessageBox.ShowNotice(
|
||||
this, string.Format(App.Loc["CpuNoAvx2Chosen"], Path.GetFileName(executable), noAvx2),
|
||||
App.Loc["CpuNoAvx2Title"], App.Loc["CpuNoAvx2UseIt"], App.Loc["DontShowAgain"]);
|
||||
if (useIt)
|
||||
{
|
||||
services.Settings.SelectExeAutomatically = true;
|
||||
services.SettingsStore.Save();
|
||||
SettingsView.ReloadFromSettings();
|
||||
UpdateStartButton();
|
||||
}
|
||||
if (quiet)
|
||||
{
|
||||
services.Settings.CpuNotice = false;
|
||||
services.SettingsStore.Save();
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
var (open, silence) = await MessageBox.ShowNotice(
|
||||
this, string.Format(App.Loc["CpuNoAvx2"], SimulatorBuildGuide), App.Loc["CpuNoAvx2Title"],
|
||||
App.Loc["CpuNoAvx2Open"], App.Loc["DontShowAgain"]);
|
||||
|
||||
@@ -633,8 +633,10 @@
|
||||
<String key="About">O programu</String>
|
||||
<String key="Close">Zavřít</String>
|
||||
<String key="CpuNoAvx2Title">Procesor bez AVX2</String>
|
||||
<String key="CpuNoAvx2">Tento procesor nemá AVX2 a oficiální simulátor ho vyžaduje: nespustí se. Simulátor lze sestavit bez AVX2 (CMake -DENABLE_AVX2=OFF). Návod: {0}</String>
|
||||
<String key="CpuNoAvx2">Tento procesor nemá AVX2 a oficiální simulátor ho vyžaduje: nespustí se. Existuje verze simulátoru bez AVX2 - název jejího souboru končí na _noavx2. Vložte ji do složky hry a starter ji sám použije. Simulátor lze také sestavit sám (CMake -DENABLE_AVX2=OFF). Návod: {0}</String>
|
||||
<String key="CpuNoAvx2Open">Otevřít návod</String>
|
||||
<String key="CpuNoAvx2Chosen">Tento procesor nemá AVX2 a zvolený simulátor {0} ho vyžaduje: nespustí se. Ve složce hry je verze bez AVX2: {1}. Automatická volba vezme právě ji.</String>
|
||||
<String key="CpuNoAvx2UseIt">Volit automaticky</String>
|
||||
<String key="DontShowAgain">Znovu nezobrazovat</String>
|
||||
<String key="SettingsPath">Nastavení načteno z:</String>
|
||||
|
||||
|
||||
@@ -659,8 +659,10 @@
|
||||
<String key="About">About</String>
|
||||
<String key="Close">Close</String>
|
||||
<String key="CpuNoAvx2Title">Processor without AVX2</String>
|
||||
<String key="CpuNoAvx2">This processor has no AVX2 and the official simulator needs it: it will not start. You can build the simulator without AVX2 (CMake -DENABLE_AVX2=OFF). Instructions: {0}</String>
|
||||
<String key="CpuNoAvx2">This processor has no AVX2 and the official simulator needs it: it will not start. There is a simulator build without AVX2 - its file name ends in _noavx2. Put it in the game folder and the starter will use it. You can also build the simulator yourself (CMake -DENABLE_AVX2=OFF). Instructions: {0}</String>
|
||||
<String key="CpuNoAvx2Open">Open the instructions</String>
|
||||
<String key="CpuNoAvx2Chosen">This processor has no AVX2 and the chosen simulator {0} needs it: it will not start. The game folder has a build without AVX2: {1}. The automatic choice takes that one.</String>
|
||||
<String key="CpuNoAvx2UseIt">Choose automatically</String>
|
||||
<String key="DontShowAgain">Don't show again</String>
|
||||
<String key="SettingsPath">Settings loaded from:</String>
|
||||
|
||||
|
||||
@@ -633,8 +633,10 @@
|
||||
<String key="About">Névjegy</String>
|
||||
<String key="Close">Bezárás</String>
|
||||
<String key="CpuNoAvx2Title">AVX2 nélküli processzor</String>
|
||||
<String key="CpuNoAvx2">Ez a processzor nem tudja az AVX2-t, a hivatalos szimulátornak pedig kell: nem indul el. A szimulátor lefordítható AVX2 nélkül (CMake -DENABLE_AVX2=OFF). Útmutató: {0}</String>
|
||||
<String key="CpuNoAvx2">Ez a processzor nem tudja az AVX2-t, a hivatalos szimulátornak pedig kell: nem indul el. Van AVX2 nélküli szimulátor-változat - a fájl neve _noavx2-re végződik. Tegye a játék mappájába, és az indító magától azt használja. A szimulátor saját maga is lefordítható (CMake -DENABLE_AVX2=OFF). Útmutató: {0}</String>
|
||||
<String key="CpuNoAvx2Open">Útmutató megnyitása</String>
|
||||
<String key="CpuNoAvx2Chosen">Ez a processzor nem tudja az AVX2-t, a kiválasztott {0} szimulátornak pedig kell: nem indul el. A játék mappájában van AVX2 nélküli változat: {1}. Az automatikus választás ezt veszi.</String>
|
||||
<String key="CpuNoAvx2UseIt">Automatikus választás</String>
|
||||
<String key="DontShowAgain">Ne mutasd többé</String>
|
||||
<String key="SettingsPath">Beállítások betöltve innen:</String>
|
||||
|
||||
|
||||
@@ -659,8 +659,10 @@
|
||||
<String key="About">O programie</String>
|
||||
<String key="Close">Zamknij</String>
|
||||
<String key="CpuNoAvx2Title">Procesor bez AVX2</String>
|
||||
<String key="CpuNoAvx2">Ten procesor nie ma AVX2, a oficjalny symulator go wymaga: nie uruchomi się. Można zbudować symulator bez AVX2 (CMake -DENABLE_AVX2=OFF). Instrukcja: {0}</String>
|
||||
<String key="CpuNoAvx2">Ten procesor nie ma AVX2, a oficjalny symulator go wymaga: nie uruchomi się. Istnieje wersja symulatora bez AVX2 - nazwa jej pliku kończy się na _noavx2. Umieść ją w folderze gry, a starter sam jej użyje. Można też zbudować symulator samemu (CMake -DENABLE_AVX2=OFF). Instrukcja: {0}</String>
|
||||
<String key="CpuNoAvx2Open">Otwórz instrukcję</String>
|
||||
<String key="CpuNoAvx2Chosen">Ten procesor nie ma AVX2, a wybrany symulator {0} go wymaga: nie uruchomi się. W folderze gry jest wersja bez AVX2: {1}. Wybór automatyczny weźmie właśnie ją.</String>
|
||||
<String key="CpuNoAvx2UseIt">Wybieraj automatycznie</String>
|
||||
<String key="DontShowAgain">Nie pokazuj więcej</String>
|
||||
<String key="SettingsPath">Lokalizacja wczytanych ustawień:</String>
|
||||
|
||||
|
||||
@@ -633,8 +633,10 @@
|
||||
<String key="About">О программе</String>
|
||||
<String key="Close">Закрыть</String>
|
||||
<String key="CpuNoAvx2Title">Процессор без AVX2</String>
|
||||
<String key="CpuNoAvx2">Этот процессор не поддерживает AVX2, а официальному симулятору он нужен: симулятор не запустится. Можно собрать симулятор без AVX2 (CMake -DENABLE_AVX2=OFF). Инструкция: {0}</String>
|
||||
<String key="CpuNoAvx2">Этот процессор не поддерживает AVX2, а официальному симулятору он нужен: симулятор не запустится. Есть версия симулятора без AVX2 - имя её файла оканчивается на _noavx2. Положите её в папку игры, и стартер сам её использует. Симулятор можно также собрать самому (CMake -DENABLE_AVX2=OFF). Инструкция: {0}</String>
|
||||
<String key="CpuNoAvx2Open">Открыть инструкцию</String>
|
||||
<String key="CpuNoAvx2Chosen">Этот процессор не поддерживает AVX2, а выбранному симулятору {0} он нужен: он не запустится. В папке игры есть версия без AVX2: {1}. Автоматический выбор возьмёт именно её.</String>
|
||||
<String key="CpuNoAvx2UseIt">Выбирать автоматически</String>
|
||||
<String key="DontShowAgain">Больше не показывать</String>
|
||||
<String key="SettingsPath">Настройки загружены из:</String>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user