[Lldb-commits] [lldb] [lldb-dap] Create a typescript extension for lldb-dap (PR #75515)
via lldb-commits
lldb-commits at lists.llvm.org
Thu Dec 14 11:10:03 PST 2023
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-lldb
Author: Walter Erquinigo (walter-erquinigo)
<details>
<summary>Changes</summary>
This is very straightforward and these are the most important details:
- All the cpp code has been moved to a subfolder for cleanness. There's a specific commit in the list of commits of this PR that just does that, in case that helps reviewing this.
- A new folder `src-ts` has been created for the typescript code
- The ts extension can be used in two ways: as a regular vscode extension and as a library. There file `extension.ts` explains which entry point to use.
- The README has been updated the mention how to install the extension, which is simpler than before. There are two additional sections for rebuilding and formatting.
- The ts code I added merely sets up the debug adapter using two possible options: reading the lldb-dap path from vscode settings or from a config object passed by users of the extension is used as a library. I did this to show how we can support easily both worlds.
---
Patch is 85.63 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/75515.diff
43 Files Affected:
- (added) lldb/tools/lldb-dap/.gitignore (+5)
- (added) lldb/tools/lldb-dap/.vscode/launch.json (+24)
- (added) lldb/tools/lldb-dap/.vscode/tasks.json (+33)
- (modified) lldb/tools/lldb-dap/CMakeLists.txt (+1-60)
- (added) lldb/tools/lldb-dap/LICENSE.TXT (+234)
- (modified) lldb/tools/lldb-dap/README.md (+27-38)
- (added) lldb/tools/lldb-dap/package-lock.json (+1457)
- (modified) lldb/tools/lldb-dap/package.json (+31-34)
- (renamed) lldb/tools/lldb-dap/src-cpp/BreakpointBase.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/BreakpointBase.h ()
- (added) lldb/tools/lldb-dap/src-cpp/CMakeLists.txt (+60)
- (renamed) lldb/tools/lldb-dap/src-cpp/DAP.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/DAP.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/DAPForward.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/ExceptionBreakpoint.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/ExceptionBreakpoint.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/FifoFiles.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/FifoFiles.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/FunctionBreakpoint.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/FunctionBreakpoint.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/IOStream.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/IOStream.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/JSONUtils.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/JSONUtils.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/LLDBUtils.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/LLDBUtils.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/Options.td ()
- (renamed) lldb/tools/lldb-dap/src-cpp/OutputRedirector.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/OutputRedirector.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/ProgressEvent.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/ProgressEvent.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/RunInTerminal.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/RunInTerminal.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/SourceBreakpoint.cpp ()
- (renamed) lldb/tools/lldb-dap/src-cpp/SourceBreakpoint.h ()
- (renamed) lldb/tools/lldb-dap/src-cpp/lldb-dap-Info.plist.in ()
- (renamed) lldb/tools/lldb-dap/src-cpp/lldb-dap.cpp ()
- (added) lldb/tools/lldb-dap/src-ts/debug-adapter-factory.ts (+28)
- (added) lldb/tools/lldb-dap/src-ts/disposable-context.ts (+27)
- (added) lldb/tools/lldb-dap/src-ts/extension.ts (+35)
- (added) lldb/tools/lldb-dap/src-ts/types.ts (+18)
- (added) lldb/tools/lldb-dap/tsconfig.json (+16)
- (added) lldb/tools/lldb-dap/tsfmt.json (+17)
``````````diff
diff --git a/lldb/tools/lldb-dap/.gitignore b/lldb/tools/lldb-dap/.gitignore
new file mode 100644
index 00000000000000..a86a56c54d2e0d
--- /dev/null
+++ b/lldb/tools/lldb-dap/.gitignore
@@ -0,0 +1,5 @@
+out
+node_modules
+.vscode-test
+*.vsix
+!.vscode
diff --git a/lldb/tools/lldb-dap/.vscode/launch.json b/lldb/tools/lldb-dap/.vscode/launch.json
new file mode 100644
index 00000000000000..8241a5aca03543
--- /dev/null
+++ b/lldb/tools/lldb-dap/.vscode/launch.json
@@ -0,0 +1,24 @@
+{
+ // Use IntelliSense to learn about possible attributes.
+ // Hover to view descriptions of existing attributes.
+ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "type": "extensionHost",
+ "request": "launch",
+ "name": "Run Extension",
+ "runtimeExecutable": "${execPath}",
+ "args": [
+ "--extensionDevelopmentPath=${workspaceFolder}"
+ ],
+ "outFiles": [
+ "${workspaceFolder}/out/**/*.js"
+ ],
+ "preLaunchTask": {
+ "type": "npm",
+ "script": "watch"
+ }
+ }
+ ]
+}
diff --git a/lldb/tools/lldb-dap/.vscode/tasks.json b/lldb/tools/lldb-dap/.vscode/tasks.json
new file mode 100644
index 00000000000000..f82fc4134e78fb
--- /dev/null
+++ b/lldb/tools/lldb-dap/.vscode/tasks.json
@@ -0,0 +1,33 @@
+{
+ "version": "2.0.0",
+ "tasks": [
+ {
+ "type": "npm",
+ "script": "compile",
+ "group": "build",
+ "presentation": {
+ "panel": "dedicated",
+ "reveal": "never"
+ },
+ "problemMatcher": [
+ "$tsc"
+ ]
+ },
+ {
+ "type": "npm",
+ "script": "watch",
+ "isBackground": true,
+ "group": {
+ "kind": "build",
+ "isDefault": true
+ },
+ "presentation": {
+ "panel": "dedicated",
+ "reveal": "never"
+ },
+ "problemMatcher": [
+ "$tsc-watch"
+ ]
+ }
+ ]
+}
diff --git a/lldb/tools/lldb-dap/CMakeLists.txt b/lldb/tools/lldb-dap/CMakeLists.txt
index c71c80981890bd..9eb306f15e5b90 100644
--- a/lldb/tools/lldb-dap/CMakeLists.txt
+++ b/lldb/tools/lldb-dap/CMakeLists.txt
@@ -1,60 +1 @@
-if ( CMAKE_SYSTEM_NAME MATCHES "Windows" OR CMAKE_SYSTEM_NAME MATCHES "NetBSD" )
- list(APPEND extra_libs lldbHost)
-endif ()
-
-if (HAVE_LIBPTHREAD)
- list(APPEND extra_libs pthread)
-endif ()
-
-
-if(APPLE)
- configure_file(
- ${CMAKE_CURRENT_SOURCE_DIR}/lldb-dap-Info.plist.in
- ${CMAKE_CURRENT_BINARY_DIR}/lldb-dap-Info.plist
- )
- # Inline info plist in binary (use target_link_options for this as soon as CMake 3.13 is available)
- set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,-sectcreate,__TEXT,__info_plist,${CMAKE_CURRENT_BINARY_DIR}/lldb-dap-Info.plist")
-endif()
-
-# We need to include the llvm components we depend on manually, as liblldb does
-# not re-export those.
-set(LLVM_LINK_COMPONENTS Support)
-set(LLVM_TARGET_DEFINITIONS Options.td)
-tablegen(LLVM Options.inc -gen-opt-parser-defs)
-add_public_tablegen_target(LLDBDAPOptionsTableGen)
-add_lldb_tool(lldb-dap
- lldb-dap.cpp
- BreakpointBase.cpp
- ExceptionBreakpoint.cpp
- FifoFiles.cpp
- FunctionBreakpoint.cpp
- IOStream.cpp
- JSONUtils.cpp
- LLDBUtils.cpp
- OutputRedirector.cpp
- ProgressEvent.cpp
- RunInTerminal.cpp
- SourceBreakpoint.cpp
- DAP.cpp
-
- LINK_LIBS
- liblldb
- ${extra_libs}
-
- LINK_COMPONENTS
- Option
- Support
- )
-
-if(LLDB_BUILD_FRAMEWORK)
- # In the build-tree, we know the exact path to the framework directory.
- # The installed framework can be in different locations.
- lldb_setup_rpaths(lldb-dap
- BUILD_RPATH
- "${LLDB_FRAMEWORK_ABSOLUTE_BUILD_DIR}"
- INSTALL_RPATH
- "@loader_path/../../../SharedFrameworks"
- "@loader_path/../../System/Library/PrivateFrameworks"
- "@loader_path/../../Library/PrivateFrameworks"
- )
-endif()
+add_subdirectory(src-cpp)
diff --git a/lldb/tools/lldb-dap/LICENSE.TXT b/lldb/tools/lldb-dap/LICENSE.TXT
new file mode 100644
index 00000000000000..53bb2e7fbc7643
--- /dev/null
+++ b/lldb/tools/lldb-dap/LICENSE.TXT
@@ -0,0 +1,234 @@
+==============================================================================
+The LLVM Project is under the Apache License v2.0 with LLVM Exceptions:
+==============================================================================
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+
+---- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.
+
+==============================================================================
+Software from third parties included in the LLVM Project:
+==============================================================================
+The LLVM Project contains third party software which is under different license
+terms. All such code will be identified clearly using at least one of two
+mechanisms:
+1) It will be in a separate directory tree with its own `LICENSE.txt` or
+ `LICENSE` file at the top containing the specific license and restrictions
+ which apply to that software, or
+2) It will contain specific license and restriction terms at the top of every
+ file.
diff --git a/lldb/tools/lldb-dap/README.md b/lldb/tools/lldb-dap/README.md
index 00ceb0bedc40a4..22086b3ee22c04 100644
--- a/lldb/tools/lldb-dap/README.md
+++ b/lldb/tools/lldb-dap/README.md
@@ -4,6 +4,8 @@
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Installation for Visual Studio Code](#installation-for-visual-studio-code)
+- [Reinstalling for Visual Studio Code](#reinstalling-for-visual-studio-code)
+- [Formatting the Typescript code](#formatting-the-typescript-code)
- [Configurations](#configurations)
- [Launch Configuration Settings](#launch-configuration-settings)
- [Attaching Settings](#attaching-settings)
@@ -12,6 +14,8 @@
- [Attach using PID](#attach-using-pid)
- [Attach by Name](#attach-by-name)
- [Loading a Core File](#loading-a-core-file)
+ - [Connect to a Debug Server on the Current Machine](#connect-to-a-debug-server-on-the-current-machine)
+ - [Connect to a Debug Server on Another Machine](#connect-to-a-debug-server-on-another-machine)
- [Custom debugger commands](#custom-debugger-commands)
- [startDebugging](#startdebugging)
- [repl-mode](#repl-mode)
@@ -27,58 +31,43 @@ get a full featured debugger with a well defined protocol.
# Installation for Visual Studio Code
-Installing the plug-in involves creating a directory in any location outside of
-`~/.vscode/extensions`. For example, `~/vscode-lldb` is a valid one. You'll also
-need a subfolder `bin`, e.g. `~/vscode-lldb/bin`. Then copy the `package.json`
-file that is in the same directory as this documentation into it, and symlink
-the `lldb-dap` binary into the `bin` directory inside the plug-in directory.
+Installing the plug-in is very straightforward and involves just a few steps:
-Finally, on VS Code, execute the command
-`Developer: Install Extension from Location` and pick the folder you just
-created, which would be `~/vscode-lldb` following the example above.
-
-If you want to make a stand alone plug-in that you can send to others on UNIX
-systems:
+- Install a modern version of node (e.g. `v20.0.0`).
+- On VS Code, execute the command `Install 'code' command in PATH`. You need to
+ do it only once. This enables the command `code` in the PATH.
+- In the `lldb-dap` folder, package and install the extension:
```bash
-mkdir -p ~/llvm-org.lldb-dap-0.1.0/bin
-cp package.json ~/llvm-org.lldb-dap-0.1.0
-cd ~/llvm-org.lldb-dap-0.1.0/bin
-cp /path/to/a/built/lldb-dap .
-cp /path/to/a/built/liblldb.so .
+npm run package # This also compiles the extension.
+npm run install
```
-If you want to make a stand alone plug-in that you can send to others on macOS
-systems:
+- On VS Code, set the setting `lldb-dap.executable-path` to the path of your
+ local build of `lldb-dap`.
+
+And then you are ready!
+
+# Reinstalling for Visual Studio Code
+
+This step is also very straightforward, with the only caveat that after removing
+the old version of the extension, VS Code needs to be reloaded or restarted
+before installing the new version.
```bash
-mkdir -p ~/llvm-org.lldb-dap-0.1.0/bin
-cp package.json ...
[truncated]
``````````
</details>
https://github.com/llvm/llvm-project/pull/75515
More information about the lldb-commits
mailing list