Debugger hangs starting gdb.exe on Windows 10 with UTF-8 enabled. #1527

weinand · 2018-02-07T09:16:22Z

From @leoliuasia on February 7, 2018 6:6

VSCode Version:1.19.3
OS Version: Windows 10 Pro 1709 16299.214

Steps to Reproduce:

Debug->Start Debugging
Nothing happens.... just hang in there with little blue block progressbar scrolling...

But when I force end task for gdb.exe in task manager window, vscode shows up an error, and little blue block disappears.

c_cpp_properties.json:

{
            "name": "Win32",
            "includePath": [
                "${workspaceRoot}",
                "C:\\MinGW\\lib\\gcc\\mingw32\\6.3.0\\include\\c++"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE"
            ],
            "intelliSenseMode": "msvc-x64",
            "browse": {
                "path": [
                    "${workspaceRoot}",
                    "C:\\MinGW\\lib\\gcc\\mingw32\\6.3.0\\include\\c++"
                ],
                "limitSymbolsToIncludedHeaders": true,
                "databaseFilename": ""
            }
        }

task.json:

"tasks": [
        {
            "label": "build cpp",
            "type": "shell",
            "command": "g++",
            "args": [
                "-g",
                "-o",
                "a.out",
                "main.cpp",
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]

launch.json

"configurations": [
        {
            "name": "(gdb) Launch",
            "type": "cppdbg",
            "request": "launch",
            "program": "${workspaceFolder}\\a.out",
            "args": [],
            "stopAtEntry": false,
            "cwd": "${workspaceFolder}",
            "environment": [],
            "externalConsole": true,
            "MIMode": "gdb",
            "miDebuggerPath": "C:\\MinGW\\bin\\gdb.exe",
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                }
            ]
        }
    ]

Copied from original issue: microsoft/vscode#43075

pieandcakes · 2018-02-07T20:18:57Z

@leoliuasia Can you enable "logging": { "engineLogging": true } and see where it stops while communicating with gdb?

leoliuasia · 2018-02-08T01:48:32Z

@pieandcakes Thanks for your time! Below are the output informations from the DEBUG CONSOLE after logging enabled.

1: (267) LaunchOptions<LocalLaunchOptions xmlns='http://schemas.microsoft.com/vstudio/MDDDebuggerOptions/2014'
1: (283) LaunchOptions ExePath='c:\Users\Leo\Desktop\cpp\a.out'
1: (283) LaunchOptions WorkingDirectory='c:\Users\Leo\Desktop\cpp'
1: (283) LaunchOptions ExeArguments=''
1: (283) LaunchOptions MIMode='gdb'
1: (283) LaunchOptions MIDebuggerPath='C:\MinGW\bin\gdb.exe'
1: (283) LaunchOptions WaitDynamicLibLoad='false'
1: (283) LaunchOptions ExternalConsole='true'
1: (283) LaunchOptions>
1: (283) LaunchOptions
1: (283) LaunchOptions -enable-pretty-printing
1: (283) LaunchOptions
1: (283) LaunchOptions
1: (361) Starting: "C:\MinGW\bin\gdb.exe" --interpreter=mi
1: (1914) DebuggerPid=9076
1: (1982) ->=thread-group-added,id="i1"
1: (1983) ->~"GNU gdb (GDB) 7.6.1\n"
1: (1983) ->~"Copyright (C) 2013 Free Software Foundation, Inc.\n"
1: (1983) ->~"License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html\nThis is free software: you are free to change and redistribute it.\nThere is NO WARRANTY, to the extent permitted by law. Type "show copying"\nand "show warranty" for details.\n"
1: (1983) ->~"This GDB was configured as "mingw32".\nFor bug reporting instructions, please see:\n"
1: (1983) ->~"http://www.gnu.org/software/gdb/bugs/.\n"
1: (1983) ->(gdb)
1: (1992) <-1001-gdb-set target-async on
1: (1992) ->&"\357\273\2771001-gdb-set target-async on\n"
1: (1993) ->&"Undefined command: "\357". Try "help".\n"
1: (1993) ->^error,msg="Undefined command: "\357". Try "help"."
1: (1993) ->(gdb)
1: (1993) ->&"\n"
1: (1993) ->^done
1: (1993) ->(gdb)

leoliuasia · 2018-02-08T01:53:34Z

@pieandcakes When this kind of things happens, I think the "Stop Debugging" should also be working, but it does not. The whole debug process only can start again util reopen the vscode.

pieandcakes · 2018-02-08T19:06:40Z

@leoliuasia I don't know if you are using a different encoding, but for some reason gdb is receiving

1: (1992) <-1001-gdb-set target-async on
1: (1992) ->&"\357\273\2771001-gdb-set target-async on\n"
1: (1993) ->&"Undefined command: "\357". Try "help".\n"
1: (1993) ->^error,msg="Undefined command: "\357". Try "help"."

and the issue looks like ->&"\357\273\2771001-gdb-set target-async on\n" with the strangely escaped characters.

WardenGnaw · 2018-02-09T00:45:20Z

@leoliuasia Can you run reg query "hklm\system\controlset001\control\nls\language" /v Installlanguage? This will help us understand which language you have enabled on your OS for us to recreate the issue.

leoliuasia · 2018-02-09T17:27:39Z

@WardenGnaw Below is the output:

D:\Integration Projects>reg query "hklm\system\controlset001\control\nls\language" /v Installlanguage
HKEY_LOCAL_MACHINE\system\controlset001\control\nls\language
Installlanguage REG_SZ 0409

WardenGnaw · 2018-02-09T21:55:56Z

Could you also share what CodePage your OS is running? You can find this out by building and running the attached project.

You can build and run this by installing dotnet core at https://www.microsoft.com/net/learn/get-started/windows. Then unzip that project and run dotnet build and dotnet run.

You should see something similar to Your code page is 437 but with a different number.

CheckCodePage.zip

WardenGnaw · 2018-02-10T01:20:52Z

Hi,

We may have a potential fix. Can you try installing this patched cpptools vsix and see if this fixes your issue?

cpptools.zip

Please uninstall the c/c++ extension that is already installed, then in the Extensions menu, click on the 3 dots and you should see install from vsix.

Thank you.

bolu61 · 2018-02-12T02:58:30Z

@WardenGnaw I ran into the exact same issue. My code page is 65001. The potential fix does not work.
@pieandcakes I believe that \357\273\277 is a BOM indicating UTF-8 encoding?

pieandcakes · 2018-02-12T20:13:35Z

@MUTTSU which OS installation are you using? Please give the OS version and the locale that you installed so we can setup a proper test machine. We haven't been able to duplicate this issue here yet.

bolu61 · 2018-02-12T22:46:33Z

Im using win10pro build 17093.1000 (though i had this issue with older builds). Locale is en_CA.

Also I was wondering when the extension starts gdb, where does "set target-async on" come from? I couldn't figure out where in the extension's code it tries to put these configurations.

pieandcakes · 2018-02-12T22:56:33Z

Do you have any additional language packs installed? are you using an input method other than English?

bolu61 · 2018-02-12T23:02:13Z

@pieandcakes I do have french, chinese and japanese keyboard layouts installed, but i use english(us) for coding. I noticed that vscode would switch my keyboard layout sometimes? it's weird

WardenGnaw · 2018-02-14T17:45:22Z

@MUTTSU The "set target-async on" comes from MIEngine which the extension uses as part of the debug adapter.

https://github.com/Microsoft/MIEngine/blob/8e4eae7c0bc5b363ceef02002c95db9384f1ec29/src/MICore/CommandFactories/gdb.cs#L203

leoliuasia · 2018-02-27T01:28:43Z

@WardenGnaw My CodePage is 65001. The potential fix does not work.

pieandcakes · 2018-03-01T01:03:05Z

@leoliuasia What region is your English keyboard setting?

leoliuasia · 2018-03-01T07:41:27Z

@pieandcakes English(United States) with keyboard layout: US.

pieandcakes · 2018-03-01T16:07:20Z

@leoliuasia @MUTTSU we are having problems reproducing this issue.

I’ve tried installing non-US windows and changing locales and keyboards but I can’t seem to get my Windows installation to report code page 65001. Can either of you provide some guidance as to what other configuration you did? It doesn’t matter what I change I still get my base code page.

Win 10 installation: Simplified Chinese
keyboards installed: en-us, en-ca and en-Uk
Locale: en-ca

Encoding: 936

bolu61 · 2018-03-08T16:54:31Z

@pieandcakes I think I had the beta option that let me use some universal UTF-8 encoding in locale settings. I'm going to uncheck that and see if it works.
Edit: It worked, but I also changed the locale to en-US, so I can't tell which actually solved the problem. I'm pretty sure that this setting was not there until recent insider releases...

kinokn · 2018-06-11T15:36:52Z

@pieandcakes @MUTTSU Same problem and I've fixed it by disabling unicode UTF-8 encoding in region settings and current system locate is Chinese (Simplified, China)

pieandcakes · 2018-06-11T20:10:35Z

@MUTTSU @KIRI-Z We haven't found a good solution beyond having users disable Unicode UTF-8 encoding.

@KIRI-Z Do you have a good set of steps that users can use to disable this setting? If so, please share it here so users know how to work around the problem.

kinokn · 2018-06-12T06:03:22Z

@pieandcakes Sure.
The unicode UTF-8 (region setting) is a beta feature in Windows10 1803 which is disabled by default.
It is at Control Panel - Clock and Region - Region - Administrative - Change system locate (administrator authorization required) - Beta: Use Unicode UTF-8 for worldwide language support (system reboot needed). Disable it maybe helpful.

Summon528 · 2019-05-15T03:44:41Z

Is this actually fixed? cause debugger still hangs if I enable UTF-8. I'm using v0.23.1

pieandcakes · 2019-05-15T17:44:10Z

@Summon528 No I think this was closed by accident. The codepage issue has not been fixed. I have been unable to determine why we are receiving a UTF-8 BOM from gdb and unfortunately this is still causing problems.

Iamnvincible · 2019-07-16T02:44:02Z

I encounter the same problem, and my Beta: Use Unicode UTF-8 for worldwide language support is enabled.
Just make Beta: Use Unicode UTF-8 for worldwide language support unchecked can solve the problem.
Thanks

phanthaiduong22 · 2019-09-08T08:05:30Z

I have the same problems: i cannot type input when debug. I reinstall window yesterday.
I tried Beta: Use Unicode UTF-8 for worldwide language support unchecked. But it does not work.https://imgur.com/a/0rJtOVL

pieandcakes · 2019-09-09T17:32:34Z

@phanthaiduong22 if you would like help, please post an engine log and more additional information.

rivy · 2019-09-15T22:00:57Z

@pieandcakes , Any status on fixing this?

As a workaround...

add a "gdb-with-chcp.BAT" within to your project (eg, "dbin/gdp-with-chcp.BAT"):

@:: gdb-with-chcp.BAT
@chcp 1257 >NUL 2>&1 && @"gdb.exe" %*

use "PATHTO/gdb-with-chcp.BAT" as "miDebuggerPath" within "launch.json"

// eg
// ...
"miDebuggerPath": "${workspaceFolder}/dbin/gdb-with-chcp.BAT",
// ...

pieandcakes · 2019-09-16T17:54:46Z

We are trying to determine what needs to happen to block sending of the BOM to gdb. Our problem is that the pipe we create when Unicode is enabled is causing a BOM to be sent on the gdb side of the communication pipe which causes gdb to generate an error.

We have a repro but not a good way to make a fix unfortunately.

phanthaiduong22 · 2019-09-23T10:07:22Z

@phanthaiduong22 if you would like help, please post an engine log and more additional information.
https://imgur.com/a/dzySuvV

I just install Window yesterday so Beta: Unicode UTF-8 for worldwide language support was already disabled. But when i debugging i still can't type in terminal my input( like image i want to type a,b but it doesn't work.

OS: win10 pro
Version: 1.38.1 (user setup)
Commit: b37e54c98e1a74ba89e03073e5a3761284e3ffb0
Date: 2019-09-11T13:35:15.005Z
Electron: 4.2.10
Chrome: 69.0.3497.128
Node.js: 10.11.0
V8: 6.9.427.31-electron.0
OS: Windows_NT x64 10.0.18362
Extension: C/C++, Version 0.25.1: August 28, 2019

Here is my .vscode : https://pastebin.com/SE3gmACy

pieandcakes · 2019-09-23T17:38:40Z

The UTF8 issue is not the issue you are running into @phanthaiduong22. It looks like its waiting for input but i don't see you typing anything in the terminal. You can also try "externalConsole": true to see if that provides the experience you are looking for. It might be clearer if you first cout something so you can see it in the terminal window.

phanthaiduong22 · 2019-09-24T15:32:15Z

Actually, I typed a,b (ex: 3 4) in temminal in vscode . but nothing happened.

z7z8th · 2019-10-20T14:51:23Z

This issue blocked me several days until I know it's caused by UTF BOM.
After some debugging, I found that the BOM does not come from the PIPE, but comes from the input stream of the debugger(gdb for me).

In file https://github.com/microsoft/MIEngine/blob/master/src/WindowsDebugLauncher/DebugLauncher.cs :
I think the UTF BOM is already in the BaseStream when creating the debugger process.
So the following line did not remove the BOM.

_debuggerCommandStream = new StreamWriter(_dbgProcess.StandardInput.BaseStream, new UTF8Encoding(encoderShouldEmitUTF8Identifier: false)) { AutoFlush = true };

Two possible solutions:

flush the UTF8 BOM individually:
Add the following lines after https://github.com/microsoft/MIEngine/blob/ccec0b00986ca4606b19291a3a3fcf986e5728a6/src/WindowsDebugLauncher/DebugLauncher.cs#L135

_debuggerCommandStream.WriteLine();
_debuggerCommandStream.Flush();

Log after this change:

1: (993) ->~"For help, type \"help\".\n"
1: (994) ->~"Type \"apropos word\" to search for commands related to \"word\".\n"
1: (996) ->(gdb)
1: (996) ->&"\357\273\277\n"
1: (996) ->&"Undefined command: \"\".  Try \"help\".\n"
1: (996) ->^error,msg="Undefined command: \"\".  Try \"help\"."
1: (996) ->(gdb)
1: (1000) <-1001-gdb-set target-async on
1: (1005) Send Event AD7MessageEvent
1: (1007) ->1001^done
1: (1007) ->(gdb)
1: (1007) ->&"\n"
1: (1007) ->^done
1: (1007) ->(gdb)
1: (1007) 1001: elapsed time 6
1: (1014) <-1002-enable-pretty-printing

change the encoding of the console of windowsdebugadapter.exe, so the debugger inherits it's settings
Add the following line before _dbgProcess.Start(); in https://github.com/microsoft/MIEngine/blob/master/src/WindowsDebugLauncher/DebugLauncher.cs

Console.InputEncoding = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);

Log after this change:

1: (993) ->~"Type \"apropos word\" to search for commands related to \"word\".\n"
1: (995) ->(gdb)
1: (999) <-1001-gdb-set target-async on
1: (1005) ->1001^done
1: (1005) ->(gdb)
1: (1005) ->&"\n"
1: (1005) ->^done
1: (1005) ->(gdb)
1: (1006) 1001: elapsed time 7
1: (1012) <-1002-enable-pretty-printing

I tested the 2nd solution with English+UTF8, Chinese+UTF-8 and Chinese+Unicode(UTF16), all works.

The 2nd solution seems cleaner if no other impact.

phanthaiduong22 · 2019-10-21T01:45:43Z

DebugLauncher.cs

Excuse me, Where is DebugLauncher.cs located in my computer.

Thanks

z7z8th · 2019-10-21T02:59:01Z

@phanthaiduong22
You need to download the MIEngine source code to get that file. It's part of the source code of the c/c++ extension. the source code needed to be built in visual studio to generate windowsdebugadapter.exe and serveral other files. but your problem is not related to this issue.

pieandcakes · 2019-10-21T18:07:55Z

@z7z8th Thank you for your investigation. Let me take that fix and do some additional testing.

Thanks!

michelleangela · 2019-10-28T20:57:59Z

Fixed in 0.26.1

- use new '${defaultBuildTask}' (ref: microsoft/vscode#80478) - removes now unneeded workaround for use of `gdb` with UTF-8 (ref: microsoft/vscode-cpptools#1527)

weinand mentioned this issue Feb 7, 2018

why vscode just hang in there when start debugging with gdb.exe? microsoft/vscode#43075

Closed

pieandcakes added debugger more info needed labels Feb 7, 2018

hodlen mentioned this issue Jun 13, 2018

Debugger won't start on Windows 10 setting UTF-8 locale #2127

Closed

pieandcakes changed the title ~~why vscode just hang in there when start debugging with gdb.exe?~~ Debugger hangs starting gdb.exe on Windows 10 with UTF-8 enabled. Jun 13, 2018

pieandcakes added bug and removed more info needed labels Jun 13, 2018

pieandcakes mentioned this issue Jun 25, 2018

Error with IntelliSense and Debugging when set to Unicode UTF-8 worldwide. #2167

Closed

thelastlin mentioned this issue Apr 12, 2019

Launching the debugger in mode "gdb" hangs forever #3353

Open

This was referenced May 2, 2019

gdb debugging - step controls, breakpoints, etc. not working #1685

Closed

debugger doesn't hit breakpoint in my c++ "helloworld" programe #3278

Closed

pieandcakes reopened this May 15, 2019

pieandcakes removed the fixed label Aug 20, 2019

pieandcakes mentioned this issue Aug 20, 2019

GDB got stuck at launching. #4103

Closed

pieandcakes mentioned this issue Oct 23, 2019

Fix for sending BOM when Unicode Beta feature is enabled microsoft/MIEngine#942

Merged

pieandcakes closed this as completed in microsoft/MIEngine#942 Oct 23, 2019

pieandcakes self-assigned this Oct 25, 2019

pieandcakes added the fixed label Oct 25, 2019

pieandcakes added this to the 0.26.1 milestone Oct 25, 2019

Qone2 mentioned this issue Nov 1, 2019

When i start debugging with gdb.exe, it hangs forever and never terminates. #4523

Closed

11tyOne mentioned this issue Mar 4, 2020

VSCode debugger doesnt work when trying to debug a c++ program #5051

Closed

rivy added a commit to rivy/less that referenced this issue Aug 21, 2020

Maint/build ~ update VSCode debug settings

174cbe1

- use new '${defaultBuildTask}' (ref: microsoft/vscode#80478) - removes now unneeded workaround for use of `gdb` with UTF-8 (ref: microsoft/vscode-cpptools#1527)

iXanadu13 mentioned this issue Nov 18, 2023

Debugger does not stop at breakpoint when using newer mingw-w64 on Windows 10 #11711

Closed

Debugger hangs starting gdb.exe on Windows 10 with UTF-8 enabled. #1527

Debugger hangs starting gdb.exe on Windows 10 with UTF-8 enabled. #1527

Comments

weinand commented Feb 7, 2018

Steps to Reproduce:

c_cpp_properties.json:

task.json:

launch.json

pieandcakes commented Feb 7, 2018

leoliuasia commented Feb 8, 2018 • edited Loading

leoliuasia commented Feb 8, 2018

pieandcakes commented Feb 8, 2018

WardenGnaw commented Feb 9, 2018

leoliuasia commented Feb 9, 2018

WardenGnaw commented Feb 9, 2018

WardenGnaw commented Feb 10, 2018

bolu61 commented Feb 12, 2018 • edited Loading

pieandcakes commented Feb 12, 2018

bolu61 commented Feb 12, 2018 • edited Loading

pieandcakes commented Feb 12, 2018

bolu61 commented Feb 12, 2018 • edited Loading

WardenGnaw commented Feb 14, 2018

leoliuasia commented Feb 27, 2018

pieandcakes commented Mar 1, 2018

leoliuasia commented Mar 1, 2018

pieandcakes commented Mar 1, 2018

bolu61 commented Mar 8, 2018 • edited Loading

kinokn commented Jun 11, 2018

pieandcakes commented Jun 11, 2018

kinokn commented Jun 12, 2018

Summon528 commented May 15, 2019 • edited Loading

pieandcakes commented May 15, 2019

Iamnvincible commented Jul 16, 2019

phanthaiduong22 commented Sep 8, 2019 • edited Loading

pieandcakes commented Sep 9, 2019

rivy commented Sep 15, 2019 • edited Loading

pieandcakes commented Sep 16, 2019 • edited Loading

phanthaiduong22 commented Sep 23, 2019

pieandcakes commented Sep 23, 2019

phanthaiduong22 commented Sep 24, 2019

z7z8th commented Oct 20, 2019 • edited Loading

phanthaiduong22 commented Oct 21, 2019

z7z8th commented Oct 21, 2019 • edited Loading

pieandcakes commented Oct 21, 2019

michelleangela commented Oct 28, 2019

leoliuasia commented Feb 8, 2018 •

edited

Loading

bolu61 commented Feb 12, 2018 •

edited

Loading

bolu61 commented Feb 12, 2018 •

edited

Loading

bolu61 commented Feb 12, 2018 •

edited

Loading

bolu61 commented Mar 8, 2018 •

edited

Loading

Summon528 commented May 15, 2019 •

edited

Loading

phanthaiduong22 commented Sep 8, 2019 •

edited

Loading

rivy commented Sep 15, 2019 •

edited

Loading

pieandcakes commented Sep 16, 2019 •

edited

Loading

z7z8th commented Oct 20, 2019 •

edited

Loading

z7z8th commented Oct 21, 2019 •

edited

Loading