-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4115 from microsoft/seanmcm/0_25_0_release
Seanmcm/0 25 0 release
- Loading branch information
Showing
95 changed files
with
4,871 additions
and
2,694 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1 @@ | ||
| # Pipe Transport | ||
|
|
||
| Pipe Transport allows communication through a pipe program to a remote shell. An example on Linux would be `ssh`. | ||
|
|
||
| ## How-To | ||
|
|
||
| We have added `"pipeTransport"` as an option within the **launch.json** file. The structure looks as follows: | ||
| ```json | ||
| "pipeTransport": { | ||
| "pipeCwd": "/usr/bin", | ||
| "pipeProgram": "/usr/bin/ssh", | ||
| "pipeArgs": [ | ||
| "-pw", | ||
| "<password>", | ||
| "[email protected]" | ||
| ], | ||
| "debuggerPath": "/usr/bin/gdb" | ||
| }, | ||
| ``` | ||
| The `pipeArgs` can be any set of arguments necessary to setup and authenticate the pipe connection. In the example, a password is used but you can also use an ssh key. | ||
|
|
||
| You may also need to add a `sourceFileMap` to map the path of where the code exists on the remote shell to where it is locally: | ||
| ```json | ||
| "sourceFileMap": { | ||
| // "remote": "local" | ||
| "/home/user/src": "/src/projectA/src" | ||
| } | ||
| ``` | ||
|
|
||
| ## Attach | ||
|
|
||
| You can also use the above `pipeTransport` block to attach to a remote process. In the attach case, you will need to specify a `processId`. We have added the ability to query processes from the remote machine. To do this, change `"processId": "${command.pickProcess}"` to `"processId": "${command.pickRemoteProcess}"`. The `pipeTransport` settings will be used to query the processes on the remote machine. Then select the process from the drop down list. As with `launch`, you may need to configure `sourceFileMap`. | ||
|
|
||
| ## Docker example | ||
|
|
||
| The `pipeTransport` can also be used to debug a process in a Docker container. For an attach, **launch.json** will include: | ||
|
|
||
| ```json | ||
| "pipeTransport": { | ||
| "pipeCwd": "${workspaceRoot}", | ||
| "pipeProgram": "docker", | ||
| "pipeArgs": [ | ||
| "exec", | ||
| "-i", | ||
| "hello_gdb", | ||
| "sh", | ||
| "-c" | ||
| ], | ||
| "debuggerPath": "/usr/bin/gdb" | ||
| }, | ||
| ``` | ||
| Where `hello_gdb` is the name of your container. | ||
|
|
||
| Launching a process is accomplished by starting a container and then using the same `pipeTransport` launch additional processes in the container. See this [**launch.json**](https://github.com/andyneff/hello-world-gdb/blob/master/.vscode/launch.json) for a [full example](https://github.com/andyneff/hello-world-gdb/). | ||
| The documentation for pipe transport has moved to https://code.visualstudio.com/docs/cpp/pipe-transport. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,91 +1 @@ | ||
| # Windows 10's Windows Subsystem for Linux | ||
|
|
||
| With the release of Windows 10 Creators Update (Build 15063), you will now be able to use Visual Studio Code and the Microsoft C/C++ extension to debug your [Windows Subsystem for Linux (WSL)](https://msdn.microsoft.com/en-us/commandline/wsl/about) projects. | ||
|
|
||
| Code can be written on Windows itself using VSCode and debugged through `bash.exe` to the Bash on Windows layer. | ||
|
|
||
| As of the Fall Creator's Update, you can have multiple distros installed, but `bash.exe` and `wsl.exe` use the default distro. Use [WSL Config](https://msdn.microsoft.com/en-us/commandline/wsl/wsl-config) to set your default distro. | ||
|
|
||
| **NOTE: Creator's Update (Build 15063 or later) is required due to bug-fixes within the subsystem that we rely on to provide debugging. Debugging using a previous version of WSL is unsupported and likely will not work. To check your Windows version, enter `winver` in a command prompt.** | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| * [Windows 10 Creators Update or later with Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide) installed. | ||
| * Install g++/gcc and gdb within `WSL` to allow compiling and debugging. You can use the package manager to do this. For example, to install g++, you can run `sudo apt install g++` in the Bash window. | ||
| * [Visual Studio Code](https://code.visualstudio.com) + Microsoft C/C++ extension for VSCode. | ||
|
|
||
| ## How-To | ||
|
|
||
| To debug, commands will be routed from Windows through `bash.exe` to set up debugging. Because our extension runs as a 32-bit process, it will need to use the `C:\Windows\SysNative` folder to access the `bash.exe` executable that is normally in `C:\Windows\System32`. We will be using the `"pipeTransport"` ability within the extension to do debugging and `"sourceFileMap"` to map the source from the subsystem's paths back to Windows path. | ||
|
|
||
| **NOTE: Applications will need to be compiled in the `Windows Subsystem for Linux (WSL)` prior to debugging.** | ||
|
|
||
| ### Example `launch.json` for Launching | ||
|
|
||
| In the following example, I have a local drive, `Z:\` that has my source code within windows for an app called _kitchensink_. I have set up the `"program"` and `"cwd"` paths to point to the directory within `WSL`. I have set up the `"pipeTransport"` to use `bash.exe`. I have also set up a `"sourceFileMap"` to have everything that is returned by `gdb` that starts with `/mnt/z` to point to `Z:\\` in Windows. | ||
|
|
||
| ```json | ||
| { | ||
| "name": "C++ Launch", | ||
| "type": "cppdbg", | ||
| "request": "launch", | ||
| "program": "/mnt/z/Bash/kitchensink/a.out", | ||
| "args": ["-fThreading"], | ||
| "stopAtEntry": false, | ||
| "cwd": "/mnt/z/Bash/kitchensink", | ||
| "environment": [], | ||
| "externalConsole": true, | ||
| "windows": { | ||
| "MIMode": "gdb", | ||
| "setupCommands": [ | ||
| { | ||
| "description": "Enable pretty-printing for gdb", | ||
| "text": "-enable-pretty-printing", | ||
| "ignoreFailures": true | ||
| } | ||
| ] | ||
| }, | ||
| "pipeTransport": { | ||
| "pipeCwd": "", | ||
| "pipeProgram": "c:\\windows\\sysnative\\bash.exe", | ||
| "pipeArgs": ["-c"], | ||
| "debuggerPath": "/usr/bin/gdb" | ||
| }, | ||
| "sourceFileMap": { | ||
| "/mnt/z": "z:\\" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Example `launch.json` for Attaching to an Existing Process | ||
|
|
||
| This configuration similar to the launch process above. I have chosen to start the same application above from the Bash command line and now I want to attach to it for debugging. I have changed the `"processID"` to use the remote process picker by specifying the command `"${command:pickRemoteProcess}"` and set up the same `"sourceFileMap"`. When I press <kbd>F5</kbd> to attach, I get a picker drop down showing the running processes within `WSL`. I can scroll or search for the process I want to attach to and start debugging. | ||
|
|
||
| ```json | ||
| { | ||
| "name": "C++ Attach", | ||
| "type": "cppdbg", | ||
| "request": "attach", | ||
| "program": "/mnt/z/Bash/kitchensink/a.out", | ||
| "processId": "${command:pickRemoteProcess}", | ||
| "windows": { | ||
| "MIMode": "gdb", | ||
| "setupCommands": [ | ||
| { | ||
| "description": "Enable pretty-printing for gdb", | ||
| "text": "-enable-pretty-printing", | ||
| "ignoreFailures": true | ||
| } | ||
| ] | ||
| }, | ||
| "pipeTransport": { | ||
| "pipeCwd": "", | ||
| "pipeProgram": "c:\\windows\\sysnative\\bash.exe", | ||
| "pipeArgs": ["-c"], | ||
| "debuggerPath": "/usr/bin/gdb" | ||
| }, | ||
| "sourceFileMap": { | ||
| "/mnt/z": "z:\\" | ||
| } | ||
| } | ||
| ``` | ||
| The documentation for GCC on Windows Subsystem for Linux (WSL) has moved to https://code.visualstudio.com/docs/cpp/config-wsl. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1 @@ | ||
| # Natvis - Custom views for native objects | ||
|
|
||
| The Natvis framework allows developers to write custom schemas to help visualize native objects. | ||
|
|
||
| For gdb/lldb debugging (`"type": "cppdbg"`), a subset of the Natvis framework has been ported to the C/C++ extension and the code resides in the [MIEngine](https://github.com/Microsoft/MIEngine) shared component. If additional features that are not implemented are requested, please file an [issue](https://github.com/Microsoft/MIEngine/issues) on the MIEngine GitHub page with details of what is missing. | ||
|
|
||
| For Visual C++ debugging (`"type": "cppvsdbg"`), the debugger contains the full implementation of the Natvis framework as Visual Studio. | ||
|
|
||
| ## Documentation | ||
|
|
||
| The official documentation can be found [here](https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects). | ||
|
|
||
| ## Schema | ||
|
|
||
| The Natvis schema can be found [here](natvis.xsd). | ||
| The documentation for Natvis has moved to https://code.visualstudio.com/docs/cpp/natvis. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1 @@ | ||
| # FAQs | ||
|
|
||
| ## Table of Contents | ||
| * Setup: [Debugging Setup](#debugging-setup) | ||
| * Setup: [What is the .vscode/ipch folder?](#what-is-the-vscodeipch-folder) | ||
| * Setup: [How do I disable the IntelliSense cache (ipch)?](#how-do-i-disable-the-intellisense-cache-ipch) | ||
| * Debugger: [Why is debugging not working?](#why-is-debugging-not-working) | ||
| * Build: [How to enable debug symbols](#how-to-enable-debug-symbols) | ||
| * Logging: [How to enable logging](#how-to-enable-logging) | ||
|
|
||
| ## Debugging Setup | ||
| The debugger needs to be configured to know which executable and debugger to use: | ||
|
|
||
| Click menu item: `Debug` -> `Add Configuration...` | ||
|
|
||
| The file **launch.json** will now be open for editing with a new configuration. The default settings will *probably* work except that you need to specify the **program** setting. | ||
|
|
||
| See the [**Documentation/Debugger**](https://github.com/Microsoft/vscode-cpptools/tree/master/Documentation/Debugger) folder in this repository for more in-depth documentation on how to configure the debugger. | ||
|
|
||
| ## What is the .vscode/ipch folder? | ||
|
|
||
| The language server caches information about included header files to improve the performance of IntelliSense. When you edit C/C++ files in your workspace folder, the language server will store cache files in the `.vscode/ipch` folder by default. VS Code per-workspace storage folders were not selected for the following reasons: | ||
| * The workspace storage location provided by VS Code is somewhat obscure and we had reservations about writing GB's worth of files in this location where users may not see them or know where to find them. | ||
| * Parity with Visual Studio. This is how Visual Studio works and they receive little to no feedback/complaints on the location. | ||
|
|
||
| With this in mind we knew that we wouldn't be able to please everyone, so we provided settings to allow you to customize this the way that works best for your situation. We also figured that putting the files in the workspace folder would bring the issue to your attention quickly so that you can take action if you don't like the default behavior. | ||
|
|
||
| #### `"C_Cpp.intelliSenseCachePath": <string>` | ||
| This setting allows you to set workspace or global overrides for the cache path. For example, if you want to share a single cache location for all workspace folders, you just open the VS Code settings, and add a "User" setting for "IntelliSense Cache Path". | ||
|
|
||
| #### `"C_Cpp.intelliSenseCacheSize": <number>` | ||
| This setting allows you to set a limit on the amount of caching the extension does. This is an approximation, but the extension will make a best effort to keep the cache size as close to the limit you set as possible. If you are sharing the cache location across workspaces as explained above, you can still increase/decrease the limit, but you should make sure that you add a "User" setting for "IntelliSense Cache Size". | ||
|
|
||
| ## How do I disable the IntelliSense cache (ipch)? | ||
|
|
||
| If you do not want to use the IntelliSense caching feature to improve the performance of IntelliSense, you can disable the feature by setting the "IntelliSense Cache Size" setting to 0. (or `"C_Cpp.intelliSenseCacheSize": 0"` in the JSON settings editor) | ||
|
|
||
| ## Why is debugging not working? | ||
|
|
||
| ### My breakpoints aren't being hit | ||
|
|
||
| When you start debugging, if it is showing that your breakpoints aren't bound (solid red circle) or they are not being hit, you may need to enable [debug symbols](#how-to-enable-debug-symbols) during compilation. | ||
|
|
||
| ### Debugging starts but all the lines in my stack trace are grey | ||
|
|
||
| If your debugger is showing a grey stacktrace or won't stop at a breakpoint, or the symbols in the call stack are grey then your executable was compiled without [debug symbols](#how-to-enable-debug-symbols). | ||
|
|
||
| ## How to enable debug symbols? | ||
|
|
||
| Enabling debug symbols are dependent on the type of compiler you are using. Below are some of the compilers and the compiler options necessary to enable debug symbols. | ||
|
|
||
| When in doubt, please check your compiler's documentation for the options necessary to include debug symbols in the output. This may be some variant of `-g` or `--debug`. | ||
|
|
||
| * #### Clang (C++) | ||
| * If you invoke the compiler manually then add the `--debug` option. | ||
| * If you're using a script then make sure the `CXXFLAGS` environment variable is set; e.g. `export CXXFLAGS="${CXXFLAGS} --debug"` | ||
| * If you're using CMake then set make sure the `CMAKE_CXX_FLAGS` is set; e.g. `export CMAKE_CXX_FLAGS=${CXXFLAGS}` | ||
|
|
||
| * #### Clang (C) | ||
| See Clang C++ but use `CFLAGS` instead of `CXXFLAGS`. | ||
|
|
||
| * #### gcc or g++ | ||
| If you invoke the compiler manually, add the `-g` option. | ||
|
|
||
| * #### cl.exe | ||
| Symbols are located in the `*.pdb` file. | ||
|
|
||
| ## How to enable logging | ||
|
|
||
| Enabling logging will show communication information between VS Code and our extension and between our extension and the debugger. | ||
|
|
||
| ### Logging for `MI` debuggers | ||
|
|
||
| The logging block with its defaults is as follows: | ||
|
|
||
| ``` | ||
| "logging": { | ||
| "trace": false, | ||
| "traceResponse": false, | ||
| "engineLogging": false | ||
| } | ||
| ``` | ||
|
|
||
| #### VS Code and the CppTools extension | ||
|
|
||
| The logging here is called `trace` logging and can be enabled by setting `trace` and `traceResponse` to `true` in the logging block inside `launch.json`. This will help diagnose issues related to VS Code's communication to our extension and our responses. | ||
|
|
||
| #### CppTools extension and the debugger | ||
|
|
||
| The logging between CppTools and the debugger is called `engineLogging`. When using an `MI` debugger such as `gdb` or `lldb`, this will show the request, response and events using the `mi` interpreter. This logging will help us determine whether the debugger is receiving the right commands and generating the correct responses. | ||
|
|
||
| ### Logging for `Visual C++` debugger | ||
|
|
||
| The logging block with its defaults is as follows: | ||
|
|
||
| ``` | ||
| "logging": { | ||
| "engineLogging": false | ||
| } | ||
| ``` | ||
|
|
||
| The `Visual C++` debugger logging will show only the communication to and from VS Code as all communication to the debugger is done internally to the process and is not visible through logging. | ||
| The FAQs for the C/C++ extension has moved to https://code.visualstudio.com/docs/cpp/faq-cpp. |
Oops, something went wrong.