gnh1201/wasm-micro-runtime
1
0
Fork 0
mirror of https://github.com/bytecodealliance/wasm-micro-runtime.git synced 2024-10-04 15:12:25 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Update document for source debugging (#2051)

Browse Source
This commit is contained in:
Xu Jun 2023-03-23 19:16:56 +08:00 committed by GitHub
parent d975a1a82c
commit 4c2d358980
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source_debugging.md
View File

@ -40,16 +40,29 @@ iwasm -g=127.0.0.1:1234 test.wasm
# Use port = 0 to allow a random assigned debug port # Use port = 0 to allow a random assigned debug port
``` ```
4. Build customized lldb (assume you have already cloned llvm) 4. Build customized lldb
``` bash ``` bash
cd ${WAMR_ROOT}/core/deps/llvm git clone --branch release/13.x --depth=1 https://github.com/llvm/llvm-project
git apply ../../../build-scripts/lldb-wasm.patch cd llvm-project
mkdir build-lldb && cd build-lldb git apply ${WAMR_ROOT}/build-scripts/lldb-wasm.patch
cmake -DCMAKE_BUILD_TYPE:STRING="Release" -DLLVM_ENABLE_PROJECTS="clang;lldb" -DLLVM_TARGETS_TO_BUILD:STRING="X86;WebAssembly" -DLLVM_ENABLE_LIBXML2:BOOL=ON ../llvm mkdir build-lldb
make -j $(nproc) cmake -S ./llvm -B build-lldb \
-G Ninja \
-DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;lldb" \
-DLLVM_TARGETS_TO_BUILD:STRING="X86;WebAssembly" \
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DLLVM_BUILD_BENCHMARKS:BOOL=OFF \
-DLLVM_BUILD_DOCS:BOOL=OFF -DLLVM_BUILD_EXAMPLES:BOOL=OFF \
-DLLVM_BUILD_LLVM_DYLIB:BOOL=OFF -DLLVM_BUILD_TESTS:BOOL=OFF \
-DLLVM_ENABLE_BINDINGS:BOOL=OFF -DLLVM_INCLUDE_BENCHMARKS:BOOL=OFF \
-DLLVM_INCLUDE_DOCS:BOOL=OFF -DLLVM_INCLUDE_EXAMPLES:BOOL=OFF \
-DLLVM_INCLUDE_TESTS:BOOL=OFF -DLLVM_ENABLE_LIBXML2:BOOL=ON
cmake --build build-lldb --target lldb --parallel $(nproc)
# The lldb is generated under build-lldb/bin/lldb
``` ```
> Note: If using `CommandLineTools` on MacOS, make sure only one SDK is present in `/Library/Developer/CommandLineTools/SDKs`. > Note: If using `CommandLineTools` on MacOS, make sure only one SDK is present in `/Library/Developer/CommandLineTools/SDKs`.
> You can download pre-built `wamr-lldb` binaries from [here](https://github.com/bytecodealliance/wasm-micro-runtime/releases).
5. Launch customized lldb and connect to iwasm 5. Launch customized lldb and connect to iwasm
``` bash ``` bash
lldb lldb
@ -57,8 +70,6 @@ lldb
``` ```
Then you can use lldb commands to debug your applications. Please refer to [lldb document](https://lldb.llvm.org/use/tutorial.html) for command usage. Then you can use lldb commands to debug your applications. Please refer to [lldb document](https://lldb.llvm.org/use/tutorial.html) for command usage.
> Known issue: `step over` on some function may be treated as `step in`, it will be fixed later.
## Debugging with AOT ## Debugging with AOT
> Note: AOT debugging is experimental and only a few debugging capabilities are supported. > Note: AOT debugging is experimental and only a few debugging capabilities are supported.