Skip to content

Commit

Permalink
Use TerminateProcess to exit early (#16575)
Browse files Browse the repository at this point in the history
Closes MSFT:46744208

BODGY: If the emperor is being dtor'd, it's because we've gone past the
end of main, and released the ref in main. Then we might run into an
edge case where main releases it's ref to the emperor, but one of the
window threads might be in the process of exiting, and still holding a
strong ref to the emperor. In that case, we can actually end up with
the _window thread_ being the last reference, and calling App::Close
on that thread will crash us with a E_WRONG_THREAD.

This fixes the issue by calling `TerminateProcess` explicitly.

How validated: The ES team manually ran the test pass this was
crashing in a hundred times to make sure this actually fixed it.

Co-authored-by: Leonard Hecker <lhecker@microsoft.com>
(cherry picked from commit 0d47c86)
Service-Card-Id: 91642488
Service-Version: 1.18
  • Loading branch information
2 people authored and DHowett committed Jan 29, 2024
1 parent 1eabe7c commit dd595d7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 41 deletions.
46 changes: 11 additions & 35 deletions src/cascadia/WindowsTerminal/WindowEmperor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -34,26 +34,6 @@ WindowEmperor::WindowEmperor() noexcept :
});

_dispatcher = winrt::Windows::System::DispatcherQueue::GetForCurrentThread();

// BODGY
//
// There's a mysterious crash in XAML on Windows 10 if you just let the App
// get dtor'd. By all accounts, it doesn't make sense. To mitigate this, we
// need to intentionally leak a reference to our App. Crazily, if you just
// let the app get cleaned up with the rest of the process when the process
// exits, then it doesn't crash. But if you let it get explicitly dtor'd, it
// absolutely will crash on exit.
//
// GH#15410 has more details.

auto a{ _app };
::winrt::detach_abi(a);
}

WindowEmperor::~WindowEmperor()
{
_app.Close();
_app = nullptr;
}

void _buildArgsFromCommandline(std::vector<winrt::hstring>& args)
Expand All @@ -78,7 +58,7 @@ void _buildArgsFromCommandline(std::vector<winrt::hstring>& args)
}
}

bool WindowEmperor::HandleCommandlineArgs(int nCmdShow)
void WindowEmperor::HandleCommandlineArgs(int nCmdShow)
{
std::vector<winrt::hstring> args;
_buildArgsFromCommandline(args);
Expand All @@ -97,25 +77,30 @@ bool WindowEmperor::HandleCommandlineArgs(int nCmdShow)
const Remoting::CommandlineArgs eventArgs{ args, cwd, gsl::narrow_cast<uint32_t>(nCmdShow), GetEnvironmentStringsW() };
const auto isolatedMode{ _app.Logic().IsolatedMode() };
const auto result = _manager.ProposeCommandline(eventArgs, isolatedMode);
int exitCode = 0;

const bool makeWindow = result.ShouldCreateWindow();
if (makeWindow)
if (result.ShouldCreateWindow())
{
_createNewWindowThread(Remoting::WindowRequestedArgs{ result, eventArgs });

_becomeMonarch();
WaitForWindows();
}
else
{
const auto res = _app.Logic().GetParseCommandlineMessage(eventArgs.Commandline());
if (!res.Message.empty())
{
AppHost::s_DisplayMessageBox(res);
std::quick_exit(res.ExitCode);
}
exitCode = res.ExitCode;
}

return makeWindow;
// There's a mysterious crash in XAML on Windows 10 if you just let _app get destroyed (GH#15410).
// We also need to ensure that all UI threads exit before WindowEmperor leaves the scope on the main thread (MSFT:46744208).
// Both problems can be solved and the shutdown accelerated by using TerminateProcess.
// std::exit(), etc., cannot be used here, because those use ExitProcess for unpackaged applications.
TerminateProcess(GetCurrentProcess(), gsl::narrow_cast<UINT>(exitCode));
__assume(false);
}

void WindowEmperor::WaitForWindows()
Expand Down Expand Up @@ -568,15 +553,6 @@ LRESULT WindowEmperor::_messageHandler(UINT const message, WPARAM const wParam,
// we'll undoubtedly crash.
winrt::fire_and_forget WindowEmperor::_close()
{
{
auto fridge{ _oldThreads.lock() };
for (auto& window : *fridge)
{
window->ThrowAway();
}
fridge->clear();
}

// Important! Switch back to the main thread for the emperor. That way, the
// quit will go to the emperor's message pump.
co_await wil::resume_foreground(_dispatcher);
Expand Down
3 changes: 1 addition & 2 deletions src/cascadia/WindowsTerminal/WindowEmperor.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ class WindowEmperor : public std::enable_shared_from_this<WindowEmperor>
{
public:
WindowEmperor() noexcept;
~WindowEmperor();
void WaitForWindows();

bool HandleCommandlineArgs(int nCmdShow);
void HandleCommandlineArgs(int nCmdShow);

private:
void _createNewWindowThread(const winrt::Microsoft::Terminal::Remoting::WindowRequestedArgs& args);
Expand Down
5 changes: 1 addition & 4 deletions src/cascadia/WindowsTerminal/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,5 @@ int __stdcall wWinMain(HINSTANCE, HINSTANCE, LPWSTR, int nCmdShow)
winrt::init_apartment(winrt::apartment_type::single_threaded);

const auto emperor = std::make_shared<::WindowEmperor>();
if (emperor->HandleCommandlineArgs(nCmdShow))
{
emperor->WaitForWindows();
}
emperor->HandleCommandlineArgs(nCmdShow);
}

1 comment on commit dd595d7

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log for details.

Unrecognized words (3)

atvis
LASTEXITCODE
wcsnlen

Previously acknowledged words that are now absent ACCESSTOKEN BUILDURI COLLECTIONURI countof dhandler dmp etcoreapp fileurl HKLM homeglyphs IXMP lastexitcode listproperties logissue minimizeall preinstalled procs SOURCEBRANCH suiteless TEAMPROJECT testbuildplatform testdlls testmode testnameprefix testtimeout untests xxyyzz :arrow_right:
To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the git@github.com:microsoft/terminal.git repository
on the release-1.18 branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.21/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/7701652892/attempts/1'
Pattern suggestions ✂️ (1)

You could add these patterns to .github/actions/spelling/patterns/dd595d7aedb1b8cacaedbec9c859174a72f00c23.txt:

# Automatically suggested patterns
# hit-count: 1 file-count: 1
# Punycode
\bxn--[-0-9a-z]+

Warnings (1)

See the 📜action log for details.

ℹ️ Warnings Count
ℹ️ candidate-pattern 1

See ℹ️ Event descriptions for more information.

✏️ Contributor please read this

By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.

⚠️ The command is written for posix shells. If it doesn't work for you, you can manually add (one word per line) / remove items to expect.txt and the excludes.txt files.

If the listed items are:

  • ... misspelled, then please correct them instead of using the command.
  • ... names, please add them to .github/actions/spelling/allow/names.txt.
  • ... APIs, you can add them to a file in .github/actions/spelling/allow/.
  • ... just things you're using, please add them to an appropriate file in .github/actions/spelling/expect/.
  • ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in .github/actions/spelling/patterns/.

See the README.md in each directory for more information.

🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉

If the flagged items are 🤯 false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it,
    try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

Please sign in to comment.