Console.GetCursorPosition behaves oddly with multiple threads on WSL

Open
#109,440 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, ubuntu

Research direction

Start with src/libraries/System.Console/src/System/ConsolePal.Unix.cs around the referenced GetCursorPosition logic, then run the supplied console program on Ubuntu 22.04 under WSL2 with .NET 8 or 9. Compare the interaction between Console.GetCursorPosition and Console.ReadLine across threads; done means the reported behavior is explained and corrected or reliably covered by a regression test.

Written by the indexing model from the issue text.

Description

area-System.Console help wanted
Description
Reproduction Steps
  • Create a new console project, targeting .NET 8 or .NET 9.
  • Run the following:
static void Main(string[] args)
{
    Task.Run(() =>
    {
        while (true)
        {
            Console.WriteLine($"CursorPosition = {Console.GetCursorPosition()}");
            Thread.Sleep(1000);
        }
    });

    for (int i = 0; i < 10; i++)
    {
        string? input = Console.ReadLine();

        if (i == 2)
        {
            Console.GetCursorPosition();
            Console.GetCursorPosition();
        }
    }
}
Expected behavior

"CursorPosition = ..." should be printed every second, or remain blocked until the calls to Console.ReadLine() complete.

Actual behavior

In each iteration of the loop, nothing is printed until a string is read from Console.ReadLine(). However, once Console.GetCursorPosition() is called twice in the same iteration of the loop, the "CursorPosition = ..." line is printed every second as expected.

For example, CursorPosition = ... is only outputted after a new line is inputted, but after the GetCursorPosition lines are executed, the output continues without anything having been entered:

the
CursorPosition = (0, 2)
quick
CursorPosition = (0, 4)
brown
CursorPosition = (0, 6)
CursorPosition = (0, 7)
CursorPosition = (0, 8)
CursorPosition = (0, 9)

Moving one of the GetCursorPosition calls before the Console.ReadLine produces the same result as when both calls are done after the Console.ReadLine:

for (int i = 0; i < 10; i++)
{
    Console.GetCursorPosition();
    string? input = Console.ReadLine();
    if (i == 2)
        Console.GetCursorPosition();
}

Note the i == 2 can be any number (and the loop max is irrelevant), this is only to show behavior is consistent before GetCursorPosition is called a second time.

Regression?

No response

Known Workarounds

No response

Configuration
  • Occurs in both .NET 8.0.403 and 9.0.100-preview.7.24407.12
  • Running Ubuntu 22.04 via WSL2 on Windows 11.
  • Same behavior in debug and release builds
  • Outside of WSL, the task outputs every second as expected on both .NET versions.
Other information

No response

Dominant language
C#
Stars
18.3k
Forks
5.6k
PR merge metrics
PR metrics pending

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/runtime

All issues in dotnet/runtime

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.