Skip to content

Commit

Permalink
Increase robustness of the splash in regard to early exits and crashes
Browse files Browse the repository at this point in the history
  • Loading branch information
@Wartori54
Wartori54 committed Jun 17, 2024
1 parent 3bf03dd commit 6ccdeaf
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 17 deletions.
10 changes: 7 additions & 3 deletions Celeste.Mod.mm/Mod/Everest/EverestSplashHandler.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,20 @@ public static void AllModsLoaded() {
SendMessageToSplash("#finish" + totalMods + ";" + "Almost done...");
}

private static Task lastFlush;
private static void SendMessageToSplash(string message) {
lock (splashPipeLock) {
if (splashPipeServerStream == null)
return; // If the splash never ran, no-op
if (!splashPipeServerStreamConnection.IsCompleted || !splashPipeServerStream.IsConnected)
return; // If the splash never connected or its no longer alive, no-op
if (lastFlush != null && !lastFlush.IsCompletedSuccessfully)
return; // If the last flush failed or did not complete in time, drop the messages
try {
StreamWriter sw = new(splashPipeServerStream);
sw.WriteLine(message);
sw.Flush();
lastFlush = sw.FlushAsync(); // Windows pipes have a tendency to deadlock writes if the other end doesn't read immediately
lastFlush.Wait(1000);
} catch (Exception e) {
Logger.Log(LogLevel.Error, "EverestSplash", "Could not send data to splash!");
Logger.LogDetailed(e);
Expand All @@ -137,7 +141,7 @@ public static void StopSplash() {
Environment.SetEnvironmentVariable("EVEREST_SKIP_REQUEST_FOCUS_AFTER_SPLASH", "1");
}
if (splashPipeServerStream == null) return; // If the splash never ran, no-op
if (!splashPipeServerStreamConnection.IsCompleted) {
if (!splashPipeServerStreamConnection.IsCompleted || !lastFlush.IsCompletedSuccessfully) {
Logger.Log(LogLevel.Error, "EverestSplash", "Could not connect to splash");
if (!splashProcess.HasExited) { // if it hangs up, just kill it
splashProcess.Kill();
Expand All @@ -152,7 +156,7 @@ public static void StopSplash() {
sw.Flush();
Thread splashFeedbackThread = new(() => {
try {
// `splashPipeServerStream` is intentionally disposed on outer stream, its the easiest way to kill this thread
// `splashPipeServerStream` is intentionally disposed on outer stream, it's the easiest way to kill this thread
StreamReader sr = new(splashPipeServerStream);
// yes, this, inevitably, slows down the everest boot process, but see EverestSplashWindow.FeedBack
// for more info
Expand Down
46 changes: 32 additions & 14 deletions EverestSplash/EverestSplash.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
using System.IO.Pipes;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Threading;
using System.Threading.Tasks;
using System.Timers;
using Timer = System.Timers.Timer;

namespace EverestSplash;

Expand Down Expand Up @@ -139,6 +140,8 @@ public class EverestSplashWindow {
private WindowInfo windowInfo;
private readonly string targetRenderer;
private readonly Assembly currentAssembly;
private readonly CancellationTokenSource tokenSource = new();
private bool earlyExit = false;

private FontLoader? renogareFont;
private LoadingProgress _loadingProgress = new(0, 0, "");
Expand Down Expand Up @@ -183,42 +186,47 @@ private EverestSplashWindow(string targetRendererName, string postFix) {
Console.WriteLine("Running splash on " + serverName);

ClientPipe = new NamedPipeClientStream(".", serverName);
ClientPipe.ConnectAsync().ContinueWith(_ => {
ClientPipe.ConnectAsync().ContinueWith(async _ => {
try {
StreamReader sr = new(ClientPipe);
while (sr.ReadLine() is { } message) {
while (await sr.ReadLineAsync(tokenSource.Token) is { } message) {
if (message == "#stop") { // Stop the splash
break;
}

const string progressPfx = "#progress";
if (message.StartsWith(progressPfx)) { // Mod loading progress message received: "#progress{loadedMods}{totalMods}{modName}"
if (message.StartsWith(progressPfx)) {
// Mod loading progress message received: "#progress{loadedMods}{totalMods}{modName}"
int countEnd = message.IndexOf(";", StringComparison.Ordinal);
int totalEnd = message.IndexOf(";", countEnd + 1, StringComparison.Ordinal);

int loadedMods = int.Parse(message[progressPfx.Length..countEnd]);
int totalMods = int.Parse(message[(countEnd+1)..totalEnd]);
loadingProgress = new LoadingProgress(loadedMods, totalMods, message[(totalEnd+1)..]);
int totalMods = int.Parse(message[(countEnd + 1)..totalEnd]);
loadingProgress = new LoadingProgress(loadedMods, totalMods, message[(totalEnd + 1)..]);
}

const string finishPfx = "#finish";
if (message.StartsWith(finishPfx)) { // Mod finish progress message received: "#finish{totalMods}{message}"
if (message.StartsWith(finishPfx)) {
// Mod finish progress message received: "#finish{totalMods}{message}"
int totalEnd = message.IndexOf(";", StringComparison.Ordinal);

int totalMods = int.Parse(message[finishPfx.Length..totalEnd]);
loadingProgress = new LoadingProgress(totalMods, totalMods, message[(totalEnd + 1)..], true);
}
}

} catch (OperationCanceledException) {
// Swallow it
} catch (Exception e) {
Console.Error.WriteLine(e);
// We want to exit if a read error occurred, we must not be around when FNA's main loop starts
}
Console.WriteLine("Exiting splash...");
SDL.SDL_Event userEvent = new() { // Fake a user event, we don't need anything fancier for now
type = SDL.SDL_EventType.SDL_USEREVENT,
};
SDL.SDL_PushEvent(ref userEvent); // This is thread safe :)
Console.WriteLine("Exiting splash...");
});
}, tokenSource.Token);

Init(); // Init right away
}
Expand All @@ -230,8 +238,11 @@ private EverestSplashWindow(string targetRendererName, string postFix) {
HandleWindow();

Cleanup();

FeedBack();

// Exiting early means the splash was not asked to do so by Everest,
// as such there's no need to communicate that.
if (!earlyExit)
FeedBack();
}

private void Init() {
Expand Down Expand Up @@ -359,6 +370,9 @@ private void HandleWindow() {
while (SDL.SDL_PollEvent(out SDL.SDL_Event e) != 0) {
// An SDL_USEREVENT is sent when the splash receives the quit command
if (e.type is SDL.SDL_EventType.SDL_QUIT or SDL.SDL_EventType.SDL_USEREVENT) {
// SDL_QUIT is currently the only way to exit early (other that crashing)
if (e.type is SDL.SDL_EventType.SDL_QUIT)
earlyExit = true;
return; // quit asap
}
}
Expand Down Expand Up @@ -463,27 +477,31 @@ private void Cleanup() {
timer.Dispose();
}
timers.Clear();
tokenSource.Cancel(); // Make sure the read thread is gone
}

/// <summary>
/// Kills the window, stopping everything and releasing all resources.
/// </summary>
public void Kill() {
tokenSource.Cancel();
ClientPipe.Dispose();
Cleanup();
}

/// <summary>
/// Notifies the server that we're done.
/// There would be no issue if we just closed the splash after the game window has been created (since its on diferent processes)
/// But if, for some reason, the splash does not recieve the stop command everest will assume it is about to close,
/// But if, for some reason, the splash does not receive the stop command everest will assume it is about to close,
/// leaving the splash alive (and confusing users), this way it is possible to know when the splash is gone, and when
/// to kill it if its not responding.
/// to kill it if it's not responding.
/// </summary>
private void FeedBack() {
StreamWriter sw = new(ClientPipe);
sw.WriteLine("done");
sw.Flush();
sw.Dispose();
ClientPipe.Dispose();
Console.WriteLine("Splash done!");
}

Expand Down

0 comments on commit 6ccdeaf

Please sign in to comment.