mirror of
https://github.com/NohamR/Reclass.git
synced 2026-05-10 19:59:21 +00:00
Compare commits
21 Commits
snapshot-2
...
snapshot-2
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
078a6028f0 | ||
|
|
67218d3e48 | ||
|
|
f651edd740 | ||
|
|
25aaace382 | ||
|
|
b5ddb042b8 | ||
|
|
e900dea836 | ||
|
|
b647a334bc | ||
|
|
fc390bc1f7 | ||
|
|
7efe740ec1 | ||
|
|
48409d1d38 | ||
|
|
df1435d9b7 | ||
|
|
5e11ff5496 | ||
|
|
22842d9801 | ||
|
|
50acde60cb | ||
|
|
1d7d384b93 | ||
|
|
3a76b03c85 | ||
|
|
ac94855d6c | ||
|
|
d65b6c5a29 | ||
|
|
d45ee9e4c9 | ||
|
|
31115014a5 | ||
|
|
8e88d588be |
76
.github/workflows/build.yml
vendored
76
.github/workflows/build.yml
vendored
@@ -18,61 +18,38 @@ jobs:
|
||||
with:
|
||||
submodules: recursive
|
||||
|
||||
- name: Install Qt6
|
||||
- name: Install Qt6 and MinGW
|
||||
uses: jurplel/install-qt-action@v4
|
||||
with:
|
||||
version: '6.8.1'
|
||||
arch: 'win64_mingw'
|
||||
tools: 'tools_mingw1310,qt.tools.win64_mingw1310'
|
||||
cache: true
|
||||
aqtversion: '==3.1.21'
|
||||
|
||||
- name: Configure
|
||||
shell: bash
|
||||
run: |
|
||||
export PATH="/c/mingw64/bin:$PATH"
|
||||
export PATH="$IQTA_TOOLS/mingw1310_64/bin:$PATH"
|
||||
gcc --version
|
||||
cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release -DBUILD_UI_TESTS=OFF \
|
||||
-DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++
|
||||
|
||||
- name: Build
|
||||
shell: bash
|
||||
run: |
|
||||
export PATH="/c/mingw64/bin:$PATH"
|
||||
export PATH="$IQTA_TOOLS/mingw1310_64/bin:$PATH"
|
||||
cmake --build build
|
||||
|
||||
- name: Test
|
||||
shell: bash
|
||||
run: |
|
||||
export PATH="/c/mingw64/bin:$PATH"
|
||||
export PATH="$IQTA_TOOLS/mingw1310_64/bin:$PATH"
|
||||
ctest --test-dir build --output-on-failure
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
if: always()
|
||||
with:
|
||||
name: Reclass-win64-qt6
|
||||
path: |
|
||||
build/Reclass.exe
|
||||
build/ReclassMcpBridge.exe
|
||||
build/Plugins/*.dll
|
||||
build/*.dll
|
||||
build/platforms/
|
||||
build/styles/
|
||||
build/imageformats/
|
||||
build/iconengines/
|
||||
build/themes/
|
||||
build/examples/
|
||||
build/screenshot.png
|
||||
|
||||
- name: Get date tag
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
id: date
|
||||
shell: bash
|
||||
run: echo "tag=$(date +'%d-%m-%Y')" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Package release zip
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
shell: bash
|
||||
run: |
|
||||
export PATH="$IQTA_TOOLS/mingw1310_64/bin:$PATH"
|
||||
mkdir -p release
|
||||
cp build/Reclass.exe release/
|
||||
cp build/ReclassMcpBridge.exe release/
|
||||
@@ -81,6 +58,7 @@ jobs:
|
||||
cp -r build/styles release/ 2>/dev/null || true
|
||||
cp -r build/imageformats release/ 2>/dev/null || true
|
||||
cp -r build/iconengines release/ 2>/dev/null || true
|
||||
windeployqt --no-translations --no-system-d3d-compiler --no-opengl-sw release/Reclass.exe
|
||||
mkdir -p release/Plugins
|
||||
cp build/Plugins/*.dll release/Plugins/ 2>/dev/null || true
|
||||
cp -r build/themes release/ 2>/dev/null || true
|
||||
@@ -88,19 +66,11 @@ jobs:
|
||||
cp build/screenshot.png release/ 2>/dev/null || true
|
||||
cd release && 7z a ../Reclass-win64-qt6.zip *
|
||||
|
||||
- name: Upload release asset
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
uses: softprops/action-gh-release@v2
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
tag_name: snapshot-${{ steps.date.outputs.tag }}
|
||||
name: Snapshot ${{ steps.date.outputs.tag }}
|
||||
body: |
|
||||
Automated snapshot from main branch.
|
||||
Commit: ${{ github.sha }}
|
||||
prerelease: false
|
||||
files: Reclass-win64-qt6.zip
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
name: Reclass-win64-qt6
|
||||
path: Reclass-win64-qt6.zip
|
||||
|
||||
linux:
|
||||
runs-on: ubuntu-22.04
|
||||
@@ -115,7 +85,6 @@ jobs:
|
||||
with:
|
||||
version: '6.8.1'
|
||||
cache: true
|
||||
aqtversion: '==3.1.21'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
@@ -167,19 +136,26 @@ jobs:
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
if: always()
|
||||
with:
|
||||
name: Reclass-linux64-qt6
|
||||
path: Reclass-linux64-qt6.AppImage
|
||||
|
||||
release:
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
needs: [windows, linux]
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Download artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: artifacts
|
||||
|
||||
- name: Get date tag
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
id: date
|
||||
shell: bash
|
||||
run: echo "tag=$(date +'%d-%m-%Y')" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Upload release asset
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
- name: Create release
|
||||
uses: softprops/action-gh-release@v2
|
||||
with:
|
||||
tag_name: snapshot-${{ steps.date.outputs.tag }}
|
||||
@@ -188,6 +164,8 @@ jobs:
|
||||
Automated snapshot from main branch.
|
||||
Commit: ${{ github.sha }}
|
||||
prerelease: false
|
||||
files: Reclass-linux64-qt6.AppImage
|
||||
files: |
|
||||
artifacts/Reclass-win64-qt6/Reclass-win64-qt6.zip
|
||||
artifacts/Reclass-linux64-qt6/Reclass-linux64-qt6.AppImage
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -11,3 +11,6 @@ build/
|
||||
*.suo
|
||||
.vs/
|
||||
CMakeUserPresets.json
|
||||
plugins/RcNetPluginCompatLayer/bridge/obj
|
||||
plugins/RcNetPluginCompatLayer/bridge/bin
|
||||
.cache
|
||||
|
||||
113
CMakeLists.txt
113
CMakeLists.txt
@@ -31,6 +31,15 @@ endif()
|
||||
|
||||
find_package(QScintilla REQUIRED)
|
||||
|
||||
# RawPDB — direct PDB file reader (no DIA SDK / msdia140.dll dependency)
|
||||
file(GLOB RAW_PDB_SRCS third_party/raw_pdb/src/*.cpp)
|
||||
add_library(raw_pdb STATIC ${RAW_PDB_SRCS})
|
||||
target_include_directories(raw_pdb PUBLIC third_party/raw_pdb/src)
|
||||
target_compile_features(raw_pdb PRIVATE cxx_std_11)
|
||||
if(WIN32)
|
||||
target_link_libraries(raw_pdb PRIVATE rpcrt4)
|
||||
endif()
|
||||
|
||||
add_executable(Reclass
|
||||
src/main.cpp
|
||||
src/editor.h
|
||||
@@ -60,12 +69,16 @@ add_executable(Reclass
|
||||
src/themes/thememanager.cpp
|
||||
src/themes/themeeditor.h
|
||||
src/themes/themeeditor.cpp
|
||||
src/import_reclass_xml.h
|
||||
src/import_reclass_xml.cpp
|
||||
src/import_source.h
|
||||
src/import_source.cpp
|
||||
src/export_reclass_xml.h
|
||||
src/export_reclass_xml.cpp
|
||||
src/imports/import_reclass_xml.h
|
||||
src/imports/import_reclass_xml.cpp
|
||||
src/imports/import_source.h
|
||||
src/imports/import_source.cpp
|
||||
src/imports/export_reclass_xml.h
|
||||
src/imports/export_reclass_xml.cpp
|
||||
src/imports/import_pdb.h
|
||||
src/imports/import_pdb.cpp
|
||||
src/imports/import_pdb_dialog.h
|
||||
src/imports/import_pdb_dialog.cpp
|
||||
src/mainwindow.h
|
||||
src/optionsdialog.h
|
||||
src/optionsdialog.cpp
|
||||
@@ -73,6 +86,8 @@ add_executable(Reclass
|
||||
src/titlebar.cpp
|
||||
src/mcp/mcp_bridge.h
|
||||
src/mcp/mcp_bridge.cpp
|
||||
src/addressparser.h
|
||||
src/addressparser.cpp
|
||||
src/disasm.h
|
||||
src/disasm.cpp
|
||||
third_party/fadec/decode.c
|
||||
@@ -92,7 +107,7 @@ target_link_libraries(Reclass PRIVATE
|
||||
${_QT_WINEXTRAS}
|
||||
)
|
||||
if(WIN32)
|
||||
target_link_libraries(Reclass PRIVATE dbghelp dwmapi psapi)
|
||||
target_link_libraries(Reclass PRIVATE dbghelp dwmapi psapi raw_pdb)
|
||||
endif()
|
||||
|
||||
add_executable(ReclassMcpBridge tools/rcx-mcp-stdio.cpp)
|
||||
@@ -154,17 +169,17 @@ if(BUILD_TESTING)
|
||||
|
||||
# ── Headless tests (Qt::Core only — safe for CI without a display) ──
|
||||
|
||||
add_executable(test_core tests/test_core.cpp src/format.cpp src/compose.cpp)
|
||||
add_executable(test_core tests/test_core.cpp src/format.cpp src/compose.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_core PRIVATE src)
|
||||
target_link_libraries(test_core PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_core COMMAND test_core)
|
||||
|
||||
add_executable(test_format tests/test_format.cpp src/format.cpp)
|
||||
add_executable(test_format tests/test_format.cpp src/format.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_format PRIVATE src)
|
||||
target_link_libraries(test_format PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_format COMMAND test_format)
|
||||
|
||||
add_executable(test_compose tests/test_compose.cpp src/compose.cpp src/format.cpp)
|
||||
add_executable(test_compose tests/test_compose.cpp src/compose.cpp src/format.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_compose PRIVATE src)
|
||||
target_link_libraries(test_compose PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_compose COMMAND test_compose)
|
||||
@@ -180,42 +195,63 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_command_row COMMAND test_command_row)
|
||||
|
||||
add_executable(test_generator tests/test_generator.cpp
|
||||
src/generator.cpp src/compose.cpp src/format.cpp)
|
||||
src/generator.cpp src/compose.cpp src/format.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_generator PRIVATE src)
|
||||
target_link_libraries(test_generator PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_generator COMMAND test_generator)
|
||||
|
||||
add_executable(test_import_xml tests/test_import_xml.cpp
|
||||
src/import_reclass_xml.cpp src/format.cpp src/compose.cpp)
|
||||
src/imports/import_reclass_xml.cpp src/format.cpp src/compose.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_import_xml PRIVATE src)
|
||||
target_link_libraries(test_import_xml PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_import_xml COMMAND test_import_xml)
|
||||
|
||||
add_executable(test_import_source tests/test_import_source.cpp
|
||||
src/import_source.cpp src/format.cpp src/compose.cpp)
|
||||
src/imports/import_source.cpp src/format.cpp src/compose.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_import_source PRIVATE src)
|
||||
target_link_libraries(test_import_source PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_import_source COMMAND test_import_source)
|
||||
|
||||
add_executable(test_export_xml tests/test_export_xml.cpp
|
||||
src/export_reclass_xml.cpp src/import_reclass_xml.cpp src/format.cpp src/compose.cpp)
|
||||
src/imports/export_reclass_xml.cpp src/imports/import_reclass_xml.cpp src/format.cpp src/compose.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_export_xml PRIVATE src)
|
||||
target_link_libraries(test_export_xml PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_export_xml COMMAND test_export_xml)
|
||||
|
||||
add_executable(test_disasm tests/test_disasm.cpp
|
||||
src/disasm.cpp src/compose.cpp src/format.cpp
|
||||
src/disasm.cpp src/compose.cpp src/format.cpp src/addressparser.cpp
|
||||
third_party/fadec/decode.c third_party/fadec/format.c)
|
||||
target_include_directories(test_disasm PRIVATE src third_party/fadec)
|
||||
target_link_libraries(test_disasm PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_disasm COMMAND test_disasm)
|
||||
|
||||
add_executable(test_addressparser tests/test_addressparser.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_addressparser PRIVATE src)
|
||||
target_link_libraries(test_addressparser PRIVATE ${QT}::Core ${QT}::Test)
|
||||
add_test(NAME test_addressparser COMMAND test_addressparser)
|
||||
|
||||
if(WIN32)
|
||||
add_executable(test_import_pdb tests/test_import_pdb.cpp
|
||||
src/imports/import_pdb.cpp src/format.cpp src/compose.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_import_pdb PRIVATE src)
|
||||
target_link_libraries(test_import_pdb PRIVATE
|
||||
${QT}::Core ${QT}::Test raw_pdb)
|
||||
add_test(NAME test_import_pdb COMMAND test_import_pdb)
|
||||
|
||||
add_executable(bench_import_pdb tests/bench_import_pdb.cpp
|
||||
src/imports/import_pdb.cpp src/format.cpp src/compose.cpp src/addressparser.cpp)
|
||||
target_include_directories(bench_import_pdb PRIVATE src)
|
||||
target_link_libraries(bench_import_pdb PRIVATE
|
||||
${QT}::Core ${QT}::Test raw_pdb)
|
||||
add_test(NAME bench_import_pdb COMMAND bench_import_pdb)
|
||||
endif()
|
||||
|
||||
# ── UI tests (require Qt::Widgets / QScintilla / display — skip on headless CI) ──
|
||||
option(BUILD_UI_TESTS "Build tests that require a display (Qt Widgets)" ON)
|
||||
if(BUILD_UI_TESTS)
|
||||
|
||||
add_executable(test_controller tests/test_controller.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/controller.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
@@ -229,7 +265,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_controller COMMAND test_controller)
|
||||
|
||||
add_executable(test_validation tests/test_validation.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/controller.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
@@ -243,7 +279,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_validation COMMAND test_validation)
|
||||
|
||||
add_executable(test_context_menu tests/test_context_menu.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/controller.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
@@ -257,7 +293,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_context_menu COMMAND test_context_menu)
|
||||
|
||||
add_executable(test_source_management tests/test_source_management.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/controller.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
@@ -271,7 +307,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_source_management COMMAND test_source_management)
|
||||
|
||||
add_executable(test_editor tests/test_editor.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp
|
||||
src/providerregistry.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
target_include_directories(test_editor PRIVATE src third_party/fadec)
|
||||
@@ -281,7 +317,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_editor COMMAND test_editor)
|
||||
|
||||
add_executable(test_rendered_view tests/test_rendered_view.cpp
|
||||
src/generator.cpp src/compose.cpp src/format.cpp)
|
||||
src/generator.cpp src/compose.cpp src/format.cpp src/addressparser.cpp)
|
||||
target_include_directories(test_rendered_view PRIVATE src)
|
||||
target_link_libraries(test_rendered_view PRIVATE
|
||||
${QT}::Widgets ${QT}::PrintSupport ${QT}::Test
|
||||
@@ -289,7 +325,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_rendered_view COMMAND test_rendered_view)
|
||||
|
||||
add_executable(test_new_features tests/test_new_features.cpp
|
||||
src/generator.cpp src/compose.cpp src/format.cpp src/controller.cpp
|
||||
src/generator.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/editor.cpp src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
@@ -303,7 +339,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_new_features COMMAND test_new_features)
|
||||
|
||||
add_executable(test_type_selector tests/test_type_selector.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/controller.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
@@ -317,7 +353,7 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_type_selector COMMAND test_type_selector)
|
||||
|
||||
add_executable(test_type_visibility tests/test_type_visibility.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/controller.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
@@ -336,6 +372,21 @@ if(BUILD_TESTING)
|
||||
target_link_libraries(test_options_dialog PRIVATE ${QT}::Widgets ${QT}::Test)
|
||||
add_test(NAME test_options_dialog COMMAND test_options_dialog)
|
||||
|
||||
add_executable(test_source_provider tests/test_source_provider.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp src/controller.cpp
|
||||
src/processpicker.cpp src/processpicker.ui src/providerregistry.cpp
|
||||
src/typeselectorpopup.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS}
|
||||
src/resources.qrc)
|
||||
target_include_directories(test_source_provider PRIVATE src third_party/fadec)
|
||||
target_link_libraries(test_source_provider PRIVATE
|
||||
${QT}::Widgets ${QT}::PrintSupport ${QT}::Concurrent ${QT}::Test ${QT}::Svg
|
||||
QScintilla::QScintilla)
|
||||
if(WIN32)
|
||||
target_link_libraries(test_source_provider PRIVATE dbghelp psapi ${_QT_WINEXTRAS})
|
||||
endif()
|
||||
add_test(NAME test_source_provider COMMAND test_source_provider)
|
||||
|
||||
if(WIN32)
|
||||
add_executable(test_windbg_provider tests/test_windbg_provider.cpp
|
||||
plugins/WinDbgMemory/WinDbgMemoryPlugin.cpp)
|
||||
@@ -345,6 +396,19 @@ if(BUILD_TESTING)
|
||||
add_test(NAME test_windbg_provider COMMAND test_windbg_provider)
|
||||
endif()
|
||||
|
||||
add_executable(bench_large_class tests/bench_large_class.cpp
|
||||
src/editor.cpp src/compose.cpp src/format.cpp src/addressparser.cpp
|
||||
src/providerregistry.cpp
|
||||
src/themes/theme.cpp src/themes/thememanager.cpp ${DISASM_SRCS})
|
||||
target_include_directories(bench_large_class PRIVATE src third_party/fadec)
|
||||
target_link_libraries(bench_large_class PRIVATE
|
||||
${QT}::Widgets ${QT}::PrintSupport ${QT}::Concurrent ${QT}::Test
|
||||
QScintilla::QScintilla)
|
||||
if(WIN32)
|
||||
target_link_libraries(bench_large_class PRIVATE dbghelp psapi ${_QT_WINEXTRAS})
|
||||
endif()
|
||||
add_test(NAME bench_large_class COMMAND bench_large_class)
|
||||
|
||||
# Deploy Qt runtime DLLs for tests (run windeployqt on a representative test exe
|
||||
# that links the broadest set of Qt modules; all test exes share the same output dir)
|
||||
if(TARGET ${QT}::windeployqt)
|
||||
@@ -361,6 +425,7 @@ if(BUILD_TESTING)
|
||||
endif() # BUILD_UI_TESTS
|
||||
endif()
|
||||
add_subdirectory(plugins/ProcessMemory)
|
||||
add_subdirectory(plugins/RemoteProcessMemory)
|
||||
if(WIN32)
|
||||
add_subdirectory(plugins/WinDbgMemory)
|
||||
add_subdirectory(plugins/RcNetPluginCompatLayer)
|
||||
|
||||
117
README.md
117
README.md
@@ -1,4 +1,53 @@
|
||||
This tool helps you inspect raw bytes and interpret them as types (structs, arrays, primitives, pointers, padding) instead of just hex. It is essentially a debugging tool for figuring out unknown data structures either runtime or from some static source.
|
||||
<div align="center">
|
||||
|
||||
# Reclass
|
||||
|
||||
**A structured binary editor for reverse engineering — inspect raw bytes as typed structs, arrays, and pointers.<p>A complete overhaul of the popular "reclassing" tools**
|
||||
|
||||
[Download](https://github.com/IChooseYou/Reclass/releases) · [Build Instructions](#build) · [MCP Integration](#mcp-integration) · [Alternatives](#alternatives)
|
||||
|
||||
[](https://github.com/IChooseYou/Reclass/actions/workflows/build.yml)
|
||||
[](LICENSE)
|
||||
[](https://github.com/IChooseYou/Reclass/releases)
|
||||
[]()
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
Reclass helps you inspect raw bytes and interpret them as types (structs, arrays, primitives, pointers, padding) instead of just hex. It is essentially a debugging tool for figuring out unknown data structures — either at runtime from a live process, or from a static source like a binary file or crash dump.
|
||||
|
||||
Built with C++17, Qt 6, and QScintilla. The entire editor surface is rendered as formatted plain text with inline editing, fold markers, and hex/ASCII previews.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- **Structured binary view** — render raw bytes as typed fields (integers, floats, pointers, vectors, matrices, strings, booleans, padding)
|
||||
- **Struct & array nesting** — define nested structs and arrays with collapsible fold regions
|
||||
- **Inline editing** — click to edit type names, field names, values, and base addresses directly in the editor
|
||||
- **Undo/redo** — full undo history for all mutations via command stack
|
||||
- **Split views** — multiple synchronized editor panes over the same document
|
||||
- **Type autocomplete** — popup type picker when changing field kinds
|
||||
- **Hex + ASCII margins** — raw byte previews alongside the structured view
|
||||
- **MCP bridge** — expose all tool functionality to AI clients via Model Context Protocol
|
||||
- **Plugin system** — extend with custom data source providers via DLL plugins; following ship by default
|
||||
- **Process plugin** — access memory of live processes on Windows and Linux
|
||||
- **WinDbg plugin** — access data sources live in WinDbg debugging sessions
|
||||
- **ReClass.NET compatibility layer** — load existing .NET and native ReClass.NET plugins
|
||||
|
||||
---
|
||||
|
||||
## Data Sources
|
||||
|
||||
- **File** — open any binary file and inspect its contents as structured data
|
||||
- **Process** — attach to a live process and read its memory in real time
|
||||
- **Remote Process** — read another process's memory via shared memory
|
||||
- **WinDbg** — load `.dmp` crash dump files or connect to live debugging sessions
|
||||
|
||||
---
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||
|
||||
@@ -6,15 +55,12 @@ This tool helps you inspect raw bytes and interpret them as types (structs, arra
|
||||
|
||||

|
||||
|
||||
## Data Sources
|
||||
|
||||
- **File** — open any binary file and inspect its contents as structured data
|
||||
- **Process** — attach to a live process and read its memory in real time
|
||||
- **WinDbg** — load `.dmp` crash dump files or connect to live debugging sessions
|
||||
---
|
||||
|
||||
## MCP Integration
|
||||
|
||||
Built-in [Model Context Protocol](https://modelcontextprotocol.io/) bridge via `ReclassMcpBridge`. The server does not start by default and can be toggled from the File menu. It exposes all tool functionality to any MCP-compatible client (e.g. Claude Code) and falls back to UI prompts when the client requests something not yet covered by tools. To connect, add this to your MCP client config (e.g. `.mcp.json`):
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
@@ -25,31 +71,54 @@ Built-in [Model Context Protocol](https://modelcontextprotocol.io/) bridge via `
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Build
|
||||
|
||||
1. Prerequisites
|
||||
### Prerequisites
|
||||
|
||||
- Qt 6 with MinGW - Qt Online Installer https://doc.qt.io/qt-6/qt-online-installation.html , note to select MinGW kit + CMake/Ninja from Tools section (online installers index: https://download.qt.io/official_releases/online_installers/)
|
||||
- CMake 3.20+ - https://cmake.org/download/ - bundled with Qt
|
||||
- windeployqt docs - https://doc.qt.io/qt-6/windows-deployment.html
|
||||
- **Qt 6** with MinGW — [Qt Online Installer](https://doc.qt.io/qt-6/qt-online-installation.html) (select MinGW kit + CMake/Ninja from the Tools section)
|
||||
- **CMake 3.20+** — [cmake.org](https://cmake.org/download/) (bundled with Qt)
|
||||
- **Ninja** — bundled with the Qt installer
|
||||
|
||||
2. Quick Build (relies on powershell| for manual build skip to step 3)
|
||||
### Quick Build
|
||||
|
||||
git clone --recurse-submodules https://github.com/IChooseYou/Reclass.git
|
||||
cd Reclass
|
||||
.\scripts\build_qscintilla.ps1
|
||||
.\scripts\build.ps1
|
||||
^ script above tries to autodetect Qt install (as we learned not everyone installs to C:/Qt/)
|
||||
```bash
|
||||
git clone --recurse-submodules https://github.com/IChooseYou/Reclass.git
|
||||
cd Reclass
|
||||
.\scripts\build_qscintilla.ps1
|
||||
.\scripts\build.ps1
|
||||
```
|
||||
|
||||
3. Manual Build
|
||||
The build script auto-detects your Qt install location.
|
||||
|
||||
Step by step for peoplewho want to run commands themselves:
|
||||
1. Clone with --recurse-submodules (+ fallback git submodule update --init --recursive)
|
||||
2. Build QScintilla: qmake + mingw32-make in third_party/qscintilla/src
|
||||
3. CMake configure + build with -DCMAKE_PREFIX_PATH
|
||||
4. optionallly windeployqt the exe
|
||||
### Manual Build
|
||||
|
||||
1. Clone with `--recurse-submodules` (or run `git submodule update --init --recursive` after cloning)
|
||||
2. Build QScintilla: `qmake` + `mingw32-make` in `third_party/qscintilla/src`
|
||||
3. Configure and build:
|
||||
```bash
|
||||
cmake -B build -G Ninja -DCMAKE_PREFIX_PATH=/path/to/Qt/6.x.x/mingw_64
|
||||
cmake --build build
|
||||
```
|
||||
4. Optionally run `windeployqt` on the output executable
|
||||
|
||||
### Running Tests
|
||||
|
||||
```bash
|
||||
ctest --test-dir build --output-on-failure
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Alternatives
|
||||
|
||||
- ReClass.NET (reclass.net) - https://github.com/ReClassNET/ReClass.NET
|
||||
- ReClassEx - https://github.com/ajkhoury/ReClassEx
|
||||
- [ReClass.NET](https://github.com/ReClassNET/ReClass.NET)
|
||||
- [ReClassEx](https://github.com/ajkhoury/ReClassEx)
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<sub>MIT License</sub>
|
||||
</div>
|
||||
|
||||
@@ -284,6 +284,15 @@ void ProcessMemoryProvider::cacheModules()
|
||||
|
||||
#endif // platform
|
||||
|
||||
uint64_t ProcessMemoryProvider::symbolToAddress(const QString& name) const
|
||||
{
|
||||
for (const auto& mod : m_modules) {
|
||||
if (mod.name.compare(name, Qt::CaseInsensitive) == 0)
|
||||
return mod.base;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
ProcessMemoryProvider::~ProcessMemoryProvider()
|
||||
{
|
||||
#ifdef _WIN32
|
||||
|
||||
@@ -24,6 +24,7 @@ public:
|
||||
QString name() const override { return m_processName; }
|
||||
QString kind() const override { return QStringLiteral("LocalProcess"); }
|
||||
QString getSymbol(uint64_t addr) const override;
|
||||
uint64_t symbolToAddress(const QString& name) const override;
|
||||
|
||||
bool isLive() const override { return true; }
|
||||
uint64_t base() const override { return m_base; }
|
||||
|
||||
@@ -74,6 +74,15 @@ QString RcNetCompatProvider::getSymbol(uint64_t addr) const
|
||||
return {};
|
||||
}
|
||||
|
||||
uint64_t RcNetCompatProvider::symbolToAddress(const QString& name) const
|
||||
{
|
||||
for (const auto& mod : m_modules) {
|
||||
if (mod.name.compare(name, Qt::CaseInsensitive) == 0)
|
||||
return mod.base;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
// -- Module enumeration ---------------------------------------------------
|
||||
|
||||
namespace {
|
||||
|
||||
@@ -28,6 +28,7 @@ public:
|
||||
bool isLive() const override { return true; }
|
||||
uint64_t base() const override { return m_base; }
|
||||
QString getSymbol(uint64_t addr) const override;
|
||||
uint64_t symbolToAddress(const QString& name) const override;
|
||||
|
||||
struct ModuleInfo {
|
||||
QString name;
|
||||
|
||||
124
plugins/RemoteProcessMemory/CMakeLists.txt
Normal file
124
plugins/RemoteProcessMemory/CMakeLists.txt
Normal file
@@ -0,0 +1,124 @@
|
||||
cmake_minimum_required(VERSION 3.20)
|
||||
project(RemoteProcessMemory LANGUAGES CXX)
|
||||
|
||||
set(CMAKE_CXX_STANDARD 17)
|
||||
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
||||
|
||||
# Qt is found by the parent project; QT variable (Qt5 or Qt6) is inherited
|
||||
set(CMAKE_AUTOMOC ON)
|
||||
set(CMAKE_AUTORCC ON)
|
||||
set(CMAKE_AUTOUIC OFF) # run uic manually to avoid dupbuild with ProcessMemoryPlugin
|
||||
|
||||
# ─── 1. Payload DLL/SO (no Qt, minimal dependencies) ────────────────
|
||||
|
||||
add_library(rcx_payload SHARED
|
||||
payload/rcx_payload.cpp
|
||||
rcx_rpc_protocol.h
|
||||
)
|
||||
|
||||
set_target_properties(rcx_payload PROPERTIES PREFIX "") # rcx_payload.dll / rcx_payload.so
|
||||
|
||||
target_include_directories(rcx_payload PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
|
||||
|
||||
if(WIN32)
|
||||
target_link_libraries(rcx_payload PRIVATE psapi)
|
||||
else()
|
||||
target_link_libraries(rcx_payload PRIVATE pthread rt)
|
||||
target_compile_options(rcx_payload PRIVATE -fvisibility=hidden)
|
||||
endif()
|
||||
|
||||
# Output payload to Plugins/ (same dir as plugin DLL, discovered at runtime)
|
||||
set_target_properties(rcx_payload PROPERTIES
|
||||
LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Plugins"
|
||||
RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Plugins"
|
||||
)
|
||||
|
||||
# Install rule: copy both DLLs to install Plugins/ folder
|
||||
install(TARGETS rcx_payload
|
||||
LIBRARY DESTINATION Plugins
|
||||
RUNTIME DESTINATION Plugins
|
||||
)
|
||||
|
||||
# ─── 2. Plugin DLL (Qt, implements IProviderPlugin) ──────────────────
|
||||
|
||||
# Generate ui_processpicker.h in our own build dir (avoids dupbuild with ProcessMemoryPlugin)
|
||||
set(_UI_SRC "${CMAKE_CURRENT_SOURCE_DIR}/../../src/processpicker.ui")
|
||||
set(_UI_HDR "${CMAKE_CURRENT_BINARY_DIR}/ui_processpicker.h")
|
||||
|
||||
add_custom_command(
|
||||
OUTPUT "${_UI_HDR}"
|
||||
COMMAND ${QT}::uic -o "${_UI_HDR}" "${_UI_SRC}"
|
||||
DEPENDS "${_UI_SRC}"
|
||||
COMMENT "UIC processpicker.ui (RemoteProcessMemory)"
|
||||
VERBATIM
|
||||
)
|
||||
|
||||
set(PLUGIN_SOURCES
|
||||
RemoteProcessMemoryPlugin.h
|
||||
RemoteProcessMemoryPlugin.cpp
|
||||
rcx_rpc_protocol.h
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/../../src/processpicker.h
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/../../src/processpicker.cpp
|
||||
"${_UI_HDR}"
|
||||
)
|
||||
|
||||
add_library(RemoteProcessMemoryPlugin SHARED ${PLUGIN_SOURCES})
|
||||
|
||||
target_link_libraries(RemoteProcessMemoryPlugin PRIVATE
|
||||
${QT}::Widgets
|
||||
${_QT_WINEXTRAS}
|
||||
)
|
||||
|
||||
if(WIN32)
|
||||
target_link_libraries(RemoteProcessMemoryPlugin PRIVATE psapi shell32)
|
||||
else()
|
||||
target_link_libraries(RemoteProcessMemoryPlugin PRIVATE rt dl)
|
||||
target_compile_options(RemoteProcessMemoryPlugin PRIVATE -fvisibility=hidden)
|
||||
endif()
|
||||
|
||||
target_include_directories(RemoteProcessMemoryPlugin PRIVATE
|
||||
${CMAKE_CURRENT_SOURCE_DIR}/../../src
|
||||
${CMAKE_CURRENT_SOURCE_DIR}
|
||||
${CMAKE_CURRENT_BINARY_DIR} # for ui_processpicker.h
|
||||
)
|
||||
|
||||
set_target_properties(RemoteProcessMemoryPlugin PROPERTIES
|
||||
LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Plugins"
|
||||
RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Plugins"
|
||||
)
|
||||
|
||||
install(TARGETS RemoteProcessMemoryPlugin
|
||||
LIBRARY DESTINATION Plugins
|
||||
RUNTIME DESTINATION Plugins
|
||||
)
|
||||
|
||||
# Plugin must be able to find the payload at runtime
|
||||
add_dependencies(RemoteProcessMemoryPlugin rcx_payload)
|
||||
|
||||
# ─── 3. Test executables (no Qt) ────────────────────────────────────
|
||||
|
||||
# Host: loads payload in-process, exposes test buffer
|
||||
add_executable(test_rpc_host tests/test_rpc_host.cpp)
|
||||
target_include_directories(test_rpc_host PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
|
||||
if(WIN32)
|
||||
target_link_libraries(test_rpc_host PRIVATE psapi)
|
||||
else()
|
||||
target_link_libraries(test_rpc_host PRIVATE pthread rt dl)
|
||||
endif()
|
||||
set_target_properties(test_rpc_host PROPERTIES
|
||||
RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Plugins"
|
||||
)
|
||||
add_dependencies(test_rpc_host rcx_payload)
|
||||
|
||||
# Client: connects to host, tests + benchmarks
|
||||
add_executable(test_rpc_client tests/test_rpc_client.cpp)
|
||||
target_include_directories(test_rpc_client PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
|
||||
if(WIN32)
|
||||
target_link_libraries(test_rpc_client PRIVATE psapi)
|
||||
else()
|
||||
target_link_libraries(test_rpc_client PRIVATE pthread rt)
|
||||
endif()
|
||||
set_target_properties(test_rpc_client PROPERTIES
|
||||
RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/Plugins"
|
||||
)
|
||||
add_dependencies(test_rpc_client test_rpc_host)
|
||||
927
plugins/RemoteProcessMemory/RemoteProcessMemoryPlugin.cpp
Normal file
927
plugins/RemoteProcessMemory/RemoteProcessMemoryPlugin.cpp
Normal file
@@ -0,0 +1,927 @@
|
||||
#include "RemoteProcessMemoryPlugin.h"
|
||||
#include "rcx_rpc_protocol.h"
|
||||
#include "../../src/processpicker.h"
|
||||
|
||||
#include <QStyle>
|
||||
#include <QApplication>
|
||||
#include <QMessageBox>
|
||||
#include <QPushButton>
|
||||
#include <QDir>
|
||||
#include <QFileInfo>
|
||||
#include <QPixmap>
|
||||
#include <QImage>
|
||||
|
||||
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0) && defined(_WIN32)
|
||||
#include <QtWin>
|
||||
#endif
|
||||
|
||||
#ifdef _WIN32
|
||||
# define WIN32_LEAN_AND_MEAN
|
||||
# include <windows.h>
|
||||
# include <tlhelp32.h>
|
||||
# include <psapi.h>
|
||||
# include <shellapi.h>
|
||||
#else
|
||||
# include <unistd.h>
|
||||
# include <fcntl.h>
|
||||
# include <dlfcn.h>
|
||||
# include <sys/mman.h>
|
||||
# include <sys/wait.h>
|
||||
# include <sys/ptrace.h>
|
||||
# include <sys/user.h>
|
||||
# include <semaphore.h>
|
||||
# include <signal.h>
|
||||
# include <link.h>
|
||||
# include <climits>
|
||||
# include <cstring>
|
||||
# include <fstream>
|
||||
# include <sstream>
|
||||
#endif
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* IPC Client
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
struct IpcClient {
|
||||
#ifdef _WIN32
|
||||
HANDLE hShm = nullptr;
|
||||
HANDLE hReqEvent = nullptr;
|
||||
HANDLE hRspEvent = nullptr;
|
||||
#else
|
||||
int shmFd = -1;
|
||||
sem_t* reqSem = SEM_FAILED;
|
||||
sem_t* rspSem = SEM_FAILED;
|
||||
char shmNameBuf[128] = {};
|
||||
char reqNameBuf[128] = {};
|
||||
char rspNameBuf[128] = {};
|
||||
#endif
|
||||
void* mappedView = nullptr;
|
||||
QMutex mutex;
|
||||
bool connected = false;
|
||||
|
||||
~IpcClient() { disconnect(); }
|
||||
|
||||
/* ── connect / disconnect ──────────────────────────────────────── */
|
||||
|
||||
bool connect(uint32_t pid, int timeoutMs = 5000)
|
||||
{
|
||||
char shmName[128], reqName[128], rspName[128];
|
||||
rcx_rpc_shm_name(shmName, sizeof(shmName), pid);
|
||||
rcx_rpc_req_name(reqName, sizeof(reqName), pid);
|
||||
rcx_rpc_rsp_name(rspName, sizeof(rspName), pid);
|
||||
|
||||
#ifdef _WIN32
|
||||
/* poll for shared memory to appear (payload creating it) */
|
||||
auto deadline = GetTickCount64() + (uint64_t)timeoutMs;
|
||||
while (!(hShm = OpenFileMappingA(FILE_MAP_ALL_ACCESS, FALSE, shmName))) {
|
||||
if (GetTickCount64() >= deadline) return false;
|
||||
Sleep(10);
|
||||
}
|
||||
|
||||
mappedView = MapViewOfFile(hShm, FILE_MAP_ALL_ACCESS, 0, 0, RCX_RPC_SHM_SIZE);
|
||||
if (!mappedView) { CloseHandle(hShm); hShm = nullptr; return false; }
|
||||
|
||||
hReqEvent = OpenEventA(EVENT_ALL_ACCESS, FALSE, reqName);
|
||||
hRspEvent = OpenEventA(EVENT_ALL_ACCESS, FALSE, rspName);
|
||||
if (!hReqEvent || !hRspEvent) { disconnect(); return false; }
|
||||
#else
|
||||
strncpy(shmNameBuf, shmName, sizeof(shmNameBuf) - 1);
|
||||
strncpy(reqNameBuf, reqName, sizeof(reqNameBuf) - 1);
|
||||
strncpy(rspNameBuf, rspName, sizeof(rspNameBuf) - 1);
|
||||
|
||||
/* poll for shared memory */
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
while (true) {
|
||||
shmFd = shm_open(shmName, O_RDWR, 0);
|
||||
if (shmFd >= 0) break;
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start).count();
|
||||
if (elapsed >= timeoutMs) return false;
|
||||
usleep(10000);
|
||||
}
|
||||
|
||||
mappedView = mmap(nullptr, RCX_RPC_SHM_SIZE, PROT_READ | PROT_WRITE,
|
||||
MAP_SHARED, shmFd, 0);
|
||||
if (mappedView == MAP_FAILED) { mappedView = nullptr; close(shmFd); shmFd = -1; return false; }
|
||||
|
||||
reqSem = sem_open(reqName, 0);
|
||||
rspSem = sem_open(rspName, 0);
|
||||
if (reqSem == SEM_FAILED || rspSem == SEM_FAILED) { disconnect(); return false; }
|
||||
#endif
|
||||
|
||||
/* wait for payloadReady */
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(mappedView);
|
||||
#ifdef _WIN32
|
||||
while (!hdr->payloadReady) {
|
||||
if (GetTickCount64() >= deadline) { disconnect(); return false; }
|
||||
Sleep(5);
|
||||
}
|
||||
#else
|
||||
while (!__atomic_load_n(&hdr->payloadReady, __ATOMIC_ACQUIRE)) {
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start).count();
|
||||
if (elapsed >= timeoutMs) { disconnect(); return false; }
|
||||
usleep(5000);
|
||||
}
|
||||
#endif
|
||||
|
||||
connected = true;
|
||||
return true;
|
||||
}
|
||||
|
||||
void disconnect()
|
||||
{
|
||||
#ifdef _WIN32
|
||||
if (mappedView) { UnmapViewOfFile(mappedView); mappedView = nullptr; }
|
||||
if (hShm) { CloseHandle(hShm); hShm = nullptr; }
|
||||
if (hReqEvent) { CloseHandle(hReqEvent); hReqEvent = nullptr; }
|
||||
if (hRspEvent) { CloseHandle(hRspEvent); hRspEvent = nullptr; }
|
||||
#else
|
||||
if (mappedView) { munmap(mappedView, RCX_RPC_SHM_SIZE); mappedView = nullptr; }
|
||||
if (shmFd >= 0) { close(shmFd); shmFd = -1; }
|
||||
if (reqSem != SEM_FAILED) { sem_close(reqSem); reqSem = SEM_FAILED; }
|
||||
if (rspSem != SEM_FAILED) { sem_close(rspSem); rspSem = SEM_FAILED; }
|
||||
#endif
|
||||
connected = false;
|
||||
}
|
||||
|
||||
/* ── low-level RPC round-trip ──────────────────────────────────── */
|
||||
|
||||
bool signalAndWait(int timeoutMs = 2000)
|
||||
{
|
||||
#ifdef _WIN32
|
||||
SetEvent(hReqEvent);
|
||||
return WaitForSingleObject(hRspEvent, (DWORD)timeoutMs) == WAIT_OBJECT_0;
|
||||
#else
|
||||
sem_post(reqSem);
|
||||
struct timespec ts;
|
||||
clock_gettime(CLOCK_REALTIME, &ts);
|
||||
ts.tv_sec += timeoutMs / 1000;
|
||||
ts.tv_nsec += (timeoutMs % 1000) * 1000000L;
|
||||
if (ts.tv_nsec >= 1000000000L) { ts.tv_sec++; ts.tv_nsec -= 1000000000L; }
|
||||
return sem_timedwait(rspSem, &ts) == 0;
|
||||
#endif
|
||||
}
|
||||
|
||||
/* ── public API ────────────────────────────────────────────────── */
|
||||
|
||||
bool readSingle(uint64_t addr, void* buf, int len)
|
||||
{
|
||||
QMutexLocker lock(&mutex);
|
||||
if (!connected || len <= 0) return false;
|
||||
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(mappedView);
|
||||
auto* data = static_cast<uint8_t*>(mappedView) + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->command = RPC_CMD_READ_BATCH;
|
||||
hdr->requestCount = 1;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
auto* entry = reinterpret_cast<RcxRpcReadEntry*>(data);
|
||||
entry->address = addr;
|
||||
entry->length = (uint32_t)len;
|
||||
entry->dataOffset = sizeof(RcxRpcReadEntry);
|
||||
|
||||
if (!signalAndWait()) { connected = false; return false; }
|
||||
|
||||
memcpy(buf, data + entry->dataOffset, len);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool writeSingle(uint64_t addr, const void* buf, int len)
|
||||
{
|
||||
QMutexLocker lock(&mutex);
|
||||
if (!connected || len <= 0) return false;
|
||||
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(mappedView);
|
||||
auto* data = static_cast<uint8_t*>(mappedView) + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->command = RPC_CMD_WRITE;
|
||||
hdr->writeAddress = addr;
|
||||
hdr->writeLength = (uint32_t)len;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
memcpy(data, buf, len);
|
||||
|
||||
if (!signalAndWait()) { connected = false; return false; }
|
||||
|
||||
return hdr->status == RCX_RPC_STATUS_OK;
|
||||
}
|
||||
|
||||
QVector<RemoteProcessProvider::ModuleInfo> enumerateModules()
|
||||
{
|
||||
QVector<RemoteProcessProvider::ModuleInfo> result;
|
||||
QMutexLocker lock(&mutex);
|
||||
if (!connected) return result;
|
||||
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(mappedView);
|
||||
auto* data = static_cast<uint8_t*>(mappedView) + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->command = RPC_CMD_ENUM_MODULES;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
if (!signalAndWait()) { connected = false; return result; }
|
||||
if (hdr->status != RCX_RPC_STATUS_OK) return result;
|
||||
|
||||
uint32_t count = hdr->responseCount;
|
||||
result.reserve((int)count);
|
||||
|
||||
for (uint32_t i = 0; i < count; ++i) {
|
||||
auto* entry = reinterpret_cast<const RcxRpcModuleEntry*>(
|
||||
data + i * sizeof(RcxRpcModuleEntry));
|
||||
|
||||
QString modName;
|
||||
#ifdef _WIN32
|
||||
modName = QString::fromWCharArray(
|
||||
reinterpret_cast<const wchar_t*>(data + entry->nameOffset),
|
||||
(int)(entry->nameLength / sizeof(wchar_t)));
|
||||
#else
|
||||
modName = QString::fromUtf8(
|
||||
reinterpret_cast<const char*>(data + entry->nameOffset),
|
||||
(int)entry->nameLength);
|
||||
#endif
|
||||
result.append({modName, entry->base, entry->size});
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
bool ping()
|
||||
{
|
||||
QMutexLocker lock(&mutex);
|
||||
if (!connected) return false;
|
||||
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(mappedView);
|
||||
hdr->command = RPC_CMD_PING;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
if (!signalAndWait()) { connected = false; return false; }
|
||||
return true;
|
||||
}
|
||||
|
||||
void shutdown()
|
||||
{
|
||||
QMutexLocker lock(&mutex);
|
||||
if (!connected) return;
|
||||
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(mappedView);
|
||||
hdr->command = RPC_CMD_SHUTDOWN;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
signalAndWait(500);
|
||||
connected = false;
|
||||
}
|
||||
};
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* RemoteProcessProvider
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
RemoteProcessProvider::RemoteProcessProvider(
|
||||
uint32_t pid, const QString& processName,
|
||||
std::shared_ptr<IpcClient> ipc)
|
||||
: m_pid(pid)
|
||||
, m_processName(processName)
|
||||
, m_connected(ipc && ipc->connected)
|
||||
, m_base(0)
|
||||
, m_ipc(std::move(ipc))
|
||||
{
|
||||
if (m_connected)
|
||||
cacheModules();
|
||||
}
|
||||
|
||||
RemoteProcessProvider::~RemoteProcessProvider() = default;
|
||||
|
||||
bool RemoteProcessProvider::read(uint64_t addr, void* buf, int len) const
|
||||
{
|
||||
if (!m_connected || len <= 0) return false;
|
||||
bool ok = m_ipc->readSingle(addr, buf, len);
|
||||
if (!ok) {
|
||||
memset(buf, 0, (size_t)len);
|
||||
/* update connectivity flag through mutable ipc */
|
||||
const_cast<RemoteProcessProvider*>(this)->m_connected = m_ipc->connected;
|
||||
}
|
||||
return ok;
|
||||
}
|
||||
|
||||
int RemoteProcessProvider::size() const
|
||||
{
|
||||
return m_connected ? 0x10000 : 0;
|
||||
}
|
||||
|
||||
bool RemoteProcessProvider::write(uint64_t addr, const void* buf, int len)
|
||||
{
|
||||
if (!m_connected || len <= 0) return false;
|
||||
bool ok = m_ipc->writeSingle(addr, buf, len);
|
||||
if (!ok) m_connected = m_ipc->connected;
|
||||
return ok;
|
||||
}
|
||||
|
||||
QString RemoteProcessProvider::getSymbol(uint64_t addr) const
|
||||
{
|
||||
for (const auto& mod : m_modules) {
|
||||
if (addr >= mod.base && addr < mod.base + mod.size) {
|
||||
uint64_t off = addr - mod.base;
|
||||
return QStringLiteral("%1+0x%2")
|
||||
.arg(mod.name)
|
||||
.arg(off, 0, 16, QChar('0'));
|
||||
}
|
||||
}
|
||||
return {};
|
||||
}
|
||||
|
||||
uint64_t RemoteProcessProvider::symbolToAddress(const QString& n) const
|
||||
{
|
||||
for (const auto& mod : m_modules) {
|
||||
if (mod.name.compare(n, Qt::CaseInsensitive) == 0)
|
||||
return mod.base;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
void RemoteProcessProvider::cacheModules()
|
||||
{
|
||||
m_modules = m_ipc->enumerateModules();
|
||||
if (!m_modules.isEmpty())
|
||||
m_base = m_modules.first().base;
|
||||
}
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* Injection helpers
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
namespace {
|
||||
|
||||
/* Resolve payload DLL/SO path next to this plugin DLL/SO */
|
||||
static QString payloadPath()
|
||||
{
|
||||
#ifdef _WIN32
|
||||
HMODULE hSelf = nullptr;
|
||||
GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS |
|
||||
GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
|
||||
reinterpret_cast<LPCWSTR>(&payloadPath), &hSelf);
|
||||
WCHAR buf[MAX_PATH];
|
||||
GetModuleFileNameW(hSelf, buf, MAX_PATH);
|
||||
QFileInfo fi(QString::fromWCharArray(buf));
|
||||
return fi.absolutePath() + QStringLiteral("/rcx_payload.dll");
|
||||
#else
|
||||
Dl_info info;
|
||||
dladdr(reinterpret_cast<void*>(&payloadPath), &info);
|
||||
QFileInfo fi(QString::fromUtf8(info.dli_fname));
|
||||
return fi.absolutePath() + QStringLiteral("/rcx_payload.so");
|
||||
#endif
|
||||
}
|
||||
|
||||
#ifdef _WIN32
|
||||
/* ── Windows injection: CreateRemoteThread + LoadLibraryA ─────────── */
|
||||
|
||||
static bool injectPayload(uint32_t pid, QString* errorMsg)
|
||||
{
|
||||
QString path = payloadPath();
|
||||
QByteArray pathUtf8 = QDir::toNativeSeparators(path).toLocal8Bit();
|
||||
|
||||
HANDLE hProc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid);
|
||||
if (!hProc) {
|
||||
if (errorMsg)
|
||||
*errorMsg = QStringLiteral("OpenProcess failed (error %1).\n"
|
||||
"Try running as Administrator.")
|
||||
.arg(GetLastError());
|
||||
return false;
|
||||
}
|
||||
|
||||
/* allocate + write path string in target */
|
||||
SIZE_T pathLen = (SIZE_T)(pathUtf8.size() + 1);
|
||||
void* remotePath = VirtualAllocEx(hProc, nullptr, pathLen,
|
||||
MEM_COMMIT | MEM_RESERVE, PAGE_READWRITE);
|
||||
if (!remotePath) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("VirtualAllocEx failed.");
|
||||
CloseHandle(hProc);
|
||||
return false;
|
||||
}
|
||||
|
||||
WriteProcessMemory(hProc, remotePath, pathUtf8.constData(), pathLen, nullptr);
|
||||
|
||||
/* Step 1: LoadLibraryA — loads the DLL (DllMain is minimal) */
|
||||
HMODULE hK32 = GetModuleHandleA("kernel32.dll");
|
||||
auto pLoadLib = reinterpret_cast<LPTHREAD_START_ROUTINE>(
|
||||
GetProcAddress(hK32, "LoadLibraryA"));
|
||||
|
||||
HANDLE hThread = CreateRemoteThread(hProc, nullptr, 0,
|
||||
pLoadLib, remotePath, 0, nullptr);
|
||||
if (!hThread) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("CreateRemoteThread failed (error %1).")
|
||||
.arg(GetLastError());
|
||||
VirtualFreeEx(hProc, remotePath, 0, MEM_RELEASE);
|
||||
CloseHandle(hProc);
|
||||
return false;
|
||||
}
|
||||
|
||||
WaitForSingleObject(hThread, 10000);
|
||||
|
||||
DWORD exitCode = 0;
|
||||
GetExitCodeThread(hThread, &exitCode);
|
||||
CloseHandle(hThread);
|
||||
|
||||
VirtualFreeEx(hProc, remotePath, 0, MEM_RELEASE);
|
||||
|
||||
if (exitCode == 0) {
|
||||
CloseHandle(hProc);
|
||||
if (errorMsg) *errorMsg = QStringLiteral("LoadLibrary returned NULL in target.\n"
|
||||
"Ensure rcx_payload.dll is in: %1").arg(path);
|
||||
return false;
|
||||
}
|
||||
|
||||
/* Step 2: Call RcxPayloadInit() — safe to create timer queues now
|
||||
(loader lock is no longer held after LoadLibrary returned) */
|
||||
HMODULE hPayloadRemote = (HMODULE)(uintptr_t)exitCode;
|
||||
auto pGetProcAddr = reinterpret_cast<FARPROC(WINAPI*)(HMODULE, LPCSTR)>(
|
||||
GetProcAddress(hK32, "GetProcAddress"));
|
||||
|
||||
/* Write "RcxPayloadInit\0" into target, call GetProcAddress remotely */
|
||||
const char initName[] = "RcxPayloadInit";
|
||||
void* remoteInitName = VirtualAllocEx(hProc, nullptr, sizeof(initName),
|
||||
MEM_COMMIT | MEM_RESERVE, PAGE_READWRITE);
|
||||
if (remoteInitName) {
|
||||
WriteProcessMemory(hProc, remoteInitName, initName, sizeof(initName), nullptr);
|
||||
|
||||
/* We need to call GetProcAddress(hPayload, "RcxPayloadInit") then call the result.
|
||||
Simpler approach: write small shellcode that does both calls. */
|
||||
uint8_t shellcode[128];
|
||||
int off = 0;
|
||||
|
||||
/* sub rsp, 40 ; shadow space + alignment */
|
||||
shellcode[off++] = 0x48; shellcode[off++] = 0x83; shellcode[off++] = 0xEC; shellcode[off++] = 0x28;
|
||||
/* mov rcx, hPayloadRemote ; first arg = module handle */
|
||||
shellcode[off++] = 0x48; shellcode[off++] = 0xB9;
|
||||
uint64_t hMod = (uint64_t)(uintptr_t)hPayloadRemote;
|
||||
memcpy(shellcode + off, &hMod, 8); off += 8;
|
||||
/* mov rdx, remoteInitName ; second arg = "RcxPayloadInit" */
|
||||
shellcode[off++] = 0x48; shellcode[off++] = 0xBA;
|
||||
uint64_t pName = (uint64_t)(uintptr_t)remoteInitName;
|
||||
memcpy(shellcode + off, &pName, 8); off += 8;
|
||||
/* mov rax, GetProcAddress */
|
||||
shellcode[off++] = 0x48; shellcode[off++] = 0xB8;
|
||||
uint64_t pGPA = (uint64_t)(uintptr_t)pGetProcAddr;
|
||||
memcpy(shellcode + off, &pGPA, 8); off += 8;
|
||||
/* call rax ; rax = RcxPayloadInit */
|
||||
shellcode[off++] = 0xFF; shellcode[off++] = 0xD0;
|
||||
/* test rax, rax */
|
||||
shellcode[off++] = 0x48; shellcode[off++] = 0x85; shellcode[off++] = 0xC0;
|
||||
/* jz skip (jump over the call if null) */
|
||||
shellcode[off++] = 0x74; shellcode[off++] = 0x02;
|
||||
/* call rax ; RcxPayloadInit() */
|
||||
shellcode[off++] = 0xFF; shellcode[off++] = 0xD0;
|
||||
/* skip: add rsp, 40 */
|
||||
shellcode[off++] = 0x48; shellcode[off++] = 0x83; shellcode[off++] = 0xC4; shellcode[off++] = 0x28;
|
||||
/* ret */
|
||||
shellcode[off++] = 0xC3;
|
||||
|
||||
void* remoteCode = VirtualAllocEx(hProc, nullptr, (SIZE_T)off,
|
||||
MEM_COMMIT | MEM_RESERVE, PAGE_EXECUTE_READWRITE);
|
||||
if (remoteCode) {
|
||||
WriteProcessMemory(hProc, remoteCode, shellcode, (SIZE_T)off, nullptr);
|
||||
|
||||
HANDLE hThread2 = CreateRemoteThread(hProc, nullptr, 0,
|
||||
(LPTHREAD_START_ROUTINE)remoteCode, nullptr, 0, nullptr);
|
||||
if (hThread2) {
|
||||
WaitForSingleObject(hThread2, 10000);
|
||||
CloseHandle(hThread2);
|
||||
}
|
||||
VirtualFreeEx(hProc, remoteCode, 0, MEM_RELEASE);
|
||||
}
|
||||
VirtualFreeEx(hProc, remoteInitName, 0, MEM_RELEASE);
|
||||
}
|
||||
|
||||
CloseHandle(hProc);
|
||||
return true;
|
||||
}
|
||||
|
||||
#else
|
||||
/* ── Linux injection: ptrace + dlopen ─────────────────────────────── */
|
||||
|
||||
static uint64_t findLibBase(pid_t pid, const char* libName)
|
||||
{
|
||||
char mapsPath[64];
|
||||
snprintf(mapsPath, sizeof(mapsPath), "/proc/%d/maps", pid);
|
||||
FILE* f = fopen(mapsPath, "r");
|
||||
if (!f) return 0;
|
||||
|
||||
char line[1024];
|
||||
while (fgets(line, sizeof(line), f)) {
|
||||
if (strstr(line, libName)) {
|
||||
uint64_t base;
|
||||
if (sscanf(line, "%lx-", &base) == 1) {
|
||||
fclose(f);
|
||||
return base;
|
||||
}
|
||||
}
|
||||
}
|
||||
fclose(f);
|
||||
return 0;
|
||||
}
|
||||
|
||||
static uint64_t findSyscallInsn(pid_t pid)
|
||||
{
|
||||
char mapsPath[64];
|
||||
snprintf(mapsPath, sizeof(mapsPath), "/proc/%d/maps", pid);
|
||||
FILE* f = fopen(mapsPath, "r");
|
||||
if (!f) return 0;
|
||||
|
||||
char line[1024];
|
||||
while (fgets(line, sizeof(line), f)) {
|
||||
if (strstr(line, "libc") && strstr(line, "r-xp")) {
|
||||
uint64_t start, end;
|
||||
if (sscanf(line, "%lx-%lx", &start, &end) != 2) continue;
|
||||
fclose(f);
|
||||
|
||||
/* scan for 0F 05 (syscall) */
|
||||
char memPath[64];
|
||||
snprintf(memPath, sizeof(memPath), "/proc/%d/mem", pid);
|
||||
int memFd = open(memPath, O_RDONLY);
|
||||
if (memFd < 0) return 0;
|
||||
|
||||
uint8_t buf[4096];
|
||||
for (uint64_t off = start; off < end; off += sizeof(buf)) {
|
||||
ssize_t n = pread(memFd, buf, sizeof(buf), (off_t)off);
|
||||
if (n <= 1) break;
|
||||
for (ssize_t i = 0; i + 1 < n; ++i) {
|
||||
if (buf[i] == 0x0F && buf[i + 1] == 0x05) {
|
||||
close(memFd);
|
||||
return off + (uint64_t)i;
|
||||
}
|
||||
}
|
||||
}
|
||||
close(memFd);
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
fclose(f);
|
||||
return 0;
|
||||
}
|
||||
|
||||
static bool writeTargetMem(pid_t pid, uint64_t addr, const void* src, size_t len)
|
||||
{
|
||||
const uint8_t* p = static_cast<const uint8_t*>(src);
|
||||
for (size_t i = 0; i < len; i += sizeof(long)) {
|
||||
long val = 0;
|
||||
size_t chunk = (len - i < sizeof(long)) ? (len - i) : sizeof(long);
|
||||
if (chunk < sizeof(long)) {
|
||||
errno = 0;
|
||||
val = ptrace(PTRACE_PEEKDATA, pid, (void*)(addr + i), nullptr);
|
||||
if (errno) return false;
|
||||
}
|
||||
memcpy(&val, p + i, chunk);
|
||||
if (ptrace(PTRACE_POKEDATA, pid, (void*)(addr + i), (void*)val) < 0)
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
static bool injectPayload(uint32_t pid, QString* errorMsg)
|
||||
{
|
||||
QString path = payloadPath();
|
||||
QByteArray pathUtf8 = path.toUtf8();
|
||||
|
||||
if (ptrace(PTRACE_ATTACH, (pid_t)pid, nullptr, nullptr) < 0) {
|
||||
if (errorMsg)
|
||||
*errorMsg = QStringLiteral("ptrace attach failed: %1\n"
|
||||
"Check /proc/sys/kernel/yama/ptrace_scope or run as root.")
|
||||
.arg(strerror(errno));
|
||||
return false;
|
||||
}
|
||||
|
||||
int status;
|
||||
waitpid((pid_t)pid, &status, 0);
|
||||
|
||||
/* save registers */
|
||||
struct user_regs_struct savedRegs, regs;
|
||||
ptrace(PTRACE_GETREGS, (pid_t)pid, nullptr, &savedRegs);
|
||||
regs = savedRegs;
|
||||
|
||||
/* find syscall instruction in target's libc */
|
||||
uint64_t syscallAddr = findSyscallInsn((pid_t)pid);
|
||||
if (!syscallAddr) {
|
||||
ptrace(PTRACE_DETACH, (pid_t)pid, nullptr, nullptr);
|
||||
if (errorMsg) *errorMsg = QStringLiteral("Could not find syscall instruction in target.");
|
||||
return false;
|
||||
}
|
||||
|
||||
/* find dlopen in target via libc offset technique */
|
||||
void* ourDlopen = dlsym(RTLD_DEFAULT, "dlopen");
|
||||
uint64_t ourLibcBase = findLibBase(getpid(), "libc");
|
||||
uint64_t targetLibcBase = findLibBase((pid_t)pid, "libc");
|
||||
|
||||
if (!ourDlopen || !ourLibcBase || !targetLibcBase) {
|
||||
ptrace(PTRACE_DETACH, (pid_t)pid, nullptr, nullptr);
|
||||
if (errorMsg) *errorMsg = QStringLiteral("Could not resolve dlopen address.");
|
||||
return false;
|
||||
}
|
||||
|
||||
uint64_t targetDlopen = targetLibcBase + ((uint64_t)ourDlopen - ourLibcBase);
|
||||
|
||||
/* call mmap in target via syscall: mmap(0, 4096, RWX, MAP_PRIVATE|MAP_ANON, -1, 0) */
|
||||
regs.rax = 9; /* __NR_mmap */
|
||||
regs.rdi = 0;
|
||||
regs.rsi = 4096;
|
||||
regs.rdx = 7; /* PROT_READ|PROT_WRITE|PROT_EXEC */
|
||||
regs.r10 = 0x22; /* MAP_PRIVATE|MAP_ANONYMOUS */
|
||||
regs.r8 = (uint64_t)-1;
|
||||
regs.r9 = 0;
|
||||
regs.rip = syscallAddr;
|
||||
|
||||
ptrace(PTRACE_SETREGS, (pid_t)pid, nullptr, ®s);
|
||||
ptrace(PTRACE_SINGLESTEP, (pid_t)pid, nullptr, nullptr);
|
||||
waitpid((pid_t)pid, &status, 0);
|
||||
|
||||
ptrace(PTRACE_GETREGS, (pid_t)pid, nullptr, ®s);
|
||||
uint64_t mmapPage = regs.rax;
|
||||
|
||||
if ((int64_t)mmapPage < 0 || mmapPage == 0) {
|
||||
ptrace(PTRACE_SETREGS, (pid_t)pid, nullptr, &savedRegs);
|
||||
ptrace(PTRACE_DETACH, (pid_t)pid, nullptr, nullptr);
|
||||
if (errorMsg) *errorMsg = QStringLiteral("mmap in target failed.");
|
||||
return false;
|
||||
}
|
||||
|
||||
/* write path string at start of page */
|
||||
writeTargetMem((pid_t)pid, mmapPage, pathUtf8.constData(), (size_t)(pathUtf8.size() + 1));
|
||||
|
||||
/* write shellcode after path:
|
||||
* mov rdi, pathAddr (48 BF xxxxxxxx)
|
||||
* mov rsi, 2 (48 BE 02000000 00000000)
|
||||
* mov rax, dlopenAddr (48 B8 xxxxxxxx)
|
||||
* call rax (FF D0)
|
||||
* int3 (CC)
|
||||
*/
|
||||
uint64_t pathAddr = mmapPage;
|
||||
uint64_t codeAddr = mmapPage + ((pathUtf8.size() + 1 + 15) & ~15ULL);
|
||||
|
||||
uint8_t sc[64];
|
||||
int len = 0;
|
||||
/* mov rdi, imm64 */
|
||||
sc[len++] = 0x48; sc[len++] = 0xBF;
|
||||
memcpy(sc + len, &pathAddr, 8); len += 8;
|
||||
/* mov rsi, 2 (RTLD_NOW) */
|
||||
sc[len++] = 0x48; sc[len++] = 0xBE;
|
||||
uint64_t rtldNow = 2;
|
||||
memcpy(sc + len, &rtldNow, 8); len += 8;
|
||||
/* mov rax, dlopen */
|
||||
sc[len++] = 0x48; sc[len++] = 0xB8;
|
||||
memcpy(sc + len, &targetDlopen, 8); len += 8;
|
||||
/* call rax */
|
||||
sc[len++] = 0xFF; sc[len++] = 0xD0;
|
||||
/* int3 */
|
||||
sc[len++] = 0xCC;
|
||||
|
||||
writeTargetMem((pid_t)pid, codeAddr, sc, (size_t)len);
|
||||
|
||||
/* execute shellcode */
|
||||
regs = savedRegs;
|
||||
regs.rip = codeAddr;
|
||||
regs.rsp = (mmapPage + 4096) & ~0xFULL;
|
||||
|
||||
ptrace(PTRACE_SETREGS, (pid_t)pid, nullptr, ®s);
|
||||
ptrace(PTRACE_CONT, (pid_t)pid, nullptr, nullptr);
|
||||
waitpid((pid_t)pid, &status, 0);
|
||||
|
||||
bool ok = false;
|
||||
if (WIFSTOPPED(status) && WSTOPSIG(status) == SIGTRAP) {
|
||||
ptrace(PTRACE_GETREGS, (pid_t)pid, nullptr, ®s);
|
||||
ok = (regs.rax != 0);
|
||||
}
|
||||
|
||||
/* clean up: munmap the page via syscall */
|
||||
struct user_regs_struct cleanRegs = savedRegs;
|
||||
cleanRegs.rax = 11; /* __NR_munmap */
|
||||
cleanRegs.rdi = mmapPage;
|
||||
cleanRegs.rsi = 4096;
|
||||
cleanRegs.rip = syscallAddr;
|
||||
ptrace(PTRACE_SETREGS, (pid_t)pid, nullptr, &cleanRegs);
|
||||
ptrace(PTRACE_SINGLESTEP, (pid_t)pid, nullptr, nullptr);
|
||||
waitpid((pid_t)pid, &status, 0);
|
||||
|
||||
/* restore and detach */
|
||||
ptrace(PTRACE_SETREGS, (pid_t)pid, nullptr, &savedRegs);
|
||||
ptrace(PTRACE_DETACH, (pid_t)pid, nullptr, nullptr);
|
||||
|
||||
if (!ok && errorMsg)
|
||||
*errorMsg = QStringLiteral("dlopen failed in target.\n"
|
||||
"Ensure payload is at: %1").arg(path);
|
||||
return ok;
|
||||
}
|
||||
#endif /* _WIN32 / linux injection */
|
||||
|
||||
} /* anonymous namespace */
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* RemoteProcessMemoryPlugin
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
RemoteProcessMemoryPlugin::RemoteProcessMemoryPlugin() = default;
|
||||
RemoteProcessMemoryPlugin::~RemoteProcessMemoryPlugin() = default;
|
||||
|
||||
QIcon RemoteProcessMemoryPlugin::Icon() const
|
||||
{
|
||||
return qApp->style()->standardIcon(QStyle::SP_DriveNetIcon);
|
||||
}
|
||||
|
||||
bool RemoteProcessMemoryPlugin::canHandle(const QString& target) const
|
||||
{
|
||||
return target.startsWith(QStringLiteral("rpm:"));
|
||||
}
|
||||
|
||||
std::unique_ptr<rcx::Provider>
|
||||
RemoteProcessMemoryPlugin::createProvider(const QString& target, QString* errorMsg)
|
||||
{
|
||||
/* target = "rpm:{pid}:{name}" */
|
||||
QStringList parts = target.split(':');
|
||||
if (parts.size() < 3 || parts[0] != QStringLiteral("rpm")) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("Invalid target: ") + target;
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
bool ok;
|
||||
uint32_t pid = parts[1].toUInt(&ok);
|
||||
QString name = parts.mid(2).join(':'); /* name may contain colons */
|
||||
|
||||
if (!ok || pid == 0) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("Invalid PID in target.");
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
auto ipc = getOrCreateConnection(pid, errorMsg);
|
||||
if (!ipc) return nullptr;
|
||||
|
||||
return std::make_unique<RemoteProcessProvider>(pid, name, ipc);
|
||||
}
|
||||
|
||||
uint64_t RemoteProcessMemoryPlugin::getInitialBaseAddress(const QString& target) const
|
||||
{
|
||||
/* Read imageBase directly from the shared-memory header -- zero IPC cost.
|
||||
The payload filled it at init from PEB->Ldr (Win) / /proc/self/maps (Linux). */
|
||||
QStringList parts = target.split(':');
|
||||
if (parts.size() < 2 || parts[0] != QStringLiteral("rpm"))
|
||||
return 0;
|
||||
|
||||
bool ok;
|
||||
uint32_t pid = parts[1].toUInt(&ok);
|
||||
if (!ok) return 0;
|
||||
|
||||
QMutexLocker lock(&m_connectionsMutex);
|
||||
auto it = m_connections.constFind(pid);
|
||||
if (it == m_connections.constEnd() || !(*it)->connected)
|
||||
return 0;
|
||||
|
||||
auto* hdr = static_cast<const RcxRpcHeader*>((*it)->mappedView);
|
||||
return hdr->imageBase;
|
||||
}
|
||||
|
||||
bool RemoteProcessMemoryPlugin::selectTarget(QWidget* parent, QString* target)
|
||||
{
|
||||
/* ── 1. pick a process ── */
|
||||
QVector<PluginProcessInfo> pluginProcs = enumerateProcesses();
|
||||
QList<ProcessInfo> procs;
|
||||
for (const auto& pi : pluginProcs) {
|
||||
ProcessInfo info;
|
||||
info.pid = pi.pid;
|
||||
info.name = pi.name;
|
||||
info.path = pi.path;
|
||||
info.icon = pi.icon;
|
||||
procs.append(info);
|
||||
}
|
||||
|
||||
ProcessPicker picker(procs, parent);
|
||||
if (picker.exec() != QDialog::Accepted) return false;
|
||||
|
||||
uint32_t pid = picker.selectedProcessId();
|
||||
QString name = picker.selectedProcessName();
|
||||
|
||||
/* ── 2. ask inject or connect ── */
|
||||
QMessageBox box(parent);
|
||||
box.setWindowTitle(QStringLiteral("Remote Process Memory"));
|
||||
box.setText(QStringLiteral("Connect to %1 (PID %2)").arg(name).arg(pid));
|
||||
box.setInformativeText(QStringLiteral("Choose how to connect to the target:"));
|
||||
QAbstractButton* injectBtn = box.addButton(QStringLiteral("Inject Payload"), QMessageBox::ActionRole);
|
||||
QAbstractButton* connectBtn = box.addButton(QStringLiteral("Already Injected"), QMessageBox::ActionRole);
|
||||
box.addButton(QMessageBox::Cancel);
|
||||
box.exec();
|
||||
|
||||
QAbstractButton* clicked = box.clickedButton();
|
||||
if (clicked == injectBtn) {
|
||||
QString injectErr;
|
||||
if (!injectPayload(pid, &injectErr)) {
|
||||
QMessageBox::critical(parent, QStringLiteral("Injection Failed"), injectErr);
|
||||
return false;
|
||||
}
|
||||
|
||||
*target = QStringLiteral("rpm:%1:%2").arg(pid).arg(name);
|
||||
return true;
|
||||
}
|
||||
else if (clicked == connectBtn) {
|
||||
*target = QStringLiteral("rpm:%1:%2").arg(pid).arg(name);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
QVector<PluginProcessInfo> RemoteProcessMemoryPlugin::enumerateProcesses()
|
||||
{
|
||||
QVector<PluginProcessInfo> procs;
|
||||
|
||||
#ifdef _WIN32
|
||||
HANDLE snap = CreateToolhelp32Snapshot(TH32CS_SNAPPROCESS, 0);
|
||||
if (snap == INVALID_HANDLE_VALUE) return procs;
|
||||
|
||||
PROCESSENTRY32W entry;
|
||||
entry.dwSize = sizeof(entry);
|
||||
|
||||
if (Process32FirstW(snap, &entry)) {
|
||||
do {
|
||||
PluginProcessInfo info;
|
||||
info.pid = entry.th32ProcessID;
|
||||
info.name = QString::fromWCharArray(entry.szExeFile);
|
||||
|
||||
HANDLE hProc = OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION,
|
||||
FALSE, entry.th32ProcessID);
|
||||
if (hProc) {
|
||||
wchar_t path[MAX_PATH * 2];
|
||||
DWORD pathLen = sizeof(path) / sizeof(wchar_t);
|
||||
if (QueryFullProcessImageNameW(hProc, 0, path, &pathLen)) {
|
||||
info.path = QString::fromWCharArray(path);
|
||||
SHFILEINFOW sfi = {};
|
||||
if (SHGetFileInfoW(path, 0, &sfi, sizeof(sfi),
|
||||
SHGFI_ICON | SHGFI_SMALLICON) && sfi.hIcon) {
|
||||
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
|
||||
info.icon = QIcon(QPixmap::fromImage(QImage::fromHICON(sfi.hIcon)));
|
||||
#else
|
||||
info.icon = QIcon(QtWin::fromHICON(sfi.hIcon));
|
||||
#endif
|
||||
DestroyIcon(sfi.hIcon);
|
||||
}
|
||||
}
|
||||
CloseHandle(hProc);
|
||||
}
|
||||
procs.append(info);
|
||||
} while (Process32NextW(snap, &entry));
|
||||
}
|
||||
CloseHandle(snap);
|
||||
|
||||
#else
|
||||
QDir procDir(QStringLiteral("/proc"));
|
||||
QIcon defIcon = qApp->style()->standardIcon(QStyle::SP_ComputerIcon);
|
||||
|
||||
for (const QString& entry : procDir.entryList(QDir::Dirs | QDir::NoDotAndDotDot)) {
|
||||
bool ok;
|
||||
uint32_t pid = entry.toUInt(&ok);
|
||||
if (!ok || pid == 0) continue;
|
||||
|
||||
QFile commFile(QStringLiteral("/proc/%1/comm").arg(pid));
|
||||
if (!commFile.open(QIODevice::ReadOnly)) continue;
|
||||
QString procName = QString::fromUtf8(commFile.readAll()).trimmed();
|
||||
commFile.close();
|
||||
if (procName.isEmpty()) continue;
|
||||
|
||||
QString memPath = QStringLiteral("/proc/%1/mem").arg(pid);
|
||||
if (::access(memPath.toUtf8().constData(), R_OK) != 0) continue;
|
||||
|
||||
QFileInfo exeInfo(QStringLiteral("/proc/%1/exe").arg(pid));
|
||||
PluginProcessInfo info;
|
||||
info.pid = pid;
|
||||
info.name = procName;
|
||||
info.path = exeInfo.exists() ? exeInfo.symLinkTarget() : QString();
|
||||
info.icon = defIcon;
|
||||
procs.append(info);
|
||||
}
|
||||
#endif
|
||||
|
||||
return procs;
|
||||
}
|
||||
|
||||
std::shared_ptr<IpcClient>
|
||||
RemoteProcessMemoryPlugin::getOrCreateConnection(
|
||||
uint32_t pid, QString* errorMsg)
|
||||
{
|
||||
QMutexLocker lock(&m_connectionsMutex);
|
||||
|
||||
auto it = m_connections.find(pid);
|
||||
if (it != m_connections.end() && (*it)->connected)
|
||||
return *it;
|
||||
|
||||
auto ipc = std::make_shared<IpcClient>();
|
||||
if (!ipc->connect(pid)) {
|
||||
if (errorMsg)
|
||||
*errorMsg = QStringLiteral("Failed to connect IPC to PID %1.\n"
|
||||
"Is the payload running?").arg(pid);
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
m_connections[pid] = ipc;
|
||||
return ipc;
|
||||
}
|
||||
|
||||
/* ── Plugin factory ───────────────────────────────────────────────── */
|
||||
|
||||
extern "C" RCX_PLUGIN_EXPORT IPlugin* CreatePlugin()
|
||||
{
|
||||
return new RemoteProcessMemoryPlugin();
|
||||
}
|
||||
86
plugins/RemoteProcessMemory/RemoteProcessMemoryPlugin.h
Normal file
86
plugins/RemoteProcessMemory/RemoteProcessMemoryPlugin.h
Normal file
@@ -0,0 +1,86 @@
|
||||
#pragma once
|
||||
#include "../../src/iplugin.h"
|
||||
#include "../../src/providers/provider.h"
|
||||
|
||||
#include <cstdint>
|
||||
#include <memory>
|
||||
#include <QMutex>
|
||||
#include <QHash>
|
||||
#include <QVector>
|
||||
|
||||
struct IpcClient; /* defined in .cpp */
|
||||
|
||||
/* ── Provider ─────────────────────────────────────────────────────── */
|
||||
|
||||
class RemoteProcessProvider : public rcx::Provider
|
||||
{
|
||||
public:
|
||||
struct ModuleInfo { QString name; uint64_t base; uint64_t size; };
|
||||
|
||||
RemoteProcessProvider(uint32_t pid, const QString& processName,
|
||||
std::shared_ptr<IpcClient> ipc);
|
||||
~RemoteProcessProvider() override;
|
||||
|
||||
/* required */
|
||||
bool read(uint64_t addr, void* buf, int len) const override;
|
||||
int size() const override;
|
||||
|
||||
/* optional */
|
||||
bool write(uint64_t addr, const void* buf, int len) override;
|
||||
bool isWritable() const override { return m_connected; }
|
||||
QString name() const override { return m_processName; }
|
||||
QString kind() const override { return QStringLiteral("RemoteProcess"); }
|
||||
bool isLive() const override { return true; }
|
||||
uint64_t base() const override { return m_base; }
|
||||
bool isReadable(uint64_t, int len) const override { return m_connected && len >= 0; }
|
||||
QString getSymbol(uint64_t addr) const override;
|
||||
uint64_t symbolToAddress(const QString& n) const override;
|
||||
|
||||
uint32_t pid() const { return m_pid; }
|
||||
|
||||
private:
|
||||
void cacheModules();
|
||||
|
||||
uint32_t m_pid;
|
||||
QString m_processName;
|
||||
bool m_connected;
|
||||
uint64_t m_base;
|
||||
mutable std::shared_ptr<IpcClient> m_ipc;
|
||||
QVector<ModuleInfo> m_modules;
|
||||
};
|
||||
|
||||
/* ── Plugin ───────────────────────────────────────────────────────── */
|
||||
|
||||
class RemoteProcessMemoryPlugin : public IProviderPlugin
|
||||
{
|
||||
public:
|
||||
RemoteProcessMemoryPlugin();
|
||||
~RemoteProcessMemoryPlugin() override;
|
||||
|
||||
std::string Name() const override { return "Remote Process Memory"; }
|
||||
std::string Version() const override { return "1.0.0"; }
|
||||
std::string Author() const override { return "Reclass"; }
|
||||
std::string Description() const override {
|
||||
return "Read/write memory via injected payload (shared-memory IPC)";
|
||||
}
|
||||
k_ELoadType LoadType() const override { return k_ELoadTypeManual; }
|
||||
QIcon Icon() const override;
|
||||
|
||||
bool canHandle(const QString& target) const override;
|
||||
std::unique_ptr<rcx::Provider> createProvider(const QString& target,
|
||||
QString* errorMsg) override;
|
||||
uint64_t getInitialBaseAddress(const QString& target) const override;
|
||||
bool selectTarget(QWidget* parent, QString* target) override;
|
||||
|
||||
bool providesProcessList() const override { return true; }
|
||||
QVector<PluginProcessInfo> enumerateProcesses() override;
|
||||
|
||||
private:
|
||||
std::shared_ptr<IpcClient> getOrCreateConnection(
|
||||
uint32_t pid, QString* errorMsg);
|
||||
|
||||
mutable QMutex m_connectionsMutex;
|
||||
QHash<uint32_t, std::shared_ptr<IpcClient>> m_connections;
|
||||
};
|
||||
|
||||
extern "C" RCX_PLUGIN_EXPORT IPlugin* CreatePlugin();
|
||||
612
plugins/RemoteProcessMemory/payload/rcx_payload.cpp
Normal file
612
plugins/RemoteProcessMemory/payload/rcx_payload.cpp
Normal file
@@ -0,0 +1,612 @@
|
||||
/*
|
||||
* rcx_payload -- injected into target process.
|
||||
*
|
||||
* Pure Win32 / POSIX, NO Qt, minimal footprint.
|
||||
* Creates the main IPC channel (shared memory + events/semaphores)
|
||||
* using PID-only naming and uses a timer queue for polling.
|
||||
*/
|
||||
|
||||
#include "../rcx_rpc_protocol.h"
|
||||
|
||||
#ifdef _WIN32
|
||||
/* ===================================================================
|
||||
* WINDOWS implementation
|
||||
* =================================================================== */
|
||||
#define WIN32_LEAN_AND_MEAN
|
||||
#include <windows.h>
|
||||
#include <psapi.h>
|
||||
|
||||
/* ── globals ──────────────────────────────────────────────────────── */
|
||||
static HANDLE g_hShm = nullptr;
|
||||
static void* g_mappedView = nullptr;
|
||||
static HANDLE g_hReqEvent = nullptr;
|
||||
static HANDLE g_hRspEvent = nullptr;
|
||||
static HANDLE g_hTimerQueue = nullptr;
|
||||
static HANDLE g_hPollTimer = nullptr;
|
||||
static volatile LONG g_initialized = 0;
|
||||
|
||||
/* ── memory safety via VirtualQuery ────────────────────────────────── */
|
||||
|
||||
inline bool IsReadableProtect(DWORD p)
|
||||
{
|
||||
if (p & (PAGE_NOACCESS | PAGE_GUARD))
|
||||
return false;
|
||||
|
||||
const DWORD readable =
|
||||
PAGE_READONLY | PAGE_READWRITE | PAGE_WRITECOPY |
|
||||
PAGE_EXECUTE_READ | PAGE_EXECUTE_READWRITE | PAGE_EXECUTE_WRITECOPY;
|
||||
|
||||
return (p & readable) != 0;
|
||||
}
|
||||
|
||||
inline bool IsWritableProtect(DWORD p)
|
||||
{
|
||||
if (p & (PAGE_NOACCESS | PAGE_GUARD))
|
||||
return false;
|
||||
|
||||
const DWORD writable =
|
||||
PAGE_READWRITE | PAGE_WRITECOPY |
|
||||
PAGE_EXECUTE_READWRITE | PAGE_EXECUTE_WRITECOPY;
|
||||
|
||||
return (p & writable) != 0;
|
||||
}
|
||||
|
||||
/* Check that the full range [addr, addr+len) is covered by readable pages. */
|
||||
static bool IsRangeReadable(uintptr_t addr, uint32_t len)
|
||||
{
|
||||
uintptr_t end = addr + len;
|
||||
uintptr_t cur = addr;
|
||||
while (cur < end) {
|
||||
MEMORY_BASIC_INFORMATION mbi{};
|
||||
if (VirtualQuery(reinterpret_cast<LPCVOID>(cur), &mbi, sizeof(mbi)) == 0)
|
||||
return false;
|
||||
if (mbi.State != MEM_COMMIT || !IsReadableProtect(mbi.Protect))
|
||||
return false;
|
||||
uintptr_t regionEnd = reinterpret_cast<uintptr_t>(mbi.BaseAddress) + mbi.RegionSize;
|
||||
cur = regionEnd;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
static bool IsRangeWritable(uintptr_t addr, uint32_t len)
|
||||
{
|
||||
uintptr_t end = addr + len;
|
||||
uintptr_t cur = addr;
|
||||
while (cur < end) {
|
||||
MEMORY_BASIC_INFORMATION mbi{};
|
||||
if (VirtualQuery(reinterpret_cast<LPCVOID>(cur), &mbi, sizeof(mbi)) == 0)
|
||||
return false;
|
||||
if (mbi.State != MEM_COMMIT || !IsWritableProtect(mbi.Protect))
|
||||
return false;
|
||||
uintptr_t regionEnd = reinterpret_cast<uintptr_t>(mbi.BaseAddress) + mbi.RegionSize;
|
||||
cur = regionEnd;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/* ── command handlers ─────────────────────────────────────────────── */
|
||||
|
||||
static void handle_read_batch(RcxRpcHeader* hdr, uint8_t* data)
|
||||
{
|
||||
auto* entries = reinterpret_cast<RcxRpcReadEntry*>(data);
|
||||
for (uint32_t i = 0; i < hdr->requestCount; ++i) {
|
||||
uint8_t* dest = data + entries[i].dataOffset;
|
||||
uintptr_t src = static_cast<uintptr_t>(entries[i].address);
|
||||
if (IsRangeReadable(src, entries[i].length)) {
|
||||
memcpy(dest, reinterpret_cast<const void*>(src), entries[i].length);
|
||||
} else {
|
||||
memset(dest, 0, entries[i].length);
|
||||
hdr->status = RCX_RPC_STATUS_PARTIAL;
|
||||
}
|
||||
/* SEH fallback (commented out, kept for reference):
|
||||
__try {
|
||||
memcpy(dest, reinterpret_cast<const void*>(src), entries[i].length);
|
||||
} __except (EXCEPTION_EXECUTE_HANDLER) {
|
||||
memset(dest, 0, entries[i].length);
|
||||
hdr->status = RCX_RPC_STATUS_PARTIAL;
|
||||
}
|
||||
*/
|
||||
}
|
||||
hdr->responseCount = hdr->requestCount;
|
||||
}
|
||||
|
||||
static void handle_write(RcxRpcHeader* hdr, uint8_t* data)
|
||||
{
|
||||
uintptr_t dst = static_cast<uintptr_t>(hdr->writeAddress);
|
||||
if (IsRangeWritable(dst, hdr->writeLength)) {
|
||||
memcpy(reinterpret_cast<void*>(dst), data, hdr->writeLength);
|
||||
} else {
|
||||
hdr->status = RCX_RPC_STATUS_ERROR;
|
||||
}
|
||||
/* SEH fallback (commented out, kept for reference):
|
||||
__try {
|
||||
memcpy(reinterpret_cast<void*>(dst), data, hdr->writeLength);
|
||||
} __except (EXCEPTION_EXECUTE_HANDLER) {
|
||||
hdr->status = RCX_RPC_STATUS_ERROR;
|
||||
}
|
||||
*/
|
||||
}
|
||||
|
||||
static void handle_enum_modules(RcxRpcHeader* hdr, uint8_t* data)
|
||||
{
|
||||
HANDLE hProc = GetCurrentProcess();
|
||||
HMODULE mods[1024];
|
||||
DWORD needed = 0;
|
||||
if (!EnumProcessModules(hProc, mods, sizeof(mods), &needed)) {
|
||||
hdr->status = RCX_RPC_STATUS_ERROR;
|
||||
hdr->responseCount = 0;
|
||||
return;
|
||||
}
|
||||
int count = (int)(needed / sizeof(HMODULE));
|
||||
if (count > 1024) count = 1024;
|
||||
|
||||
uint32_t entryBytes = (uint32_t)(count * sizeof(RcxRpcModuleEntry));
|
||||
uint32_t nameDataOff = entryBytes;
|
||||
|
||||
for (int i = 0; i < count; ++i) {
|
||||
MODULEINFO mi{};
|
||||
WCHAR modName[MAX_PATH];
|
||||
GetModuleInformation(hProc, mods[i], &mi, sizeof(mi));
|
||||
int nameLen = (int)GetModuleBaseNameW(hProc, mods[i], modName, MAX_PATH);
|
||||
uint32_t nameBytes = (uint32_t)(nameLen * sizeof(WCHAR));
|
||||
|
||||
auto* entry = reinterpret_cast<RcxRpcModuleEntry*>(data + i * sizeof(RcxRpcModuleEntry));
|
||||
entry->base = reinterpret_cast<uint64_t>(mi.lpBaseOfDll);
|
||||
entry->size = static_cast<uint64_t>(mi.SizeOfImage);
|
||||
entry->nameOffset = nameDataOff;
|
||||
entry->nameLength = nameBytes;
|
||||
|
||||
if (nameDataOff + nameBytes <= RCX_RPC_DATA_SIZE) {
|
||||
memcpy(data + nameDataOff, modName, nameBytes);
|
||||
nameDataOff += nameBytes;
|
||||
}
|
||||
}
|
||||
|
||||
hdr->responseCount = (uint32_t)count;
|
||||
hdr->totalDataUsed = nameDataOff;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
}
|
||||
|
||||
/* forward declaration */
|
||||
void RcxPayloadCleanup();
|
||||
|
||||
/* ── timer callback (non-blocking poll) ───────────────────────────── */
|
||||
|
||||
static VOID CALLBACK RcxPollTimerCallback(PVOID, BOOLEAN)
|
||||
{
|
||||
if (!g_mappedView || !g_hReqEvent || !g_hRspEvent)
|
||||
return;
|
||||
|
||||
/* non-blocking check: is there a pending request? */
|
||||
DWORD rc = WaitForSingleObject(g_hReqEvent, 0);
|
||||
if (rc != WAIT_OBJECT_0)
|
||||
return;
|
||||
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(g_mappedView);
|
||||
auto* data = reinterpret_cast<uint8_t*>(g_mappedView) + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
switch (static_cast<RcxRpcCommand>(hdr->command)) {
|
||||
case RPC_CMD_READ_BATCH: handle_read_batch(hdr, data); break;
|
||||
case RPC_CMD_WRITE: handle_write(hdr, data); break;
|
||||
case RPC_CMD_ENUM_MODULES: handle_enum_modules(hdr, data); break;
|
||||
case RPC_CMD_PING: break;
|
||||
case RPC_CMD_SHUTDOWN:
|
||||
RcxPayloadCleanup();
|
||||
return;
|
||||
default:
|
||||
hdr->status = RCX_RPC_STATUS_ERROR;
|
||||
break;
|
||||
}
|
||||
|
||||
SetEvent(g_hRspEvent);
|
||||
}
|
||||
|
||||
/* ── cleanup ──────────────────────────────────────────────────────── */
|
||||
|
||||
void RcxPayloadCleanup()
|
||||
{
|
||||
if (!InterlockedCompareExchange(&g_initialized, 0, 0))
|
||||
return;
|
||||
|
||||
/* stop the poll timer first */
|
||||
if (g_hTimerQueue) {
|
||||
DeleteTimerQueueEx(g_hTimerQueue, INVALID_HANDLE_VALUE); /* waits for callbacks */
|
||||
g_hTimerQueue = nullptr;
|
||||
g_hPollTimer = nullptr;
|
||||
}
|
||||
|
||||
/* mark not-ready */
|
||||
if (g_mappedView) {
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(g_mappedView);
|
||||
InterlockedExchange(reinterpret_cast<volatile LONG*>(&hdr->payloadReady), 0);
|
||||
}
|
||||
|
||||
if (g_mappedView) { UnmapViewOfFile(g_mappedView); g_mappedView = nullptr; }
|
||||
if (g_hShm) { CloseHandle(g_hShm); g_hShm = nullptr; }
|
||||
if (g_hReqEvent) { CloseHandle(g_hReqEvent); g_hReqEvent = nullptr; }
|
||||
if (g_hRspEvent) { CloseHandle(g_hRspEvent); g_hRspEvent = nullptr; }
|
||||
|
||||
InterlockedExchange(&g_initialized, 0);
|
||||
}
|
||||
|
||||
/* ── init (called AFTER DllMain returns — safe for timer queues) ── */
|
||||
|
||||
extern "C" __declspec(dllexport)
|
||||
bool RcxPayloadInit()
|
||||
{
|
||||
if (InterlockedCompareExchange(&g_initialized, 1, 0) != 0)
|
||||
return true; /* already initialized */
|
||||
|
||||
uint32_t pid = GetCurrentProcessId();
|
||||
|
||||
char shmName[128], reqName[128], rspName[128];
|
||||
rcx_rpc_shm_name(shmName, sizeof(shmName), pid);
|
||||
rcx_rpc_req_name(reqName, sizeof(reqName), pid);
|
||||
rcx_rpc_rsp_name(rspName, sizeof(rspName), pid);
|
||||
|
||||
g_hShm = CreateFileMappingA(INVALID_HANDLE_VALUE, nullptr,
|
||||
PAGE_READWRITE, 0, RCX_RPC_SHM_SIZE, shmName);
|
||||
if (!g_hShm) {
|
||||
InterlockedExchange(&g_initialized, 0);
|
||||
return false;
|
||||
}
|
||||
|
||||
g_mappedView = MapViewOfFile(g_hShm, FILE_MAP_ALL_ACCESS, 0, 0, RCX_RPC_SHM_SIZE);
|
||||
if (!g_mappedView) {
|
||||
CloseHandle(g_hShm); g_hShm = nullptr;
|
||||
InterlockedExchange(&g_initialized, 0);
|
||||
return false;
|
||||
}
|
||||
|
||||
memset(g_mappedView, 0, RCX_RPC_HEADER_SIZE);
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(g_mappedView);
|
||||
hdr->version = RCX_RPC_VERSION;
|
||||
|
||||
/* image base from PEB */
|
||||
{
|
||||
uint64_t peb;
|
||||
asm volatile("mov %%gs:0x60, %0" : "=r"(peb));
|
||||
uint64_t ldr = *reinterpret_cast<uint64_t*>(peb + 0x18);
|
||||
uint64_t firstLink = *reinterpret_cast<uint64_t*>(ldr + 0x10);
|
||||
hdr->imageBase = *reinterpret_cast<uint64_t*>(firstLink + 0x30);
|
||||
}
|
||||
|
||||
g_hReqEvent = CreateEventA(nullptr, FALSE, FALSE, reqName);
|
||||
g_hRspEvent = CreateEventA(nullptr, FALSE, FALSE, rspName);
|
||||
if (!g_hReqEvent || !g_hRspEvent) {
|
||||
RcxPayloadCleanup();
|
||||
return false;
|
||||
}
|
||||
|
||||
/* create dedicated timer queue + fast poll timer (10ms interval) */
|
||||
g_hTimerQueue = CreateTimerQueue();
|
||||
if (!g_hTimerQueue) {
|
||||
RcxPayloadCleanup();
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!CreateTimerQueueTimer(&g_hPollTimer, g_hTimerQueue,
|
||||
RcxPollTimerCallback, nullptr,
|
||||
0, /* start immediately */
|
||||
10, /* 10ms repeat */
|
||||
WT_EXECUTEDEFAULT)) {
|
||||
RcxPayloadCleanup();
|
||||
return false;
|
||||
}
|
||||
|
||||
/* mark ready */
|
||||
InterlockedExchange(reinterpret_cast<volatile LONG*>(&hdr->payloadReady), 1);
|
||||
return true;
|
||||
}
|
||||
|
||||
/* ── DllMain — minimal, no heavy work under loader lock ───────────── */
|
||||
|
||||
BOOL WINAPI DllMain(HINSTANCE, DWORD reason, LPVOID)
|
||||
{
|
||||
if (reason == DLL_PROCESS_DETACH) {
|
||||
RcxPayloadCleanup();
|
||||
}
|
||||
return TRUE;
|
||||
}
|
||||
|
||||
#else
|
||||
/* ===================================================================
|
||||
* LINUX implementation
|
||||
* =================================================================== */
|
||||
#include <stdlib.h>
|
||||
#include <unistd.h>
|
||||
#include <fcntl.h>
|
||||
#include <pthread.h>
|
||||
#include <semaphore.h>
|
||||
#include <sys/mman.h>
|
||||
#include <sys/stat.h>
|
||||
#include <errno.h>
|
||||
#include <time.h>
|
||||
#include <signal.h>
|
||||
|
||||
/* ── globals ──────────────────────────────────────────────────────── */
|
||||
static int g_shmFd = -1;
|
||||
static void* g_mappedView = nullptr;
|
||||
static sem_t* g_reqSem = SEM_FAILED;
|
||||
static sem_t* g_rspSem = SEM_FAILED;
|
||||
static pthread_t g_thread;
|
||||
static volatile int g_shutdown = 0;
|
||||
static volatile int g_threadRunning = 0;
|
||||
static int g_memFd = -1; /* /proc/self/mem for safe access */
|
||||
static char g_shmName[128];
|
||||
static char g_reqName[128];
|
||||
static char g_rspName[128];
|
||||
|
||||
/* ── safe memory access via /proc/self/mem ────────────────────────── */
|
||||
|
||||
static void safe_read(uint64_t addr, void* dest, uint32_t len, uint32_t* status)
|
||||
{
|
||||
ssize_t n = pread(g_memFd, dest, len, (off_t)addr);
|
||||
if (n < (ssize_t)len) {
|
||||
if (n > 0)
|
||||
memset((uint8_t*)dest + n, 0, len - (uint32_t)n);
|
||||
else
|
||||
memset(dest, 0, len);
|
||||
*status = RCX_RPC_STATUS_PARTIAL;
|
||||
}
|
||||
}
|
||||
|
||||
static void safe_write(uint64_t addr, const void* src, uint32_t len, uint32_t* status)
|
||||
{
|
||||
ssize_t n = pwrite(g_memFd, src, len, (off_t)addr);
|
||||
if (n < (ssize_t)len)
|
||||
*status = RCX_RPC_STATUS_ERROR;
|
||||
}
|
||||
|
||||
/* ── command handlers ─────────────────────────────────────────────── */
|
||||
|
||||
static void handle_read_batch(RcxRpcHeader* hdr, uint8_t* data)
|
||||
{
|
||||
auto* entries = reinterpret_cast<RcxRpcReadEntry*>(data);
|
||||
for (uint32_t i = 0; i < hdr->requestCount; ++i) {
|
||||
uint8_t* dest = data + entries[i].dataOffset;
|
||||
safe_read(entries[i].address, dest, entries[i].length, &hdr->status);
|
||||
}
|
||||
hdr->responseCount = hdr->requestCount;
|
||||
}
|
||||
|
||||
static void handle_write(RcxRpcHeader* hdr, uint8_t* data)
|
||||
{
|
||||
safe_write(hdr->writeAddress, data, hdr->writeLength, &hdr->status);
|
||||
}
|
||||
|
||||
static void handle_enum_modules(RcxRpcHeader* hdr, uint8_t* data)
|
||||
{
|
||||
FILE* f = fopen("/proc/self/maps", "r");
|
||||
if (!f) {
|
||||
hdr->status = RCX_RPC_STATUS_ERROR;
|
||||
hdr->responseCount = 0;
|
||||
return;
|
||||
}
|
||||
|
||||
/* first pass: collect unique file-backed mappings */
|
||||
struct ModRange { uint64_t base; uint64_t end; char path[512]; };
|
||||
static ModRange modules[512]; /* static to avoid large stack alloc */
|
||||
int modCount = 0;
|
||||
|
||||
char line[1024];
|
||||
while (fgets(line, sizeof(line), f) && modCount < 512) {
|
||||
uint64_t start, end;
|
||||
char perms[8] = {}, path[512] = {};
|
||||
if (sscanf(line, "%lx-%lx %7s %*x %*x:%*x %*u %511[^\n]",
|
||||
&start, &end, perms, path) < 4)
|
||||
continue;
|
||||
|
||||
/* skip non-file / special mappings */
|
||||
/* trim leading whitespace from path */
|
||||
char* p = path;
|
||||
while (*p == ' ' || *p == '\t') ++p;
|
||||
if (*p != '/') continue;
|
||||
if (strncmp(p, "/dev/", 5) == 0) continue;
|
||||
if (strncmp(p, "/memfd:", 7) == 0) continue;
|
||||
|
||||
bool found = false;
|
||||
for (int i = 0; i < modCount; ++i) {
|
||||
if (strcmp(modules[i].path, p) == 0) {
|
||||
if (start < modules[i].base) modules[i].base = start;
|
||||
if (end > modules[i].end) modules[i].end = end;
|
||||
found = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!found) {
|
||||
modules[modCount].base = start;
|
||||
modules[modCount].end = end;
|
||||
strncpy(modules[modCount].path, p, 511);
|
||||
modules[modCount].path[511] = '\0';
|
||||
++modCount;
|
||||
}
|
||||
}
|
||||
fclose(f);
|
||||
|
||||
/* write entries + name strings into data region */
|
||||
uint32_t entryBytes = (uint32_t)(modCount * sizeof(RcxRpcModuleEntry));
|
||||
uint32_t nameDataOff = entryBytes;
|
||||
|
||||
for (int i = 0; i < modCount; ++i) {
|
||||
const char* basename = strrchr(modules[i].path, '/');
|
||||
basename = basename ? basename + 1 : modules[i].path;
|
||||
uint32_t nameLen = (uint32_t)strlen(basename);
|
||||
|
||||
auto* entry = reinterpret_cast<RcxRpcModuleEntry*>(
|
||||
data + (uint32_t)i * sizeof(RcxRpcModuleEntry));
|
||||
entry->base = modules[i].base;
|
||||
entry->size = modules[i].end - modules[i].base;
|
||||
entry->nameOffset = nameDataOff;
|
||||
entry->nameLength = nameLen;
|
||||
|
||||
if (nameDataOff + nameLen <= RCX_RPC_DATA_SIZE) {
|
||||
memcpy(data + nameDataOff, basename, nameLen);
|
||||
nameDataOff += nameLen;
|
||||
}
|
||||
}
|
||||
|
||||
hdr->responseCount = (uint32_t)modCount;
|
||||
hdr->totalDataUsed = nameDataOff;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
}
|
||||
|
||||
/* ── server thread ────────────────────────────────────────────────── */
|
||||
|
||||
static void* server_thread_func(void*)
|
||||
{
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(g_mappedView);
|
||||
auto* data = reinterpret_cast<uint8_t*>(g_mappedView) + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
__atomic_store_n(&hdr->payloadReady, 1, __ATOMIC_RELEASE);
|
||||
|
||||
while (!__atomic_load_n(&g_shutdown, __ATOMIC_ACQUIRE)) {
|
||||
/* timed wait: 250ms */
|
||||
struct timespec ts;
|
||||
clock_gettime(CLOCK_REALTIME, &ts);
|
||||
ts.tv_nsec += 250000000;
|
||||
if (ts.tv_nsec >= 1000000000) {
|
||||
ts.tv_sec += 1;
|
||||
ts.tv_nsec -= 1000000000;
|
||||
}
|
||||
|
||||
int rc = sem_timedwait(g_reqSem, &ts);
|
||||
if (rc != 0) {
|
||||
if (errno == ETIMEDOUT) continue;
|
||||
break;
|
||||
}
|
||||
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
switch (static_cast<RcxRpcCommand>(hdr->command)) {
|
||||
case RPC_CMD_READ_BATCH: handle_read_batch(hdr, data); break;
|
||||
case RPC_CMD_WRITE: handle_write(hdr, data); break;
|
||||
case RPC_CMD_ENUM_MODULES: handle_enum_modules(hdr, data); break;
|
||||
case RPC_CMD_PING: break;
|
||||
case RPC_CMD_SHUTDOWN:
|
||||
__atomic_store_n(&g_shutdown, 1, __ATOMIC_RELEASE);
|
||||
break;
|
||||
default:
|
||||
hdr->status = RCX_RPC_STATUS_ERROR;
|
||||
break;
|
||||
}
|
||||
|
||||
sem_post(g_rspSem);
|
||||
|
||||
if (static_cast<RcxRpcCommand>(hdr->command) == RPC_CMD_SHUTDOWN)
|
||||
break;
|
||||
}
|
||||
|
||||
__atomic_store_n(&hdr->payloadReady, 0, __ATOMIC_RELEASE);
|
||||
__atomic_store_n(&g_threadRunning, 0, __ATOMIC_RELEASE);
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
/* ── init / cleanup ───────────────────────────────────────────────── */
|
||||
|
||||
static void payload_cleanup()
|
||||
{
|
||||
__atomic_store_n(&g_shutdown, 1, __ATOMIC_RELEASE);
|
||||
|
||||
/* wake the thread if blocked */
|
||||
if (g_reqSem != SEM_FAILED) sem_post(g_reqSem);
|
||||
|
||||
if (__atomic_load_n(&g_threadRunning, __ATOMIC_ACQUIRE)) {
|
||||
struct timespec ts;
|
||||
clock_gettime(CLOCK_REALTIME, &ts);
|
||||
ts.tv_sec += 2;
|
||||
pthread_timedjoin_np(g_thread, nullptr, &ts);
|
||||
}
|
||||
|
||||
if (g_mappedView && g_mappedView != MAP_FAILED) {
|
||||
munmap(g_mappedView, RCX_RPC_SHM_SIZE);
|
||||
g_mappedView = nullptr;
|
||||
}
|
||||
if (g_shmFd >= 0) { close(g_shmFd); g_shmFd = -1; }
|
||||
if (g_reqSem != SEM_FAILED) { sem_close(g_reqSem); g_reqSem = SEM_FAILED; }
|
||||
if (g_rspSem != SEM_FAILED) { sem_close(g_rspSem); g_rspSem = SEM_FAILED; }
|
||||
|
||||
/* unlink named objects */
|
||||
if (g_shmName[0]) shm_unlink(g_shmName);
|
||||
if (g_reqName[0]) sem_unlink(g_reqName);
|
||||
if (g_rspName[0]) sem_unlink(g_rspName);
|
||||
|
||||
if (g_memFd >= 0) { close(g_memFd); g_memFd = -1; }
|
||||
}
|
||||
|
||||
__attribute__((constructor))
|
||||
static void payload_init()
|
||||
{
|
||||
uint32_t pid = (uint32_t)getpid();
|
||||
|
||||
/* ── open /proc/self/mem for safe access ── */
|
||||
g_memFd = open("/proc/self/mem", O_RDWR);
|
||||
if (g_memFd < 0) return;
|
||||
|
||||
/* ── create main shared memory (PID-only naming) ── */
|
||||
rcx_rpc_shm_name(g_shmName, sizeof(g_shmName), pid);
|
||||
rcx_rpc_req_name(g_reqName, sizeof(g_reqName), pid);
|
||||
rcx_rpc_rsp_name(g_rspName, sizeof(g_rspName), pid);
|
||||
|
||||
g_shmFd = shm_open(g_shmName, O_CREAT | O_RDWR, 0600);
|
||||
if (g_shmFd < 0) return;
|
||||
if (ftruncate(g_shmFd, RCX_RPC_SHM_SIZE) != 0) {
|
||||
close(g_shmFd); g_shmFd = -1; return;
|
||||
}
|
||||
|
||||
g_mappedView = mmap(nullptr, RCX_RPC_SHM_SIZE, PROT_READ | PROT_WRITE,
|
||||
MAP_SHARED, g_shmFd, 0);
|
||||
if (g_mappedView == MAP_FAILED) {
|
||||
g_mappedView = nullptr;
|
||||
close(g_shmFd); g_shmFd = -1;
|
||||
return;
|
||||
}
|
||||
|
||||
memset(g_mappedView, 0, RCX_RPC_HEADER_SIZE);
|
||||
auto* hdr = static_cast<RcxRpcHeader*>(g_mappedView);
|
||||
hdr->version = RCX_RPC_VERSION;
|
||||
|
||||
/* image base from /proc/self/maps: first executable mapping */
|
||||
{
|
||||
FILE* f = fopen("/proc/self/maps", "r");
|
||||
if (f) {
|
||||
char line[256];
|
||||
while (fgets(line, sizeof(line), f)) {
|
||||
uint64_t start;
|
||||
char perms[8] = {};
|
||||
if (sscanf(line, "%lx-%*x %7s", &start, perms) >= 2 && perms[2] == 'x') {
|
||||
hdr->imageBase = start;
|
||||
break;
|
||||
}
|
||||
}
|
||||
fclose(f);
|
||||
}
|
||||
}
|
||||
|
||||
/* ── create semaphores ── */
|
||||
g_reqSem = sem_open(g_reqName, O_CREAT, 0600, 0);
|
||||
g_rspSem = sem_open(g_rspName, O_CREAT, 0600, 0);
|
||||
if (g_reqSem == SEM_FAILED || g_rspSem == SEM_FAILED) {
|
||||
payload_cleanup();
|
||||
return;
|
||||
}
|
||||
|
||||
/* ── start server thread (it will set payloadReady = 1) ── */
|
||||
__atomic_store_n(&g_threadRunning, 1, __ATOMIC_RELEASE);
|
||||
if (pthread_create(&g_thread, nullptr, server_thread_func, nullptr) != 0) {
|
||||
__atomic_store_n(&g_threadRunning, 0, __ATOMIC_RELEASE);
|
||||
payload_cleanup();
|
||||
return;
|
||||
}
|
||||
pthread_detach(g_thread);
|
||||
}
|
||||
|
||||
__attribute__((destructor))
|
||||
static void payload_deinit()
|
||||
{
|
||||
payload_cleanup();
|
||||
}
|
||||
|
||||
#endif /* _WIN32 / linux */
|
||||
113
plugins/RemoteProcessMemory/rcx_rpc_protocol.h
Normal file
113
plugins/RemoteProcessMemory/rcx_rpc_protocol.h
Normal file
@@ -0,0 +1,113 @@
|
||||
/*
|
||||
* RCX RPC Protocol -- shared between plugin DLL and payload DLL/SO.
|
||||
* No dependencies beyond standard C headers.
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdio.h>
|
||||
#include <string.h>
|
||||
|
||||
/* ── constants ─────────────────────────────────────────────────────── */
|
||||
#define RCX_RPC_VERSION 1
|
||||
#define RCX_RPC_MAX_BATCH 256
|
||||
#define RCX_RPC_SHM_SIZE (1024 * 1024) /* 1 MB */
|
||||
#define RCX_RPC_HEADER_SIZE 4096
|
||||
#define RCX_RPC_DATA_OFFSET RCX_RPC_HEADER_SIZE
|
||||
#define RCX_RPC_DATA_SIZE (RCX_RPC_SHM_SIZE - RCX_RPC_DATA_OFFSET)
|
||||
|
||||
/* status codes */
|
||||
#define RCX_RPC_STATUS_OK 0
|
||||
#define RCX_RPC_STATUS_ERROR 1
|
||||
#define RCX_RPC_STATUS_PARTIAL 2
|
||||
|
||||
/* ── commands ──────────────────────────────────────────────────────── */
|
||||
#ifdef __cplusplus
|
||||
enum RcxRpcCommand : uint32_t {
|
||||
#else
|
||||
typedef uint32_t RcxRpcCommand;
|
||||
enum {
|
||||
#endif
|
||||
RPC_CMD_NONE = 0,
|
||||
RPC_CMD_READ_BATCH = 1, /* batch read: N {address, length} pairs */
|
||||
RPC_CMD_WRITE = 2, /* single write */
|
||||
RPC_CMD_ENUM_MODULES = 3, /* enumerate loaded modules */
|
||||
RPC_CMD_PING = 4, /* heartbeat */
|
||||
RPC_CMD_SHUTDOWN = 5, /* graceful teardown */
|
||||
};
|
||||
|
||||
/* ── wire structs (natural alignment, verified by static_assert) ─── */
|
||||
|
||||
struct RcxRpcReadEntry {
|
||||
uint64_t address;
|
||||
uint32_t length;
|
||||
uint32_t dataOffset; /* offset into data region for response bytes */
|
||||
};
|
||||
|
||||
struct RcxRpcModuleEntry {
|
||||
uint64_t base;
|
||||
uint64_t size;
|
||||
uint32_t nameOffset; /* offset into data region, UTF-16 on Win, UTF-8 on Linux */
|
||||
uint32_t nameLength; /* in bytes */
|
||||
};
|
||||
|
||||
/*
|
||||
* Header -- lives at shared-memory offset 0, padded to 4096 bytes.
|
||||
*
|
||||
* offset field
|
||||
* ------ -----
|
||||
* 0 version (4)
|
||||
* 4 payloadReady (4)
|
||||
* 8 command (4)
|
||||
* 12 requestCount (4)
|
||||
* 16 writeAddress (8)
|
||||
* 24 writeLength (4)
|
||||
* 28 status (4)
|
||||
* 32 responseCount (4)
|
||||
* 36 totalDataUsed (4)
|
||||
* 40 imageBase (8) -- main module base from PEB / procfs
|
||||
* 48 _pad[4048]
|
||||
*/
|
||||
struct RcxRpcHeader {
|
||||
uint32_t version;
|
||||
uint32_t payloadReady; /* payload sets to 1 after init */
|
||||
uint32_t command; /* RcxRpcCommand */
|
||||
uint32_t requestCount;
|
||||
uint64_t writeAddress;
|
||||
uint32_t writeLength;
|
||||
uint32_t status; /* RCX_RPC_STATUS_* */
|
||||
uint32_t responseCount;
|
||||
uint32_t totalDataUsed;
|
||||
uint64_t imageBase; /* main module base (PEB on Win, /proc on Linux) */
|
||||
uint8_t _pad[RCX_RPC_HEADER_SIZE - 48];
|
||||
};
|
||||
|
||||
/* ── name formatting helpers (PID-only, no nonce) ─────────────────── */
|
||||
|
||||
static inline void rcx_rpc_shm_name(char* buf, int n, uint32_t pid) {
|
||||
#ifdef _WIN32
|
||||
snprintf(buf, n, "Local\\RCX_SHM_%u", pid);
|
||||
#else
|
||||
snprintf(buf, n, "/rcx_shm_%u", pid);
|
||||
#endif
|
||||
}
|
||||
|
||||
static inline void rcx_rpc_req_name(char* buf, int n, uint32_t pid) {
|
||||
#ifdef _WIN32
|
||||
snprintf(buf, n, "Local\\RCX_REQ_%u", pid);
|
||||
#else
|
||||
snprintf(buf, n, "/rcx_req_%u", pid);
|
||||
#endif
|
||||
}
|
||||
|
||||
static inline void rcx_rpc_rsp_name(char* buf, int n, uint32_t pid) {
|
||||
#ifdef _WIN32
|
||||
snprintf(buf, n, "Local\\RCX_RSP_%u", pid);
|
||||
#else
|
||||
snprintf(buf, n, "/rcx_rsp_%u", pid);
|
||||
#endif
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
static_assert(sizeof(RcxRpcHeader) == RCX_RPC_HEADER_SIZE, "Header must be 4096 bytes");
|
||||
#endif
|
||||
593
plugins/RemoteProcessMemory/tests/test_rpc_client.cpp
Normal file
593
plugins/RemoteProcessMemory/tests/test_rpc_client.cpp
Normal file
@@ -0,0 +1,593 @@
|
||||
/*
|
||||
* test_rpc_client -- connects to a running test_rpc_host (or spawns one),
|
||||
* exercises every RPC command, and benchmarks throughput.
|
||||
*
|
||||
* Usage:
|
||||
* test_rpc_client (auto-spawn host)
|
||||
* test_rpc_client <pid> [testbuf_hex testlen]
|
||||
*/
|
||||
|
||||
#include "../rcx_rpc_protocol.h"
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <stdint.h>
|
||||
#include <assert.h>
|
||||
#include <chrono>
|
||||
|
||||
#ifdef _WIN32
|
||||
# define WIN32_LEAN_AND_MEAN
|
||||
# include <windows.h>
|
||||
#else
|
||||
# include <unistd.h>
|
||||
# include <fcntl.h>
|
||||
# include <sys/mman.h>
|
||||
# include <semaphore.h>
|
||||
# include <libgen.h>
|
||||
# include <limits.h>
|
||||
#endif
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* Minimal standalone IPC client (no Qt, mirrors plugin's IpcClient)
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
struct TestIpcClient {
|
||||
#ifdef _WIN32
|
||||
HANDLE hShm = nullptr;
|
||||
HANDLE hReqEvent = nullptr;
|
||||
HANDLE hRspEvent = nullptr;
|
||||
#else
|
||||
int shmFd = -1;
|
||||
sem_t* reqSem = SEM_FAILED;
|
||||
sem_t* rspSem = SEM_FAILED;
|
||||
#endif
|
||||
void* view = nullptr;
|
||||
bool ok = false;
|
||||
|
||||
bool connect(uint32_t pid, int timeoutMs = 5000)
|
||||
{
|
||||
char shmName[128], reqName[128], rspName[128];
|
||||
rcx_rpc_shm_name(shmName, sizeof(shmName), pid);
|
||||
rcx_rpc_req_name(reqName, sizeof(reqName), pid);
|
||||
rcx_rpc_rsp_name(rspName, sizeof(rspName), pid);
|
||||
|
||||
#ifdef _WIN32
|
||||
ULONGLONG deadline = GetTickCount64() + (ULONGLONG)timeoutMs;
|
||||
while (!(hShm = OpenFileMappingA(FILE_MAP_ALL_ACCESS, FALSE, shmName))) {
|
||||
if (GetTickCount64() >= deadline) return false;
|
||||
Sleep(10);
|
||||
}
|
||||
view = MapViewOfFile(hShm, FILE_MAP_ALL_ACCESS, 0, 0, RCX_RPC_SHM_SIZE);
|
||||
if (!view) { CloseHandle(hShm); hShm = nullptr; return false; }
|
||||
|
||||
hReqEvent = OpenEventA(EVENT_ALL_ACCESS, FALSE, reqName);
|
||||
hRspEvent = OpenEventA(EVENT_ALL_ACCESS, FALSE, rspName);
|
||||
if (!hReqEvent || !hRspEvent) return false;
|
||||
#else
|
||||
auto start = std::chrono::steady_clock::now();
|
||||
while (true) {
|
||||
shmFd = shm_open(shmName, O_RDWR, 0);
|
||||
if (shmFd >= 0) break;
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start).count();
|
||||
if (elapsed >= timeoutMs) return false;
|
||||
usleep(10000);
|
||||
}
|
||||
view = mmap(nullptr, RCX_RPC_SHM_SIZE, PROT_READ | PROT_WRITE,
|
||||
MAP_SHARED, shmFd, 0);
|
||||
if (view == MAP_FAILED) { view = nullptr; close(shmFd); shmFd = -1; return false; }
|
||||
|
||||
reqSem = sem_open(reqName, 0);
|
||||
rspSem = sem_open(rspName, 0);
|
||||
if (reqSem == SEM_FAILED || rspSem == SEM_FAILED) return false;
|
||||
#endif
|
||||
/* wait for payloadReady */
|
||||
auto* hdr = (RcxRpcHeader*)view;
|
||||
#ifdef _WIN32
|
||||
while (!hdr->payloadReady) {
|
||||
if (GetTickCount64() >= deadline) return false;
|
||||
Sleep(5);
|
||||
}
|
||||
#else
|
||||
while (!__atomic_load_n(&hdr->payloadReady, __ATOMIC_ACQUIRE)) {
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
|
||||
std::chrono::steady_clock::now() - start).count();
|
||||
if (elapsed >= timeoutMs) return false;
|
||||
usleep(5000);
|
||||
}
|
||||
#endif
|
||||
ok = true;
|
||||
return true;
|
||||
}
|
||||
|
||||
void disconnect()
|
||||
{
|
||||
#ifdef _WIN32
|
||||
if (view) { UnmapViewOfFile(view); view = nullptr; }
|
||||
if (hShm) { CloseHandle(hShm); hShm = nullptr; }
|
||||
if (hReqEvent) { CloseHandle(hReqEvent); hReqEvent = nullptr; }
|
||||
if (hRspEvent) { CloseHandle(hRspEvent); hRspEvent = nullptr; }
|
||||
#else
|
||||
if (view) { munmap(view, RCX_RPC_SHM_SIZE); view = nullptr; }
|
||||
if (shmFd >= 0) { close(shmFd); shmFd = -1; }
|
||||
if (reqSem != SEM_FAILED) { sem_close(reqSem); reqSem = SEM_FAILED; }
|
||||
if (rspSem != SEM_FAILED) { sem_close(rspSem); rspSem = SEM_FAILED; }
|
||||
#endif
|
||||
ok = false;
|
||||
}
|
||||
|
||||
bool signalAndWait(int timeoutMs = 2000)
|
||||
{
|
||||
#ifdef _WIN32
|
||||
SetEvent(hReqEvent);
|
||||
return WaitForSingleObject(hRspEvent, (DWORD)timeoutMs) == WAIT_OBJECT_0;
|
||||
#else
|
||||
sem_post(reqSem);
|
||||
struct timespec ts;
|
||||
clock_gettime(CLOCK_REALTIME, &ts);
|
||||
ts.tv_sec += timeoutMs / 1000;
|
||||
ts.tv_nsec += (timeoutMs % 1000) * 1000000L;
|
||||
if (ts.tv_nsec >= 1000000000L) { ts.tv_sec++; ts.tv_nsec -= 1000000000L; }
|
||||
return sem_timedwait(rspSem, &ts) == 0;
|
||||
#endif
|
||||
}
|
||||
|
||||
/* ── RPC helpers ──────────────────────────────────────────────── */
|
||||
|
||||
bool rpc_ping()
|
||||
{
|
||||
auto* hdr = (RcxRpcHeader*)view;
|
||||
hdr->command = RPC_CMD_PING;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
return signalAndWait();
|
||||
}
|
||||
|
||||
bool rpc_read(uint64_t addr, void* buf, uint32_t len)
|
||||
{
|
||||
auto* hdr = (RcxRpcHeader*)view;
|
||||
auto* data = (uint8_t*)view + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->command = RPC_CMD_READ_BATCH;
|
||||
hdr->requestCount = 1;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
auto* entry = (RcxRpcReadEntry*)data;
|
||||
entry->address = addr;
|
||||
entry->length = len;
|
||||
entry->dataOffset = sizeof(RcxRpcReadEntry);
|
||||
|
||||
if (!signalAndWait()) return false;
|
||||
memcpy(buf, data + entry->dataOffset, len);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool rpc_read_batch(const uint64_t* addrs, const uint32_t* lens,
|
||||
uint32_t count, uint8_t* outBuf)
|
||||
{
|
||||
auto* hdr = (RcxRpcHeader*)view;
|
||||
auto* data = (uint8_t*)view + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->command = RPC_CMD_READ_BATCH;
|
||||
hdr->requestCount = count;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
/* lay out entries, then data offsets after all entries */
|
||||
uint32_t entriesSize = count * (uint32_t)sizeof(RcxRpcReadEntry);
|
||||
uint32_t dataOff = entriesSize;
|
||||
|
||||
for (uint32_t i = 0; i < count; ++i) {
|
||||
auto* e = (RcxRpcReadEntry*)(data + i * sizeof(RcxRpcReadEntry));
|
||||
e->address = addrs[i];
|
||||
e->length = lens[i];
|
||||
e->dataOffset = dataOff;
|
||||
dataOff += lens[i];
|
||||
}
|
||||
|
||||
if (!signalAndWait()) return false;
|
||||
|
||||
/* copy out response data */
|
||||
uint32_t off = 0;
|
||||
for (uint32_t i = 0; i < count; ++i) {
|
||||
auto* e = (RcxRpcReadEntry*)(data + i * sizeof(RcxRpcReadEntry));
|
||||
memcpy(outBuf + off, data + e->dataOffset, e->length);
|
||||
off += e->length;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool rpc_write(uint64_t addr, const void* buf, uint32_t len)
|
||||
{
|
||||
auto* hdr = (RcxRpcHeader*)view;
|
||||
auto* data = (uint8_t*)view + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->command = RPC_CMD_WRITE;
|
||||
hdr->writeAddress = addr;
|
||||
hdr->writeLength = len;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
memcpy(data, buf, len);
|
||||
|
||||
if (!signalAndWait()) return false;
|
||||
return hdr->status == RCX_RPC_STATUS_OK;
|
||||
}
|
||||
|
||||
struct ModInfo { uint64_t base; uint64_t size; char name[256]; };
|
||||
|
||||
int rpc_enum_modules(ModInfo* out, int maxOut)
|
||||
{
|
||||
auto* hdr = (RcxRpcHeader*)view;
|
||||
auto* data = (uint8_t*)view + RCX_RPC_DATA_OFFSET;
|
||||
|
||||
hdr->command = RPC_CMD_ENUM_MODULES;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
|
||||
if (!signalAndWait()) return -1;
|
||||
if (hdr->status != RCX_RPC_STATUS_OK) return -1;
|
||||
|
||||
int count = (int)hdr->responseCount;
|
||||
if (count > maxOut) count = maxOut;
|
||||
|
||||
for (int i = 0; i < count; ++i) {
|
||||
auto* entry = (RcxRpcModuleEntry*)(data + i * sizeof(RcxRpcModuleEntry));
|
||||
out[i].base = entry->base;
|
||||
out[i].size = entry->size;
|
||||
#ifdef _WIN32
|
||||
/* names are UTF-16 on Windows */
|
||||
int wchars = (int)(entry->nameLength / sizeof(wchar_t));
|
||||
WideCharToMultiByte(CP_UTF8, 0,
|
||||
(const wchar_t*)(data + entry->nameOffset), wchars,
|
||||
out[i].name, 255, nullptr, nullptr);
|
||||
out[i].name[255] = '\0';
|
||||
#else
|
||||
int nLen = (int)entry->nameLength;
|
||||
if (nLen > 255) nLen = 255;
|
||||
memcpy(out[i].name, data + entry->nameOffset, nLen);
|
||||
out[i].name[nLen] = '\0';
|
||||
#endif
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
void rpc_shutdown()
|
||||
{
|
||||
auto* hdr = (RcxRpcHeader*)view;
|
||||
hdr->command = RPC_CMD_SHUTDOWN;
|
||||
hdr->status = RCX_RPC_STATUS_OK;
|
||||
signalAndWait(500);
|
||||
}
|
||||
};
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* Auto-spawn host
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
#ifdef _WIN32
|
||||
static HANDLE g_hostProcess = nullptr;
|
||||
#else
|
||||
static pid_t g_hostPid = 0;
|
||||
#endif
|
||||
static FILE* g_hostPipe = nullptr;
|
||||
|
||||
static bool spawn_host(uint32_t* outPid,
|
||||
uint64_t* outTestBuf, uint32_t* outTestLen)
|
||||
{
|
||||
/* resolve path to test_rpc_host next to ourselves */
|
||||
char cmd[2048];
|
||||
#ifdef _WIN32
|
||||
char exePath[MAX_PATH];
|
||||
GetModuleFileNameA(nullptr, exePath, MAX_PATH);
|
||||
char* slash = strrchr(exePath, '\\');
|
||||
if (!slash) slash = strrchr(exePath, '/');
|
||||
if (slash) *(slash + 1) = '\0';
|
||||
snprintf(cmd, sizeof(cmd), "\"%stest_rpc_host.exe\" autotest", exePath);
|
||||
g_hostPipe = _popen(cmd, "r");
|
||||
#else
|
||||
char exePath[PATH_MAX];
|
||||
ssize_t n = readlink("/proc/self/exe", exePath, sizeof(exePath) - 1);
|
||||
if (n <= 0) return false;
|
||||
exePath[n] = '\0';
|
||||
char* dir = dirname(exePath);
|
||||
snprintf(cmd, sizeof(cmd), "%s/test_rpc_host autotest", dir);
|
||||
g_hostPipe = popen(cmd, "r");
|
||||
#endif
|
||||
if (!g_hostPipe) {
|
||||
fprintf(stderr, "ERROR: cannot spawn host: %s\n", cmd);
|
||||
return false;
|
||||
}
|
||||
|
||||
/* read READY line */
|
||||
char line[512];
|
||||
if (!fgets(line, sizeof(line), g_hostPipe)) {
|
||||
fprintf(stderr, "ERROR: no output from host\n");
|
||||
return false;
|
||||
}
|
||||
|
||||
/* parse: READY pid=X testbuf=0xZ testlen=N */
|
||||
unsigned long long tbuf = 0;
|
||||
unsigned tlen = 0;
|
||||
if (sscanf(line, "READY pid=%u testbuf=0x%llx testlen=%u",
|
||||
outPid, &tbuf, &tlen) < 1) {
|
||||
fprintf(stderr, "ERROR: cannot parse host output: %s\n", line);
|
||||
return false;
|
||||
}
|
||||
*outTestBuf = (uint64_t)tbuf;
|
||||
*outTestLen = (uint32_t)tlen;
|
||||
return true;
|
||||
}
|
||||
|
||||
static void cleanup_host()
|
||||
{
|
||||
if (g_hostPipe) {
|
||||
#ifdef _WIN32
|
||||
_pclose(g_hostPipe);
|
||||
#else
|
||||
pclose(g_hostPipe);
|
||||
#endif
|
||||
g_hostPipe = nullptr;
|
||||
}
|
||||
}
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* Printing helpers
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
static void print_pass(const char* name) { printf(" [PASS] %s\n", name); }
|
||||
static void print_fail(const char* name) { printf(" [FAIL] %s\n", name); exit(1); }
|
||||
|
||||
/* ══════════════════════════════════════════════════════════════════════
|
||||
* main
|
||||
* ══════════════════════════════════════════════════════════════════════ */
|
||||
|
||||
int main(int argc, char** argv)
|
||||
{
|
||||
uint32_t pid = 0;
|
||||
uint64_t testBuf = 0;
|
||||
uint32_t testLen = 0;
|
||||
bool autoMode = false;
|
||||
|
||||
if (argc >= 2) {
|
||||
pid = (uint32_t)atoi(argv[1]);
|
||||
if (argc >= 4) {
|
||||
testBuf = (uint64_t)strtoull(argv[2], nullptr, 0);
|
||||
testLen = (uint32_t)atoi(argv[3]);
|
||||
}
|
||||
} else {
|
||||
autoMode = true;
|
||||
printf("Auto-spawning test_rpc_host...\n");
|
||||
if (!spawn_host(&pid, &testBuf, &testLen)) return 1;
|
||||
}
|
||||
|
||||
printf("Connecting to PID=%u testbuf=0x%llx testlen=%u\n\n",
|
||||
pid, (unsigned long long)testBuf, testLen);
|
||||
|
||||
/* ── connect ── */
|
||||
TestIpcClient ipc;
|
||||
if (!ipc.connect(pid)) {
|
||||
fprintf(stderr, "ERROR: IPC connect failed\n");
|
||||
if (autoMode) cleanup_host();
|
||||
return 1;
|
||||
}
|
||||
printf("=== Functional Tests ===\n");
|
||||
|
||||
/* ── test: ping ── */
|
||||
if (ipc.rpc_ping()) print_pass("Ping");
|
||||
else print_fail("Ping");
|
||||
|
||||
/* ── test: enumerate modules ── */
|
||||
TestIpcClient::ModInfo mods[512];
|
||||
int modCount = ipc.rpc_enum_modules(mods, 512);
|
||||
if (modCount > 0) {
|
||||
printf(" [PASS] EnumModules (%d modules)\n", modCount);
|
||||
printf(" first: %s base=0x%llx size=0x%llx\n",
|
||||
mods[0].name,
|
||||
(unsigned long long)mods[0].base,
|
||||
(unsigned long long)mods[0].size);
|
||||
} else {
|
||||
print_fail("EnumModules");
|
||||
}
|
||||
|
||||
/* ── test: read module header (MZ / ELF magic) ── */
|
||||
if (modCount > 0) {
|
||||
uint8_t header[4] = {};
|
||||
if (ipc.rpc_read(mods[0].base, header, 4)) {
|
||||
#ifdef _WIN32
|
||||
if (header[0] == 'M' && header[1] == 'Z')
|
||||
print_pass("ReadModuleHeader (MZ)");
|
||||
else
|
||||
print_fail("ReadModuleHeader (expected MZ)");
|
||||
#else
|
||||
if (header[0] == 0x7F && header[1] == 'E' &&
|
||||
header[2] == 'L' && header[3] == 'F')
|
||||
print_pass("ReadModuleHeader (ELF)");
|
||||
else
|
||||
print_fail("ReadModuleHeader (expected ELF)");
|
||||
#endif
|
||||
} else {
|
||||
print_fail("ReadModuleHeader (read failed)");
|
||||
}
|
||||
}
|
||||
|
||||
/* ── test: read test buffer (known pattern) ── */
|
||||
if (testBuf && testLen >= 4096) {
|
||||
uint8_t buf[4096];
|
||||
if (ipc.rpc_read(testBuf, buf, 4096)) {
|
||||
bool good = true;
|
||||
for (int i = 0; i < 4096; ++i) {
|
||||
if (buf[i] != (uint8_t)(i & 0xFF)) { good = false; break; }
|
||||
}
|
||||
if (good) print_pass("ReadTestBuffer (4096 bytes, pattern verified)");
|
||||
else print_fail("ReadTestBuffer (pattern mismatch)");
|
||||
} else {
|
||||
print_fail("ReadTestBuffer (read failed)");
|
||||
}
|
||||
}
|
||||
|
||||
/* ── test: write ── */
|
||||
if (testBuf && testLen >= 16) {
|
||||
uint8_t patch[4] = {0xDE, 0xAD, 0xBE, 0xEF};
|
||||
if (ipc.rpc_write(testBuf, patch, 4)) {
|
||||
uint8_t verify[4] = {};
|
||||
ipc.rpc_read(testBuf, verify, 4);
|
||||
if (memcmp(verify, patch, 4) == 0)
|
||||
print_pass("Write + ReadBack (0xDEADBEEF)");
|
||||
else
|
||||
print_fail("Write + ReadBack (readback mismatch)");
|
||||
} else {
|
||||
print_fail("Write (write failed)");
|
||||
}
|
||||
}
|
||||
|
||||
/* ── test: batch read ── */
|
||||
if (testBuf && testLen >= 8192) {
|
||||
const uint32_t N = 4;
|
||||
uint64_t addrs[N];
|
||||
uint32_t lens[N];
|
||||
for (uint32_t i = 0; i < N; ++i) {
|
||||
addrs[i] = testBuf + i * 1024;
|
||||
lens[i] = 1024;
|
||||
}
|
||||
uint8_t out[4096];
|
||||
if (ipc.rpc_read_batch(addrs, lens, N, out)) {
|
||||
print_pass("BatchRead (4 x 1024 bytes)");
|
||||
} else {
|
||||
print_fail("BatchRead");
|
||||
}
|
||||
}
|
||||
|
||||
printf("\n=== Benchmarks ===\n");
|
||||
|
||||
/* choose a valid address for benchmarking */
|
||||
uint64_t benchAddr = testBuf ? testBuf : (modCount > 0 ? mods[0].base : 0);
|
||||
if (!benchAddr) {
|
||||
printf(" (no valid address for benchmarks, skipping)\n");
|
||||
} else {
|
||||
|
||||
/* ── benchmark: single 4 KB reads ── */
|
||||
{
|
||||
const int ITERS = 10000;
|
||||
const int PAGE = 4096;
|
||||
uint8_t tmp[4096];
|
||||
|
||||
auto t0 = std::chrono::high_resolution_clock::now();
|
||||
for (int i = 0; i < ITERS; ++i)
|
||||
ipc.rpc_read(benchAddr, tmp, PAGE);
|
||||
auto t1 = std::chrono::high_resolution_clock::now();
|
||||
|
||||
double us = (double)std::chrono::duration_cast<std::chrono::microseconds>(t1 - t0).count();
|
||||
double secs = us / 1e6;
|
||||
double totalMB = (double)ITERS * PAGE / (1024.0 * 1024.0);
|
||||
|
||||
printf(" Single 4 KB reads:\n");
|
||||
printf(" Iterations : %d\n", ITERS);
|
||||
printf(" Total data : %.2f MB\n", totalMB);
|
||||
printf(" Wall time : %.3f s\n", secs);
|
||||
printf(" Throughput : %.2f MB/s\n", totalMB / secs);
|
||||
printf(" Avg latency: %.2f us/read\n", us / ITERS);
|
||||
}
|
||||
|
||||
/* ── benchmark: single 64 B reads (pointer-chase-size) ── */
|
||||
{
|
||||
const int ITERS = 50000;
|
||||
const int SZ = 64;
|
||||
uint8_t tmp[64];
|
||||
|
||||
auto t0 = std::chrono::high_resolution_clock::now();
|
||||
for (int i = 0; i < ITERS; ++i)
|
||||
ipc.rpc_read(benchAddr, tmp, SZ);
|
||||
auto t1 = std::chrono::high_resolution_clock::now();
|
||||
|
||||
double us = (double)std::chrono::duration_cast<std::chrono::microseconds>(t1 - t0).count();
|
||||
double secs = us / 1e6;
|
||||
double totalKB = (double)ITERS * SZ / 1024.0;
|
||||
|
||||
printf(" Single 64 B reads (pointer-chase):\n");
|
||||
printf(" Iterations : %d\n", ITERS);
|
||||
printf(" Total data : %.2f KB\n", totalKB);
|
||||
printf(" Wall time : %.3f s\n", secs);
|
||||
printf(" Throughput : %.2f KB/s\n", totalKB / secs);
|
||||
printf(" Avg latency: %.2f us/read\n", us / ITERS);
|
||||
}
|
||||
|
||||
/* ── benchmark: batch read (50 x 4 KB, simulating refresh) ── */
|
||||
{
|
||||
const int ITERS = 2000;
|
||||
const uint32_t BATCH = 50;
|
||||
const uint32_t PAGE = 4096;
|
||||
|
||||
uint64_t addrs[BATCH];
|
||||
uint32_t lens[BATCH];
|
||||
for (uint32_t i = 0; i < BATCH; ++i) {
|
||||
/* wrap within test buffer or module */
|
||||
addrs[i] = benchAddr + (i * PAGE) % 65536;
|
||||
lens[i] = PAGE;
|
||||
}
|
||||
|
||||
/* allocate response buffer */
|
||||
uint8_t* outBuf = (uint8_t*)malloc(BATCH * PAGE);
|
||||
if (!outBuf) {
|
||||
printf(" (batch malloc failed, skipping)\n");
|
||||
} else {
|
||||
auto t0 = std::chrono::high_resolution_clock::now();
|
||||
for (int i = 0; i < ITERS; ++i)
|
||||
ipc.rpc_read_batch(addrs, lens, BATCH, outBuf);
|
||||
auto t1 = std::chrono::high_resolution_clock::now();
|
||||
|
||||
double us = (double)std::chrono::duration_cast<std::chrono::microseconds>(t1 - t0).count();
|
||||
double secs = us / 1e6;
|
||||
double totalMB = (double)ITERS * BATCH * PAGE / (1024.0 * 1024.0);
|
||||
|
||||
printf(" Batch read (%u x %u B, simulating refresh):\n", BATCH, PAGE);
|
||||
printf(" Iterations : %d\n", ITERS);
|
||||
printf(" Total data : %.2f MB\n", totalMB);
|
||||
printf(" Wall time : %.3f s\n", secs);
|
||||
printf(" Throughput : %.2f MB/s\n", totalMB / secs);
|
||||
printf(" Avg latency: %.2f us/batch\n", us / ITERS);
|
||||
printf(" Per-page : %.2f us/page\n", us / (ITERS * BATCH));
|
||||
|
||||
free(outBuf);
|
||||
}
|
||||
}
|
||||
|
||||
/* ── benchmark: write 4 KB ── */
|
||||
if (testBuf && testLen >= 4096) {
|
||||
const int ITERS = 10000;
|
||||
const int PAGE = 4096;
|
||||
uint8_t tmp[4096];
|
||||
memset(tmp, 0x42, sizeof(tmp));
|
||||
|
||||
auto t0 = std::chrono::high_resolution_clock::now();
|
||||
for (int i = 0; i < ITERS; ++i)
|
||||
ipc.rpc_write(testBuf, tmp, PAGE);
|
||||
auto t1 = std::chrono::high_resolution_clock::now();
|
||||
|
||||
double us = (double)std::chrono::duration_cast<std::chrono::microseconds>(t1 - t0).count();
|
||||
double secs = us / 1e6;
|
||||
double totalMB = (double)ITERS * PAGE / (1024.0 * 1024.0);
|
||||
|
||||
printf(" Write 4 KB:\n");
|
||||
printf(" Iterations : %d\n", ITERS);
|
||||
printf(" Total data : %.2f MB\n", totalMB);
|
||||
printf(" Wall time : %.3f s\n", secs);
|
||||
printf(" Throughput : %.2f MB/s\n", totalMB / secs);
|
||||
printf(" Avg latency: %.2f us/write\n", us / ITERS);
|
||||
}
|
||||
}
|
||||
|
||||
/* ── shutdown ── */
|
||||
printf("\nSending shutdown...\n");
|
||||
ipc.rpc_shutdown();
|
||||
ipc.disconnect();
|
||||
|
||||
if (autoMode) {
|
||||
/* wait for host to exit */
|
||||
#ifdef _WIN32
|
||||
Sleep(500);
|
||||
#else
|
||||
usleep(500000);
|
||||
#endif
|
||||
cleanup_host();
|
||||
}
|
||||
|
||||
printf("Done.\n");
|
||||
return 0;
|
||||
}
|
||||
187
plugins/RemoteProcessMemory/tests/test_rpc_host.cpp
Normal file
187
plugins/RemoteProcessMemory/tests/test_rpc_host.cpp
Normal file
@@ -0,0 +1,187 @@
|
||||
/*
|
||||
* test_rpc_host -- loads rcx_payload in-process, acts as the "target".
|
||||
*
|
||||
* Usage: test_rpc_host
|
||||
*
|
||||
* Prints a READY line (machine-parseable), then waits for the payload
|
||||
* to shut down (RPC_CMD_SHUTDOWN from the client).
|
||||
*/
|
||||
|
||||
#include "../rcx_rpc_protocol.h"
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef _WIN32
|
||||
# define WIN32_LEAN_AND_MEAN
|
||||
# include <windows.h>
|
||||
#else
|
||||
# include <unistd.h>
|
||||
# include <dlfcn.h>
|
||||
# include <fcntl.h>
|
||||
# include <sys/mman.h>
|
||||
# include <semaphore.h>
|
||||
# include <libgen.h>
|
||||
# include <limits.h>
|
||||
#endif
|
||||
|
||||
/* ── Helpers ──────────────────────────────────────────────────────── */
|
||||
|
||||
static uint32_t current_pid()
|
||||
{
|
||||
#ifdef _WIN32
|
||||
return (uint32_t)GetCurrentProcessId();
|
||||
#else
|
||||
return (uint32_t)getpid();
|
||||
#endif
|
||||
}
|
||||
|
||||
static void sleep_ms(int ms)
|
||||
{
|
||||
#ifdef _WIN32
|
||||
Sleep((DWORD)ms);
|
||||
#else
|
||||
usleep((useconds_t)ms * 1000);
|
||||
#endif
|
||||
}
|
||||
|
||||
/* Resolve payload path relative to this executable */
|
||||
static int payload_path(char* out, int outLen)
|
||||
{
|
||||
#ifdef _WIN32
|
||||
char exePath[MAX_PATH];
|
||||
GetModuleFileNameA(nullptr, exePath, MAX_PATH);
|
||||
char* slash = strrchr(exePath, '\\');
|
||||
if (!slash) slash = strrchr(exePath, '/');
|
||||
if (slash) *(slash + 1) = '\0';
|
||||
snprintf(out, outLen, "%srcx_payload.dll", exePath);
|
||||
#else
|
||||
char exePath[PATH_MAX];
|
||||
ssize_t n = readlink("/proc/self/exe", exePath, sizeof(exePath) - 1);
|
||||
if (n <= 0) return -1;
|
||||
exePath[n] = '\0';
|
||||
char* dir = dirname(exePath);
|
||||
snprintf(out, outLen, "%s/rcx_payload.so", dir);
|
||||
#endif
|
||||
return 0;
|
||||
}
|
||||
|
||||
/* Open the main shared memory (read-only, just to monitor payloadReady) */
|
||||
static void* open_main_shm(uint32_t pid)
|
||||
{
|
||||
char shmName[128];
|
||||
rcx_rpc_shm_name(shmName, sizeof(shmName), pid);
|
||||
|
||||
#ifdef _WIN32
|
||||
HANDLE h = nullptr;
|
||||
for (int i = 0; i < 500; ++i) {
|
||||
h = OpenFileMappingA(FILE_MAP_READ, FALSE, shmName);
|
||||
if (h) break;
|
||||
sleep_ms(10);
|
||||
}
|
||||
if (!h) return nullptr;
|
||||
void* v = MapViewOfFile(h, FILE_MAP_READ, 0, 0, sizeof(RcxRpcHeader));
|
||||
return v;
|
||||
#else
|
||||
int fd = -1;
|
||||
for (int i = 0; i < 500; ++i) {
|
||||
fd = shm_open(shmName, O_RDONLY, 0);
|
||||
if (fd >= 0) break;
|
||||
sleep_ms(10);
|
||||
}
|
||||
if (fd < 0) return nullptr;
|
||||
void* v = mmap(nullptr, sizeof(RcxRpcHeader), PROT_READ, MAP_SHARED, fd, 0);
|
||||
close(fd);
|
||||
return (v == MAP_FAILED) ? nullptr : v;
|
||||
#endif
|
||||
}
|
||||
|
||||
/* ── Test buffer (known pattern for client to verify reads/writes) ── */
|
||||
static uint8_t g_testBuf[65536];
|
||||
|
||||
/* ── main ─────────────────────────────────────────────────────────── */
|
||||
|
||||
int main(int, char**)
|
||||
{
|
||||
uint32_t pid = current_pid();
|
||||
|
||||
/* fill test buffer with known pattern */
|
||||
for (int i = 0; i < (int)sizeof(g_testBuf); ++i)
|
||||
g_testBuf[i] = (uint8_t)(i & 0xFF);
|
||||
|
||||
/* load payload */
|
||||
char plPath[1024];
|
||||
if (payload_path(plPath, sizeof(plPath)) != 0) {
|
||||
fprintf(stderr, "ERROR: cannot determine payload path\n");
|
||||
return 1;
|
||||
}
|
||||
|
||||
#ifdef _WIN32
|
||||
HMODULE hPayload = LoadLibraryA(plPath);
|
||||
if (!hPayload) {
|
||||
fprintf(stderr, "ERROR: LoadLibrary(%s) failed (%lu)\n",
|
||||
plPath, GetLastError());
|
||||
return 1;
|
||||
}
|
||||
|
||||
/* Call RcxPayloadInit() — DllMain is minimal, init must be explicit */
|
||||
typedef bool (*RcxPayloadInitFn)();
|
||||
auto pfnInit = (RcxPayloadInitFn)GetProcAddress(hPayload, "RcxPayloadInit");
|
||||
if (!pfnInit || !pfnInit()) {
|
||||
fprintf(stderr, "ERROR: RcxPayloadInit() failed or not found\n");
|
||||
FreeLibrary(hPayload);
|
||||
return 1;
|
||||
}
|
||||
#else
|
||||
void* hPayload = dlopen(plPath, RTLD_NOW);
|
||||
if (!hPayload) {
|
||||
fprintf(stderr, "ERROR: dlopen(%s): %s\n", plPath, dlerror());
|
||||
return 1;
|
||||
}
|
||||
#endif
|
||||
|
||||
/* open main shm and wait for payloadReady */
|
||||
void* shmView = open_main_shm(pid);
|
||||
if (!shmView) {
|
||||
fprintf(stderr, "ERROR: failed to open main shared memory\n");
|
||||
return 1;
|
||||
}
|
||||
|
||||
RcxRpcHeader* hdr = (RcxRpcHeader*)shmView;
|
||||
for (int i = 0; i < 500; ++i) {
|
||||
if (hdr->payloadReady) break;
|
||||
sleep_ms(10);
|
||||
}
|
||||
if (!hdr->payloadReady) {
|
||||
fprintf(stderr, "ERROR: payload did not become ready\n");
|
||||
return 1;
|
||||
}
|
||||
|
||||
/* print READY line for the client to parse */
|
||||
printf("READY pid=%u testbuf=0x%llx testlen=%u\n",
|
||||
pid,
|
||||
(unsigned long long)(uintptr_t)g_testBuf,
|
||||
(unsigned)sizeof(g_testBuf));
|
||||
fflush(stdout);
|
||||
|
||||
/* wait until payload shuts down */
|
||||
while (hdr->payloadReady)
|
||||
sleep_ms(100);
|
||||
|
||||
printf("Payload shut down, exiting.\n");
|
||||
|
||||
#ifdef _WIN32
|
||||
/* give the timer queue a moment to drain */
|
||||
Sleep(200);
|
||||
FreeLibrary(hPayload);
|
||||
if (shmView) UnmapViewOfFile(shmView);
|
||||
#else
|
||||
usleep(200000);
|
||||
dlclose(hPayload);
|
||||
if (shmView) munmap(shmView, sizeof(RcxRpcHeader));
|
||||
#endif
|
||||
|
||||
return 0;
|
||||
}
|
||||
@@ -197,53 +197,15 @@ void WinDbgMemoryProvider::querySessionInfo()
|
||||
}
|
||||
}
|
||||
|
||||
if (m_symbols) {
|
||||
ULONG numModules = 0, numUnloaded = 0;
|
||||
hr = m_symbols->GetNumberModules(&numModules, &numUnloaded);
|
||||
qDebug() << "[WinDbg] GetNumberModules hr=" << Qt::hex << (unsigned long)hr
|
||||
<< "loaded=" << numModules << "unloaded=" << numUnloaded;
|
||||
if (SUCCEEDED(hr) && numModules > 0) {
|
||||
char modName[256] = {};
|
||||
ULONG modSize = 0;
|
||||
hr = m_symbols->GetModuleNames(0, 0, nullptr, 0, nullptr,
|
||||
modName, sizeof(modName), &modSize,
|
||||
nullptr, 0, nullptr);
|
||||
if (SUCCEEDED(hr) && modSize > 0)
|
||||
m_name = QString::fromUtf8(modName);
|
||||
}
|
||||
}
|
||||
|
||||
if (m_name.isEmpty())
|
||||
m_name = m_isLive ? QStringLiteral("DbgEng (Live)") : QStringLiteral("DbgEng (Dump)");
|
||||
|
||||
if (m_symbols) {
|
||||
ULONG numModules = 0, numUnloaded = 0;
|
||||
hr = m_symbols->GetNumberModules(&numModules, &numUnloaded);
|
||||
if (SUCCEEDED(hr) && numModules > 0) {
|
||||
ULONG64 moduleBase = 0;
|
||||
hr = m_symbols->GetModuleByIndex(0, &moduleBase);
|
||||
qDebug() << "[WinDbg] Module 0 base=" << Qt::hex << moduleBase;
|
||||
if (SUCCEEDED(hr))
|
||||
m_base = moduleBase;
|
||||
}
|
||||
}
|
||||
|
||||
if (m_base && m_dataSpaces) {
|
||||
uint8_t probe[2] = {};
|
||||
ULONG got = 0;
|
||||
hr = m_dataSpaces->ReadVirtual(m_base, probe, 2, &got);
|
||||
qDebug() << "[WinDbg] Probe read at" << Qt::hex << m_base
|
||||
<< "hr=" << (unsigned long)hr << "got=" << got
|
||||
<< "bytes:" << (int)probe[0] << (int)probe[1];
|
||||
if (FAILED(hr) || got == 0) {
|
||||
qWarning() << "[WinDbg] Probe read FAILED — cleaning up";
|
||||
cleanup();
|
||||
return;
|
||||
}
|
||||
}
|
||||
// WinDbg provides access to the entire virtual address space.
|
||||
// Do NOT auto-select a module as base — let the user set their
|
||||
// own base address. m_base stays 0 so the controller won't
|
||||
// override tree.baseAddress.
|
||||
m_name = m_isLive ? QStringLiteral("WinDbg (Live)")
|
||||
: QStringLiteral("WinDbg (Dump)");
|
||||
|
||||
qDebug() << "[WinDbg] Ready. name=" << m_name
|
||||
<< "base=" << Qt::hex << m_base << "isLive=" << m_isLive;
|
||||
<< "isLive=" << m_isLive;
|
||||
#endif
|
||||
}
|
||||
|
||||
@@ -305,8 +267,18 @@ bool WinDbgMemoryProvider::read(uint64_t addr, void* buf, int len) const
|
||||
dispatchToOwner([&]() {
|
||||
ULONG bytesRead = 0;
|
||||
HRESULT hr = m_dataSpaces->ReadVirtual(addr, buf, (ULONG)len, &bytesRead);
|
||||
if (FAILED(hr) || (int)bytesRead < len)
|
||||
memset((char*)buf + bytesRead, 0, len - bytesRead);
|
||||
if (SUCCEEDED(hr) && (int)bytesRead >= len) {
|
||||
result = true;
|
||||
return;
|
||||
}
|
||||
// Partial or failed read — zero-fill remainder and log
|
||||
memset((char*)buf + bytesRead, 0, len - bytesRead);
|
||||
++m_readFailCount;
|
||||
if (m_readFailCount <= 5 || (m_readFailCount % 100) == 0)
|
||||
qDebug() << "[WinDbg] ReadVirtual FAILED addr=0x" << Qt::hex << addr
|
||||
<< "len=" << Qt::dec << len
|
||||
<< "hr=0x" << Qt::hex << (unsigned long)hr
|
||||
<< "got=" << Qt::dec << bytesRead;
|
||||
result = bytesRead > 0;
|
||||
});
|
||||
return result;
|
||||
|
||||
@@ -83,6 +83,7 @@ private:
|
||||
bool m_isLive = false;
|
||||
bool m_writable = false;
|
||||
bool m_isRemote = false; // true when connected via DebugConnect (tcp/npipe)
|
||||
mutable int m_readFailCount = 0;
|
||||
|
||||
// Dedicated thread for DbgEng COM operations. The remote TCP/pipe
|
||||
// transport is thread-affine — all calls must happen on the thread
|
||||
|
||||
300
src/addressparser.cpp
Normal file
300
src/addressparser.cpp
Normal file
@@ -0,0 +1,300 @@
|
||||
#include "addressparser.h"
|
||||
|
||||
namespace rcx {
|
||||
|
||||
// ── Address Expression Parser ──────────────────────────────────────────
|
||||
//
|
||||
// Parses expressions like:
|
||||
// "7FF66CCE0000" → plain hex address
|
||||
// "0x100 + 0x200" → arithmetic on hex values
|
||||
// "<Program.exe> + 0xDE" → module base + offset
|
||||
// "[<Program.exe> + 0xDE] - AB" → dereference pointer, then subtract
|
||||
// "7ff6`6cce0000" → WinDbg-style backtick separator (stripped before parsing)
|
||||
//
|
||||
// Grammar (standard operator precedence: *, / bind tighter than +, -):
|
||||
//
|
||||
// expr = term (('+' | '-') term)*
|
||||
// term = unary (('*' | '/') unary)*
|
||||
// unary = '-' unary | atom
|
||||
// atom = '[' expr ']' -- read pointer at address (dereference)
|
||||
// | '<' moduleName '>' -- resolve module base address
|
||||
// | '(' expr ')' -- grouping
|
||||
// | hexLiteral -- hex number, optional 0x prefix
|
||||
//
|
||||
// All numeric literals are hexadecimal (base 16).
|
||||
// Module names and pointer reads are resolved via optional callbacks.
|
||||
// Without callbacks, modules and dereferences evaluate to 0 (syntax-check mode).
|
||||
|
||||
class ExpressionParser {
|
||||
public:
|
||||
ExpressionParser(const QString& input, const AddressParserCallbacks* callbacks)
|
||||
: m_input(input), m_callbacks(callbacks) {}
|
||||
|
||||
AddressParseResult parse() {
|
||||
skipSpaces();
|
||||
if (atEnd())
|
||||
return error("empty expression");
|
||||
|
||||
uint64_t value = 0;
|
||||
if (!parseExpression(value))
|
||||
return error(m_error);
|
||||
|
||||
skipSpaces();
|
||||
if (!atEnd())
|
||||
return error(QStringLiteral("unexpected '%1'").arg(m_input[m_pos]));
|
||||
|
||||
return {true, value, {}, -1};
|
||||
}
|
||||
|
||||
private:
|
||||
const QString& m_input;
|
||||
const AddressParserCallbacks* m_callbacks;
|
||||
int m_pos = 0;
|
||||
QString m_error;
|
||||
int m_errorPos = 0;
|
||||
|
||||
// ── Helpers ──
|
||||
|
||||
bool atEnd() const { return m_pos >= m_input.size(); }
|
||||
|
||||
QChar peek() const { return atEnd() ? QChar('\0') : m_input[m_pos]; }
|
||||
|
||||
void advance() { m_pos++; }
|
||||
|
||||
void skipSpaces() {
|
||||
while (!atEnd() && m_input[m_pos].isSpace())
|
||||
m_pos++;
|
||||
}
|
||||
|
||||
AddressParseResult error(const QString& msg) const {
|
||||
return {false, 0, msg, m_errorPos};
|
||||
}
|
||||
|
||||
bool fail(const QString& msg) {
|
||||
m_error = msg;
|
||||
m_errorPos = m_pos;
|
||||
return false;
|
||||
}
|
||||
|
||||
bool expect(QChar ch) {
|
||||
skipSpaces();
|
||||
if (peek() != ch)
|
||||
return fail(QStringLiteral("expected '%1'").arg(ch));
|
||||
advance();
|
||||
return true;
|
||||
}
|
||||
|
||||
static bool isHexDigit(QChar ch) {
|
||||
return (ch >= '0' && ch <= '9')
|
||||
|| (ch >= 'a' && ch <= 'f')
|
||||
|| (ch >= 'A' && ch <= 'F');
|
||||
}
|
||||
|
||||
// ── Recursive descent parsing ──
|
||||
|
||||
// expr = term (('+' | '-') term)*
|
||||
bool parseExpression(uint64_t& result) {
|
||||
if (!parseTerm(result))
|
||||
return false;
|
||||
|
||||
for (;;) {
|
||||
skipSpaces();
|
||||
QChar op = peek();
|
||||
if (op != '+' && op != '-')
|
||||
break;
|
||||
advance();
|
||||
|
||||
uint64_t rhs = 0;
|
||||
if (!parseTerm(rhs))
|
||||
return false;
|
||||
|
||||
result = (op == '+') ? result + rhs : result - rhs;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
// term = unary (('*' | '/') unary)*
|
||||
bool parseTerm(uint64_t& result) {
|
||||
if (!parseUnary(result))
|
||||
return false;
|
||||
|
||||
for (;;) {
|
||||
skipSpaces();
|
||||
QChar op = peek();
|
||||
if (op != '*' && op != '/')
|
||||
break;
|
||||
advance();
|
||||
|
||||
uint64_t rhs = 0;
|
||||
if (!parseUnary(rhs))
|
||||
return false;
|
||||
|
||||
if (op == '*') {
|
||||
result *= rhs;
|
||||
} else {
|
||||
if (rhs == 0)
|
||||
return fail("division by zero");
|
||||
result /= rhs;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
// unary = '-' unary | atom
|
||||
bool parseUnary(uint64_t& result) {
|
||||
skipSpaces();
|
||||
if (peek() == '-') {
|
||||
advance();
|
||||
uint64_t inner = 0;
|
||||
if (!parseUnary(inner))
|
||||
return false;
|
||||
result = static_cast<uint64_t>(-static_cast<int64_t>(inner));
|
||||
return true;
|
||||
}
|
||||
return parseAtom(result);
|
||||
}
|
||||
|
||||
// atom = '[' expr ']' | '<' name '>' | '(' expr ')' | hexLiteral
|
||||
bool parseAtom(uint64_t& result) {
|
||||
skipSpaces();
|
||||
if (atEnd())
|
||||
return fail("unexpected end of expression");
|
||||
|
||||
QChar ch = peek();
|
||||
|
||||
if (ch == '[') return parseDereference(result);
|
||||
if (ch == '<') return parseModuleName(result);
|
||||
if (ch == '(') return parseGrouping(result);
|
||||
return parseHexNumber(result);
|
||||
}
|
||||
|
||||
// '[' expr ']' — read the pointer value at the computed address
|
||||
bool parseDereference(uint64_t& result) {
|
||||
advance(); // skip '['
|
||||
|
||||
uint64_t address = 0;
|
||||
if (!parseExpression(address))
|
||||
return false;
|
||||
if (!expect(']'))
|
||||
return false;
|
||||
|
||||
// Without a callback, just return 0 (syntax-check mode)
|
||||
if (!m_callbacks || !m_callbacks->readPointer) {
|
||||
result = 0;
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ok = false;
|
||||
result = m_callbacks->readPointer(address, &ok);
|
||||
if (!ok)
|
||||
return fail(QStringLiteral("failed to read memory at 0x%1").arg(address, 0, 16));
|
||||
return true;
|
||||
}
|
||||
|
||||
// '<' moduleName '>' — resolve a module's base address (e.g. <Program.exe>)
|
||||
bool parseModuleName(uint64_t& result) {
|
||||
advance(); // skip '<'
|
||||
|
||||
int nameStart = m_pos;
|
||||
while (!atEnd() && peek() != '>')
|
||||
advance();
|
||||
if (atEnd())
|
||||
return fail("expected '>'");
|
||||
|
||||
QString name = m_input.mid(nameStart, m_pos - nameStart).trimmed();
|
||||
advance(); // skip '>'
|
||||
|
||||
if (name.isEmpty())
|
||||
return fail("empty module name");
|
||||
|
||||
// Without a callback, just return 0 (syntax-check mode)
|
||||
if (!m_callbacks || !m_callbacks->resolveModule) {
|
||||
result = 0;
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ok = false;
|
||||
result = m_callbacks->resolveModule(name, &ok);
|
||||
if (!ok)
|
||||
return fail(QStringLiteral("module '%1' not found").arg(name));
|
||||
return true;
|
||||
}
|
||||
|
||||
// '(' expr ')' — parenthesized sub-expression for grouping
|
||||
bool parseGrouping(uint64_t& result) {
|
||||
advance(); // skip '('
|
||||
if (!parseExpression(result))
|
||||
return false;
|
||||
return expect(')');
|
||||
}
|
||||
|
||||
// Hex number with optional "0x" prefix. All literals are base-16.
|
||||
bool parseHexNumber(uint64_t& result) {
|
||||
skipSpaces();
|
||||
if (atEnd())
|
||||
return fail("unexpected end of expression");
|
||||
|
||||
int start = m_pos;
|
||||
|
||||
// Skip optional 0x/0X prefix
|
||||
if (m_pos + 1 < m_input.size()
|
||||
&& m_input[m_pos] == '0'
|
||||
&& (m_input[m_pos + 1] == 'x' || m_input[m_pos + 1] == 'X'))
|
||||
m_pos += 2;
|
||||
|
||||
// Consume hex digits
|
||||
int digitsStart = m_pos;
|
||||
while (!atEnd() && isHexDigit(peek()))
|
||||
advance();
|
||||
|
||||
if (m_pos == digitsStart) {
|
||||
m_errorPos = start;
|
||||
return fail("expected hex number");
|
||||
}
|
||||
|
||||
QString digits = m_input.mid(digitsStart, m_pos - digitsStart);
|
||||
bool ok = false;
|
||||
result = digits.toULongLong(&ok, 16);
|
||||
if (!ok) {
|
||||
m_errorPos = start;
|
||||
return fail("invalid hex number");
|
||||
}
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
// ── Public API ─────────────────────────────────────────────────────────
|
||||
|
||||
AddressParseResult AddressParser::evaluate(const QString& formula, int ptrSize,
|
||||
const AddressParserCallbacks* cb)
|
||||
{
|
||||
Q_UNUSED(ptrSize);
|
||||
|
||||
// WinDbg displays 64-bit addresses with backtick separators for readability,
|
||||
// e.g. "00007ff6`1a2b3c4d". Strip them so users can paste directly.
|
||||
// Also remove ' in case user uses it
|
||||
QString cleaned = formula;
|
||||
cleaned.remove('`');
|
||||
cleaned.remove('\'');
|
||||
|
||||
ExpressionParser parser(cleaned, cb);
|
||||
return parser.parse();
|
||||
}
|
||||
|
||||
QString AddressParser::validate(const QString& formula)
|
||||
{
|
||||
QString cleaned = formula;
|
||||
cleaned.remove('`');
|
||||
cleaned.remove('\'');
|
||||
cleaned = cleaned.trimmed();
|
||||
if (cleaned.isEmpty())
|
||||
return QStringLiteral("empty");
|
||||
|
||||
// Parse with no callbacks — modules and dereferences succeed but return 0.
|
||||
// This checks syntax only.
|
||||
ExpressionParser parser(cleaned, nullptr);
|
||||
auto result = parser.parse();
|
||||
return result.ok ? QString() : result.error;
|
||||
}
|
||||
|
||||
} // namespace rcx
|
||||
27
src/addressparser.h
Normal file
27
src/addressparser.h
Normal file
@@ -0,0 +1,27 @@
|
||||
#pragma once
|
||||
#include <QString>
|
||||
#include <cstdint>
|
||||
#include <functional>
|
||||
|
||||
namespace rcx {
|
||||
|
||||
struct AddressParseResult {
|
||||
bool ok;
|
||||
uint64_t value;
|
||||
QString error;
|
||||
int errorPos;
|
||||
};
|
||||
|
||||
struct AddressParserCallbacks {
|
||||
std::function<uint64_t(const QString& name, bool* ok)> resolveModule;
|
||||
std::function<uint64_t(uint64_t addr, bool* ok)> readPointer;
|
||||
};
|
||||
|
||||
class AddressParser {
|
||||
public:
|
||||
static AddressParseResult evaluate(const QString& formula, int ptrSize = 8,
|
||||
const AddressParserCallbacks* cb = nullptr);
|
||||
static QString validate(const QString& formula);
|
||||
};
|
||||
|
||||
} // namespace rcx
|
||||
@@ -303,6 +303,7 @@ void composeParent(ComposeState& state, const NodeTree& tree,
|
||||
lm.lineKind = LineKind::Field;
|
||||
lm.nodeKind = node.elementKind;
|
||||
lm.isArrayElement = true;
|
||||
lm.arrayElementIdx = i;
|
||||
lm.offsetText = fmt::fmtOffsetMargin(elemAddr, false, state.offsetHexDigits);
|
||||
lm.offsetAddr = elemAddr;
|
||||
lm.ptrBase = state.currentPtrBase;
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include "controller.h"
|
||||
#include "addressparser.h"
|
||||
#include "typeselectorpopup.h"
|
||||
#include "providerregistry.h"
|
||||
#include "themes/thememanager.h"
|
||||
@@ -328,53 +329,29 @@ void RcxController::connectEditor(RcxEditor* editor) {
|
||||
s.remove('`'); // WinDbg backtick separators (e.g. 7ff6`6cce0000)
|
||||
s.remove('\n');
|
||||
s.remove('\r');
|
||||
// Support simple equations: 0x10+0x4, 0x100-0x10, etc.
|
||||
uint64_t newBase = 0;
|
||||
bool ok = true;
|
||||
int pos = 0;
|
||||
bool firstTerm = true;
|
||||
bool adding = true;
|
||||
|
||||
while (pos < s.size() && ok) {
|
||||
// Skip whitespace
|
||||
while (pos < s.size() && s[pos].isSpace()) pos++;
|
||||
if (pos >= s.size()) break;
|
||||
|
||||
// Check for +/- operator (except first term)
|
||||
if (!firstTerm) {
|
||||
if (s[pos] == '+') { adding = true; pos++; }
|
||||
else if (s[pos] == '-') { adding = false; pos++; }
|
||||
else { ok = false; break; }
|
||||
while (pos < s.size() && s[pos].isSpace()) pos++;
|
||||
}
|
||||
|
||||
// Parse hex number (with or without 0x prefix)
|
||||
int start = pos;
|
||||
bool hasPrefix = (pos + 1 < s.size() &&
|
||||
s[pos] == '0' && (s[pos+1] == 'x' || s[pos+1] == 'X'));
|
||||
if (hasPrefix) pos += 2;
|
||||
|
||||
int numStart = pos;
|
||||
while (pos < s.size() && (s[pos].isDigit() ||
|
||||
(s[pos] >= 'a' && s[pos] <= 'f') ||
|
||||
(s[pos] >= 'A' && s[pos] <= 'F'))) pos++;
|
||||
|
||||
if (pos == numStart) { ok = false; break; }
|
||||
|
||||
QString numStr = s.mid(numStart, pos - numStart);
|
||||
uint64_t val = numStr.toULongLong(&ok, 16);
|
||||
if (!ok) break;
|
||||
|
||||
if (adding) newBase += val;
|
||||
else newBase -= val;
|
||||
|
||||
firstTerm = false;
|
||||
AddressParserCallbacks cbs;
|
||||
if (m_doc->provider) {
|
||||
auto* prov = m_doc->provider.get();
|
||||
cbs.resolveModule = [prov](const QString& name, bool* ok) -> uint64_t {
|
||||
uint64_t base = prov->symbolToAddress(name);
|
||||
*ok = (base != 0);
|
||||
return base;
|
||||
};
|
||||
cbs.readPointer = [prov](uint64_t addr, bool* ok) -> uint64_t {
|
||||
uint64_t val = 0;
|
||||
*ok = prov->read(addr, &val, 8);
|
||||
return val;
|
||||
};
|
||||
}
|
||||
|
||||
if (ok && newBase != m_doc->tree.baseAddress) {
|
||||
auto result = AddressParser::evaluate(s, 8, &cbs);
|
||||
if (result.ok && result.value != m_doc->tree.baseAddress) {
|
||||
uint64_t oldBase = m_doc->tree.baseAddress;
|
||||
QString oldFormula = m_doc->tree.baseAddressFormula;
|
||||
// Store formula if input uses module/deref syntax, otherwise clear
|
||||
QString newFormula = (s.contains('<') || s.contains('[')) ? s : QString();
|
||||
m_doc->undoStack.push(new RcxCommand(this,
|
||||
cmd::ChangeBase{oldBase, newBase}));
|
||||
cmd::ChangeBase{oldBase, result.value, oldFormula, newFormula}));
|
||||
}
|
||||
break;
|
||||
}
|
||||
@@ -592,9 +569,9 @@ void RcxController::refresh() {
|
||||
// Prune stale selections (nodes removed by undo/redo/delete)
|
||||
QSet<uint64_t> valid;
|
||||
for (uint64_t id : m_selIds) {
|
||||
uint64_t nodeId = id & ~kFooterIdBit; // Strip footer bit for lookup
|
||||
uint64_t nodeId = id & ~(kFooterIdBit | kArrayElemBit | kArrayElemMask);
|
||||
if (m_doc->tree.indexOfId(nodeId) >= 0)
|
||||
valid.insert(id); // Keep original ID (with footer bit if present)
|
||||
valid.insert(id); // Keep original ID (with footer/array bits if present)
|
||||
}
|
||||
m_selIds = valid;
|
||||
|
||||
@@ -982,6 +959,7 @@ void RcxController::applyCommand(const Command& command, bool isUndo) {
|
||||
clearHistoryForAdjs(c.offAdjs);
|
||||
} else if constexpr (std::is_same_v<T, cmd::ChangeBase>) {
|
||||
tree.baseAddress = isUndo ? c.oldBase : c.newBase;
|
||||
tree.baseAddressFormula = isUndo ? c.oldFormula : c.newFormula;
|
||||
resetSnapshot();
|
||||
} else if constexpr (std::is_same_v<T, cmd::WriteBytes>) {
|
||||
const QByteArray& bytes = isUndo ? c.oldBytes : c.newBytes;
|
||||
@@ -1605,13 +1583,35 @@ void RcxController::showContextMenu(RcxEditor* editor, int line, int nodeIdx,
|
||||
|
||||
// ── Always-available actions ──
|
||||
|
||||
menu.addAction(icon("diff-added.svg"), "Append 128 bytes", [this]() {
|
||||
menu.addAction(icon("diff-added.svg"), "Append bytes...", [this, &menu]() {
|
||||
bool ok;
|
||||
QString input = QInputDialog::getText(menu.parentWidget(),
|
||||
QStringLiteral("Append bytes"),
|
||||
QStringLiteral("Byte count (decimal or 0x hex):"),
|
||||
QLineEdit::Normal, QStringLiteral("128"), &ok);
|
||||
if (!ok || input.trimmed().isEmpty()) return;
|
||||
|
||||
QString trimmed = input.trimmed();
|
||||
int byteCount = 0;
|
||||
if (trimmed.startsWith(QStringLiteral("0x"), Qt::CaseInsensitive))
|
||||
byteCount = trimmed.mid(2).toInt(&ok, 16);
|
||||
else
|
||||
byteCount = trimmed.toInt(&ok, 10);
|
||||
if (!ok || byteCount <= 0) return;
|
||||
|
||||
uint64_t target = m_viewRootId ? m_viewRootId : 0;
|
||||
int hex64Count = byteCount / 8;
|
||||
int remainBytes = byteCount % 8;
|
||||
|
||||
m_suppressRefresh = true;
|
||||
m_doc->undoStack.beginMacro(QStringLiteral("Append 128 bytes"));
|
||||
for (int i = 0; i < 16; i++)
|
||||
m_doc->undoStack.beginMacro(QStringLiteral("Append %1 bytes").arg(byteCount));
|
||||
int idx = 0;
|
||||
for (int i = 0; i < hex64Count; i++, idx++)
|
||||
insertNode(target, -1, NodeKind::Hex64,
|
||||
QStringLiteral("field_%1").arg(i));
|
||||
QStringLiteral("field_%1").arg(idx));
|
||||
for (int i = 0; i < remainBytes; i++, idx++)
|
||||
insertNode(target, -1, NodeKind::Hex8,
|
||||
QStringLiteral("field_%1").arg(idx));
|
||||
m_doc->undoStack.endMacro();
|
||||
m_suppressRefresh = false;
|
||||
refresh();
|
||||
@@ -1696,11 +1696,17 @@ void RcxController::handleNodeClick(RcxEditor* source, int line,
|
||||
bool ctrl = mods & Qt::ControlModifier;
|
||||
bool shift = mods & Qt::ShiftModifier;
|
||||
|
||||
// Compute effective selection ID: footers use nodeId | kFooterIdBit
|
||||
// Compute effective selection ID:
|
||||
// footers → nodeId | kFooterIdBit
|
||||
// array elements → nodeId | kArrayElemBit | (elemIdx << 48)
|
||||
// everything else → nodeId
|
||||
auto effectiveId = [this](int ln, uint64_t nid) -> uint64_t {
|
||||
if (ln >= 0 && ln < m_lastResult.meta.size() &&
|
||||
m_lastResult.meta[ln].lineKind == LineKind::Footer)
|
||||
if (ln < 0 || ln >= m_lastResult.meta.size()) return nid;
|
||||
const auto& lm = m_lastResult.meta[ln];
|
||||
if (lm.lineKind == LineKind::Footer)
|
||||
return nid | kFooterIdBit;
|
||||
if (lm.isArrayElement && lm.arrayElementIdx >= 0)
|
||||
return makeArrayElemSelId(nid, lm.arrayElementIdx);
|
||||
return nid;
|
||||
};
|
||||
|
||||
@@ -1749,8 +1755,8 @@ void RcxController::handleNodeClick(RcxEditor* source, int line,
|
||||
|
||||
if (m_selIds.size() == 1) {
|
||||
uint64_t sid = *m_selIds.begin();
|
||||
// Strip footer bit for node lookup
|
||||
int idx = m_doc->tree.indexOfId(sid & ~kFooterIdBit);
|
||||
// Strip footer/array bits for node lookup
|
||||
int idx = m_doc->tree.indexOfId(sid & ~(kFooterIdBit | kArrayElemBit | kArrayElemMask));
|
||||
if (idx >= 0) emit nodeSelected(idx);
|
||||
}
|
||||
}
|
||||
@@ -1779,30 +1785,15 @@ void RcxController::updateCommandRow() {
|
||||
.arg(provName);
|
||||
}
|
||||
|
||||
// -- Symbol for selected node (getSymbol integration) --
|
||||
QString sym;
|
||||
if (m_selIds.size() == 1) {
|
||||
uint64_t sid = *m_selIds.begin();
|
||||
int idx = m_doc->tree.indexOfId(sid & ~kFooterIdBit);
|
||||
if (idx >= 0) {
|
||||
const auto& node = m_doc->tree.nodes[idx];
|
||||
uint64_t addr = m_doc->tree.baseAddress + m_doc->tree.computeOffset(idx);
|
||||
sym = m_doc->provider->getSymbol(addr);
|
||||
}
|
||||
}
|
||||
QString addr;
|
||||
if (!m_doc->tree.baseAddressFormula.isEmpty())
|
||||
addr = m_doc->tree.baseAddressFormula;
|
||||
else
|
||||
addr = QStringLiteral("0x") +
|
||||
QString::number(m_doc->tree.baseAddress, 16).toUpper();
|
||||
|
||||
QString addr = QStringLiteral("0x") +
|
||||
QString::number(m_doc->tree.baseAddress, 16).toUpper();
|
||||
|
||||
// Build the row. If we have a symbol, append it after the address.
|
||||
QString row;
|
||||
if (sym.isEmpty()) {
|
||||
row = QStringLiteral("%1 \u00B7 %2")
|
||||
.arg(elide(src, 40), elide(addr, 24));
|
||||
} else {
|
||||
row = QStringLiteral("%1 \u00B7 %2 %3")
|
||||
.arg(elide(src, 40), elide(addr, 24), elide(sym, 40));
|
||||
}
|
||||
QString row = QStringLiteral("%1 \u00B7 %2")
|
||||
.arg(elide(src, 40), elide(addr, 24));
|
||||
|
||||
// Build row 2: root class type + name (uses current view root)
|
||||
QString row2;
|
||||
@@ -2335,12 +2326,31 @@ void RcxController::attachViaPlugin(const QString& providerIdentifier, const QSt
|
||||
return;
|
||||
}
|
||||
|
||||
uint64_t newBase = provider->base();
|
||||
m_doc->undoStack.clear();
|
||||
m_doc->provider = std::move(provider);
|
||||
m_doc->dataPath.clear();
|
||||
if (m_doc->tree.baseAddress == 0)
|
||||
m_doc->tree.baseAddress = newBase;
|
||||
// Don't overwrite baseAddress — caller (e.g. selfTest) already set it.
|
||||
// User-initiated source switches go through selectSource() which does update it.
|
||||
|
||||
// Re-evaluate stored formula against the new provider
|
||||
if (!m_doc->tree.baseAddressFormula.isEmpty()) {
|
||||
AddressParserCallbacks cbs;
|
||||
auto* prov = m_doc->provider.get();
|
||||
cbs.resolveModule = [prov](const QString& name, bool* ok) -> uint64_t {
|
||||
uint64_t base = prov->symbolToAddress(name);
|
||||
*ok = (base != 0);
|
||||
return base;
|
||||
};
|
||||
cbs.readPointer = [prov](uint64_t addr, bool* ok) -> uint64_t {
|
||||
uint64_t val = 0;
|
||||
*ok = prov->read(addr, &val, 8);
|
||||
return val;
|
||||
};
|
||||
auto result = AddressParser::evaluate(m_doc->tree.baseAddressFormula, 8, &cbs);
|
||||
if (result.ok)
|
||||
m_doc->tree.baseAddress = result.value;
|
||||
}
|
||||
|
||||
resetSnapshot();
|
||||
emit m_doc->documentChanged();
|
||||
refresh();
|
||||
@@ -2351,8 +2361,10 @@ void RcxController::switchToSavedSource(int idx) {
|
||||
if (idx == m_activeSourceIdx) return;
|
||||
|
||||
// Save current source's base address before switching
|
||||
if (m_activeSourceIdx >= 0 && m_activeSourceIdx < m_savedSources.size())
|
||||
if (m_activeSourceIdx >= 0 && m_activeSourceIdx < m_savedSources.size()) {
|
||||
m_savedSources[m_activeSourceIdx].baseAddress = m_doc->tree.baseAddress;
|
||||
m_savedSources[m_activeSourceIdx].baseAddressFormula = m_doc->tree.baseAddressFormula;
|
||||
}
|
||||
|
||||
m_activeSourceIdx = idx;
|
||||
const auto& entry = m_savedSources[idx];
|
||||
@@ -2360,10 +2372,16 @@ void RcxController::switchToSavedSource(int idx) {
|
||||
if (entry.kind == QStringLiteral("File")) {
|
||||
m_doc->loadData(entry.filePath);
|
||||
m_doc->tree.baseAddress = entry.baseAddress;
|
||||
m_doc->tree.baseAddressFormula = entry.baseAddressFormula;
|
||||
refresh();
|
||||
} else if (!entry.providerTarget.isEmpty()) {
|
||||
// Plugin-based provider (e.g. "processmemory" with target "pid:name")
|
||||
// Restore formula before attach so it can be re-evaluated against the new provider
|
||||
m_doc->tree.baseAddressFormula = entry.baseAddressFormula;
|
||||
attachViaPlugin(entry.kind, entry.providerTarget);
|
||||
// Restore saved base address (user may have navigated away from provider default)
|
||||
if (entry.baseAddress != 0 && entry.baseAddressFormula.isEmpty())
|
||||
m_doc->tree.baseAddress = entry.baseAddress;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2433,8 +2451,7 @@ void RcxController::selectSource(const QString& text) {
|
||||
m_doc->undoStack.clear();
|
||||
m_doc->provider = std::move(provider);
|
||||
m_doc->dataPath.clear();
|
||||
if (m_doc->tree.baseAddress == 0)
|
||||
m_doc->tree.baseAddress = newBase;
|
||||
m_doc->tree.baseAddress = (newBase != 0) ? newBase : m_doc->tree.baseAddress;
|
||||
resetSnapshot();
|
||||
emit m_doc->documentChanged();
|
||||
|
||||
@@ -2478,6 +2495,12 @@ void RcxController::clearSources() {
|
||||
refresh();
|
||||
}
|
||||
|
||||
void RcxController::copySavedSources(const QVector<SavedSourceEntry>& sources, int activeIdx) {
|
||||
m_savedSources = sources;
|
||||
m_activeSourceIdx = activeIdx;
|
||||
pushSavedSourcesToEditors();
|
||||
}
|
||||
|
||||
void RcxController::pushSavedSourcesToEditors() {
|
||||
QVector<SavedSourceDisplay> display;
|
||||
display.reserve(m_savedSources.size());
|
||||
|
||||
@@ -70,6 +70,7 @@ struct SavedSourceEntry {
|
||||
QString filePath; // for File sources
|
||||
QString providerTarget; // for plugin providers (e.g. "pid:name")
|
||||
uint64_t baseAddress = 0;
|
||||
QString baseAddressFormula;
|
||||
};
|
||||
|
||||
// ── Controller ──
|
||||
@@ -130,6 +131,7 @@ public:
|
||||
void switchSource(int idx) { switchToSavedSource(idx); }
|
||||
void clearSources();
|
||||
void selectSource(const QString& text);
|
||||
void copySavedSources(const QVector<SavedSourceEntry>& sources, int activeIdx);
|
||||
|
||||
// Value tracking toggle (per-tab, off by default)
|
||||
bool trackValues() const { return m_trackValues; }
|
||||
|
||||
24
src/core.h
24
src/core.h
@@ -267,6 +267,7 @@ struct Node {
|
||||
struct NodeTree {
|
||||
QVector<Node> nodes;
|
||||
uint64_t baseAddress = 0x00400000;
|
||||
QString baseAddressFormula; // e.g. "<ReClass.exe> + 0x100"
|
||||
uint64_t m_nextId = 1;
|
||||
mutable QHash<uint64_t, int> m_idCache;
|
||||
|
||||
@@ -400,6 +401,8 @@ struct NodeTree {
|
||||
QJsonObject toJson() const {
|
||||
QJsonObject o;
|
||||
o["baseAddress"] = QString::number(baseAddress, 16);
|
||||
if (!baseAddressFormula.isEmpty())
|
||||
o["baseAddressFormula"] = baseAddressFormula;
|
||||
o["nextId"] = QString::number(m_nextId);
|
||||
QJsonArray arr;
|
||||
for (const auto& n : nodes) arr.append(n.toJson());
|
||||
@@ -410,6 +413,7 @@ struct NodeTree {
|
||||
static NodeTree fromJson(const QJsonObject& o) {
|
||||
NodeTree t;
|
||||
t.baseAddress = o["baseAddress"].toString("400000").toULongLong(nullptr, 16);
|
||||
t.baseAddressFormula = o["baseAddressFormula"].toString();
|
||||
t.m_nextId = o["nextId"].toString("1").toULongLong();
|
||||
QJsonArray arr = o["nodes"].toArray();
|
||||
for (const auto& v : arr) {
|
||||
@@ -477,6 +481,17 @@ static constexpr uint64_t kCommandRowId = UINT64_MAX;
|
||||
static constexpr int kCommandRowLine = 0;
|
||||
static constexpr int kFirstDataLine = 1;
|
||||
static constexpr uint64_t kFooterIdBit = 0x8000000000000000ULL;
|
||||
static constexpr uint64_t kArrayElemBit = 0x4000000000000000ULL; // marks array element selection
|
||||
static constexpr uint64_t kArrayElemShift = 48; // bits 48-61 hold element index
|
||||
static constexpr uint64_t kArrayElemMask = 0x3FFF000000000000ULL; // 14 bits → max 16383 elements
|
||||
|
||||
// Encode an array element selection ID: nodeId | kArrayElemBit | (elemIdx << 48)
|
||||
inline uint64_t makeArrayElemSelId(uint64_t nodeId, int elemIdx) {
|
||||
return nodeId | kArrayElemBit | ((uint64_t)(elemIdx & 0x3FFF) << kArrayElemShift);
|
||||
}
|
||||
inline int arrayElemIdxFromSelId(uint64_t selId) {
|
||||
return (int)((selId & kArrayElemMask) >> kArrayElemShift);
|
||||
}
|
||||
|
||||
struct LineMeta {
|
||||
int nodeIdx = -1;
|
||||
@@ -541,7 +556,7 @@ namespace cmd {
|
||||
struct Insert { Node node; QVector<OffsetAdj> offAdjs; };
|
||||
struct Remove { uint64_t nodeId; QVector<Node> subtree;
|
||||
QVector<OffsetAdj> offAdjs; };
|
||||
struct ChangeBase { uint64_t oldBase, newBase; };
|
||||
struct ChangeBase { uint64_t oldBase, newBase; QString oldFormula, newFormula; };
|
||||
struct WriteBytes { uint64_t addr; QByteArray oldBytes, newBytes; };
|
||||
struct ChangeArrayMeta { uint64_t nodeId;
|
||||
NodeKind oldElementKind, newElementKind;
|
||||
@@ -663,8 +678,11 @@ inline ColumnSpan commandRowAddrSpan(const QString& lineText) {
|
||||
int tag = lineText.indexOf(QStringLiteral(" \u00B7"));
|
||||
if (tag < 0) return {};
|
||||
int start = tag + 3; // after " · "
|
||||
int end = start;
|
||||
while (end < lineText.size() && !lineText[end].isSpace()) end++;
|
||||
// Scan to next " · " separator (or end of line) to support formulas with spaces
|
||||
int nextSep = lineText.indexOf(QStringLiteral(" \u00B7"), start);
|
||||
int end = (nextSep >= 0) ? nextSep : lineText.size();
|
||||
// Trim trailing whitespace
|
||||
while (end > start && lineText[end - 1].isSpace()) end--;
|
||||
if (end <= start) return {};
|
||||
return {start, end, true};
|
||||
}
|
||||
|
||||
120
src/editor.cpp
120
src/editor.cpp
@@ -787,6 +787,14 @@ void RcxEditor::applyDocument(const ComposeResult& result) {
|
||||
m_meta = result.meta;
|
||||
m_layout = result.layout;
|
||||
|
||||
// Build nodeId → display-line index for O(1) hover/selection lookup
|
||||
m_nodeLineIndex.clear();
|
||||
m_nodeLineIndex.reserve(m_meta.size());
|
||||
for (int i = 0; i < m_meta.size(); i++) {
|
||||
if (m_meta[i].nodeId != 0)
|
||||
m_nodeLineIndex[m_meta[i].nodeId].append(i);
|
||||
}
|
||||
|
||||
// Dynamically resize margin to fit the current hex digit tier
|
||||
QString marginSizer = QString(" %1 ").arg(QString(m_layout.offsetHexDigits, '0'));
|
||||
m_sci->setMarginWidth(0, marginSizer);
|
||||
@@ -835,9 +843,12 @@ void RcxEditor::applyDocument(const ComposeResult& result) {
|
||||
m_applyingDocument = false;
|
||||
|
||||
// Re-apply hover markers (setText() clears all Scintilla markers).
|
||||
// Reset m_prevHoveredNodeId so the incremental logic re-adds markers.
|
||||
// applyHoverCursor() is NOT called here — it evaluates hitTest() against
|
||||
// composed text that updateCommandRow() will overwrite. The correct call
|
||||
// happens via applySelectionOverlays() after all text is finalized.
|
||||
m_prevHoveredNodeId = 0;
|
||||
m_prevHoveredLine = -1;
|
||||
applyHoverHighlight();
|
||||
}
|
||||
|
||||
@@ -909,7 +920,7 @@ void RcxEditor::reformatMargins() {
|
||||
// Place offset in the parent's indent slot (one level above the field's own indent)
|
||||
// so the field's own 3-char indent acts as visual separator from the type column
|
||||
int col = kFoldCol + (lm.depth - 2) * 3;
|
||||
int slotWidth = 3;
|
||||
int slotWidth = 5;
|
||||
|
||||
auto pos = [&](int c) -> long {
|
||||
return m_sci->SendScintilla(QsciScintillaBase::SCI_FINDCOLUMN,
|
||||
@@ -1064,18 +1075,33 @@ void RcxEditor::applySelectionOverlay(const QSet<uint64_t>& selIds) {
|
||||
m_sci->SendScintilla(QsciScintillaBase::SCI_SETINDICATORCURRENT, IND_EDITABLE);
|
||||
m_sci->SendScintilla(QsciScintillaBase::SCI_INDICATORCLEARRANGE, (unsigned long)0, docLen);
|
||||
|
||||
for (int i = 0; i < m_meta.size(); i++) {
|
||||
if (isSyntheticLine(m_meta[i])) continue;
|
||||
uint64_t nodeId = m_meta[i].nodeId;
|
||||
bool isFooter = (m_meta[i].lineKind == LineKind::Footer);
|
||||
|
||||
// Footers check for footerId, non-footers check for plain nodeId
|
||||
uint64_t checkId = isFooter ? (nodeId | kFooterIdBit) : nodeId;
|
||||
if (selIds.contains(checkId)) {
|
||||
m_sci->markerAdd(i, M_SELECTED);
|
||||
m_sci->markerAdd(i, M_ACCENT);
|
||||
// Use index: iterate selected IDs, look up their lines
|
||||
for (uint64_t selId : selIds) {
|
||||
bool isFooterSel = (selId & kFooterIdBit) != 0;
|
||||
bool isArrayElemSel = (selId & kArrayElemBit) != 0;
|
||||
int arrayElemIdx = isArrayElemSel ? arrayElemIdxFromSelId(selId) : -1;
|
||||
uint64_t nodeId = selId & ~(kFooterIdBit | kArrayElemBit | kArrayElemMask);
|
||||
auto it = m_nodeLineIndex.constFind(nodeId);
|
||||
if (it == m_nodeLineIndex.constEnd()) continue;
|
||||
for (int ln : *it) {
|
||||
if (isSyntheticLine(m_meta[ln])) continue;
|
||||
bool isFooter = (m_meta[ln].lineKind == LineKind::Footer);
|
||||
// Match selection type to line type
|
||||
if (isFooterSel && !isFooter) continue;
|
||||
if (!isFooterSel && isFooter) continue;
|
||||
// Array element: match by element index
|
||||
if (isArrayElemSel) {
|
||||
if (!m_meta[ln].isArrayElement || m_meta[ln].arrayElementIdx != arrayElemIdx)
|
||||
continue;
|
||||
} else if (m_meta[ln].isArrayElement) {
|
||||
// Plain nodeId selection shouldn't highlight individual array elements
|
||||
// (the header line is enough)
|
||||
continue;
|
||||
}
|
||||
m_sci->markerAdd(ln, M_SELECTED);
|
||||
m_sci->markerAdd(ln, M_ACCENT);
|
||||
if (!isFooter)
|
||||
paintEditableSpans(i);
|
||||
paintEditableSpans(ln);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1088,28 +1114,63 @@ void RcxEditor::applySelectionOverlay(const QSet<uint64_t>& selIds) {
|
||||
}
|
||||
|
||||
void RcxEditor::applyHoverHighlight() {
|
||||
m_sci->markerDeleteAll(M_HOVER);
|
||||
uint64_t prevId = m_prevHoveredNodeId;
|
||||
int prevLine = m_prevHoveredLine;
|
||||
m_prevHoveredNodeId = m_hoveredNodeId;
|
||||
m_prevHoveredLine = m_hoveredLine;
|
||||
|
||||
// Fast path: nothing changed (same node AND same line)
|
||||
if (prevId == m_hoveredNodeId && prevLine == m_hoveredLine
|
||||
&& m_hoveredNodeId != 0) return;
|
||||
|
||||
// Remove old hover markers
|
||||
if (prevId != 0) {
|
||||
// Check if old hovered line was a single-line highlight (footer or array element)
|
||||
bool prevSingleLine = (prevLine >= 0 && prevLine < m_meta.size() &&
|
||||
(m_meta[prevLine].lineKind == LineKind::Footer || m_meta[prevLine].isArrayElement));
|
||||
if (prevSingleLine) {
|
||||
m_sci->markerDelete(prevLine, M_HOVER);
|
||||
} else {
|
||||
auto it = m_nodeLineIndex.constFind(prevId);
|
||||
if (it != m_nodeLineIndex.constEnd()) {
|
||||
for (int ln : *it)
|
||||
m_sci->markerDelete(ln, M_HOVER);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (m_editState.active) return;
|
||||
if (!m_hoverInside) return;
|
||||
if (m_hoveredNodeId == 0) return;
|
||||
|
||||
// Check if hovered line is a footer - footers highlight independently
|
||||
// Footer and array elements highlight only the specific line
|
||||
bool hoveringFooter = (m_hoveredLine >= 0 && m_hoveredLine < m_meta.size() &&
|
||||
m_meta[m_hoveredLine].lineKind == LineKind::Footer);
|
||||
bool hoveringArrayElem = (m_hoveredLine >= 0 && m_hoveredLine < m_meta.size() &&
|
||||
m_meta[m_hoveredLine].isArrayElement);
|
||||
|
||||
// Check if the hovered item is already selected (using appropriate ID)
|
||||
uint64_t checkId = hoveringFooter ? (m_hoveredNodeId | kFooterIdBit) : m_hoveredNodeId;
|
||||
uint64_t checkId;
|
||||
if (hoveringFooter)
|
||||
checkId = m_hoveredNodeId | kFooterIdBit;
|
||||
else if (hoveringArrayElem)
|
||||
checkId = makeArrayElemSelId(m_hoveredNodeId, m_meta[m_hoveredLine].arrayElementIdx);
|
||||
else
|
||||
checkId = m_hoveredNodeId;
|
||||
if (m_currentSelIds.contains(checkId)) return;
|
||||
|
||||
if (hoveringFooter) {
|
||||
// Footer: only highlight this specific line
|
||||
if (hoveringFooter || hoveringArrayElem) {
|
||||
// Single-line highlight for footers and array elements
|
||||
m_sci->markerAdd(m_hoveredLine, M_HOVER);
|
||||
} else {
|
||||
// Non-footer: highlight all matching lines except footers
|
||||
for (int i = 0; i < m_meta.size(); i++) {
|
||||
if (m_meta[i].nodeId == m_hoveredNodeId &&
|
||||
m_meta[i].lineKind != LineKind::Footer)
|
||||
m_sci->markerAdd(i, M_HOVER);
|
||||
// Non-footer, non-array-element: highlight all lines for this node
|
||||
auto it = m_nodeLineIndex.constFind(m_hoveredNodeId);
|
||||
if (it != m_nodeLineIndex.constEnd()) {
|
||||
for (int ln : *it) {
|
||||
if (m_meta[ln].lineKind != LineKind::Footer &&
|
||||
!m_meta[ln].isArrayElement)
|
||||
m_sci->markerAdd(ln, M_HOVER);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1756,8 +1817,8 @@ bool RcxEditor::eventFilter(QObject* obj, QEvent* event) {
|
||||
}
|
||||
|
||||
commitInlineEdit();
|
||||
m_currentSelIds.clear(); // stale — normal handler will re-establish
|
||||
// Fall through to normal click handler below
|
||||
m_currentSelIds.clear();
|
||||
return true; // consume — metadata was recomposed; stale coords unsafe
|
||||
}
|
||||
// Single-click on fold column (" - " / " + ") toggles fold
|
||||
// Other left-clicks emit nodeClicked for selection
|
||||
@@ -2617,11 +2678,16 @@ void RcxEditor::updateEditableIndicators(int line) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Helper to check if a line's node is selected (handles footer IDs)
|
||||
// Helper to check if a line's node is selected (handles footer/array element IDs)
|
||||
auto isLineSelected = [this](const LineMeta* lm) -> bool {
|
||||
if (!lm) return false;
|
||||
bool isFooter = (lm->lineKind == LineKind::Footer);
|
||||
uint64_t checkId = isFooter ? (lm->nodeId | kFooterIdBit) : lm->nodeId;
|
||||
uint64_t checkId;
|
||||
if (lm->lineKind == LineKind::Footer)
|
||||
checkId = lm->nodeId | kFooterIdBit;
|
||||
else if (lm->isArrayElement && lm->arrayElementIdx >= 0)
|
||||
checkId = makeArrayElemSelId(lm->nodeId, lm->arrayElementIdx);
|
||||
else
|
||||
checkId = lm->nodeId;
|
||||
return m_currentSelIds.contains(checkId);
|
||||
};
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
#include <QWidget>
|
||||
#include <QSet>
|
||||
#include <QPoint>
|
||||
#include <QHash>
|
||||
|
||||
class QsciScintilla;
|
||||
class QsciLexerCPP;
|
||||
@@ -95,8 +96,12 @@ private:
|
||||
bool m_hoverInside = false;
|
||||
uint64_t m_hoveredNodeId = 0;
|
||||
int m_hoveredLine = -1;
|
||||
uint64_t m_prevHoveredNodeId = 0; // for incremental marker update
|
||||
int m_prevHoveredLine = -1; // for incremental marker update
|
||||
QSet<uint64_t> m_currentSelIds;
|
||||
QVector<int> m_hoverSpanLines; // Lines with hover span indicators
|
||||
// ── nodeId → display-line index (built in applyDocument) ──
|
||||
QHash<uint64_t, QVector<int>> m_nodeLineIndex;
|
||||
// ── Drag selection ──
|
||||
bool m_dragging = false;
|
||||
bool m_dragStarted = false; // true once drag threshold exceeded
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include "core.h"
|
||||
#include "addressparser.h"
|
||||
#include <cmath>
|
||||
#include <cstring>
|
||||
#include <limits>
|
||||
@@ -664,43 +665,13 @@ QString validateValue(NodeKind kind, const QString& text) {
|
||||
return QStringLiteral("invalid");
|
||||
}
|
||||
|
||||
// ── Base address validation (supports simple +/- equations) ──
|
||||
// ── Base address validation (delegates to AddressParser) ──
|
||||
|
||||
QString validateBaseAddress(const QString& text) {
|
||||
QString s = text.trimmed();
|
||||
if (s.isEmpty()) return QStringLiteral("empty");
|
||||
|
||||
int pos = 0;
|
||||
bool firstTerm = true;
|
||||
|
||||
while (pos < s.size()) {
|
||||
// Skip whitespace
|
||||
while (pos < s.size() && s[pos].isSpace()) pos++;
|
||||
if (pos >= s.size()) break;
|
||||
|
||||
// Check for +/- operator (except first term)
|
||||
if (!firstTerm) {
|
||||
if (s[pos] == '+' || s[pos] == '-') pos++;
|
||||
else return QStringLiteral("invalid '%1'").arg(s[pos]);
|
||||
while (pos < s.size() && s[pos].isSpace()) pos++;
|
||||
}
|
||||
|
||||
// Skip 0x prefix if present
|
||||
if (pos + 1 < s.size() && s[pos] == '0' && (s[pos+1] == 'x' || s[pos+1] == 'X'))
|
||||
pos += 2;
|
||||
|
||||
// Must have at least one hex digit
|
||||
int numStart = pos;
|
||||
while (pos < s.size() && (s[pos].isDigit() ||
|
||||
(s[pos] >= 'a' && s[pos] <= 'f') ||
|
||||
(s[pos] >= 'A' && s[pos] <= 'F'))) pos++;
|
||||
|
||||
if (pos == numStart) return QStringLiteral("invalid");
|
||||
|
||||
firstTerm = false;
|
||||
}
|
||||
|
||||
return {};
|
||||
//s.remove('`');
|
||||
return AddressParser::validate(s);
|
||||
}
|
||||
|
||||
} // namespace rcx::fmt
|
||||
|
||||
971
src/imports/import_pdb.cpp
Normal file
971
src/imports/import_pdb.cpp
Normal file
@@ -0,0 +1,971 @@
|
||||
#include "import_pdb.h"
|
||||
|
||||
#ifdef _WIN32
|
||||
|
||||
#include <windows.h>
|
||||
#include <QFile>
|
||||
#include <QHash>
|
||||
#include <QPair>
|
||||
#include <QSet>
|
||||
|
||||
// ── RawPDB headers ──
|
||||
#include "PDB.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_TPIStream.h"
|
||||
#include "PDB_TPITypes.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
#include "PDB_InfoStream.h"
|
||||
#include "PDB_CoalescedMSFStream.h"
|
||||
#include "Foundation/PDB_Memory.h"
|
||||
|
||||
namespace rcx {
|
||||
|
||||
// ── Memory-mapped file (mirrors ExampleMemoryMappedFile) ──
|
||||
|
||||
struct MappedFile {
|
||||
HANDLE hFile = INVALID_HANDLE_VALUE;
|
||||
HANDLE hMapping = nullptr;
|
||||
const void* base = nullptr;
|
||||
size_t size = 0;
|
||||
|
||||
bool open(const QString& path) {
|
||||
hFile = CreateFileW(reinterpret_cast<const wchar_t*>(path.utf16()),
|
||||
GENERIC_READ, FILE_SHARE_READ, nullptr,
|
||||
OPEN_EXISTING, FILE_ATTRIBUTE_READONLY, nullptr);
|
||||
if (hFile == INVALID_HANDLE_VALUE) return false;
|
||||
|
||||
hMapping = CreateFileMappingW(hFile, nullptr, PAGE_READONLY, 0, 0, nullptr);
|
||||
if (!hMapping) { close(); return false; }
|
||||
|
||||
base = MapViewOfFile(hMapping, FILE_MAP_READ, 0, 0, 0);
|
||||
if (!base) { close(); return false; }
|
||||
|
||||
BY_HANDLE_FILE_INFORMATION info;
|
||||
if (!GetFileInformationByHandle(hFile, &info)) { close(); return false; }
|
||||
size = (static_cast<size_t>(info.nFileSizeHigh) << 32) | info.nFileSizeLow;
|
||||
return true;
|
||||
}
|
||||
|
||||
void close() {
|
||||
if (base) { UnmapViewOfFile(base); base = nullptr; }
|
||||
if (hMapping) { CloseHandle(hMapping); hMapping = nullptr; }
|
||||
if (hFile != INVALID_HANDLE_VALUE) { CloseHandle(hFile); hFile = INVALID_HANDLE_VALUE; }
|
||||
size = 0;
|
||||
}
|
||||
|
||||
~MappedFile() { close(); }
|
||||
MappedFile() = default;
|
||||
MappedFile(const MappedFile&) = delete;
|
||||
MappedFile& operator=(const MappedFile&) = delete;
|
||||
};
|
||||
|
||||
// ── TypeTable (mirrors ExampleTypeTable) ──
|
||||
// Builds an O(1) lookup table from type index → record pointer.
|
||||
|
||||
class TypeTable {
|
||||
public:
|
||||
explicit TypeTable(const PDB::TPIStream& tpiStream) {
|
||||
m_firstIndex = tpiStream.GetFirstTypeIndex();
|
||||
m_lastIndex = tpiStream.GetLastTypeIndex();
|
||||
m_count = tpiStream.GetTypeRecordCount();
|
||||
|
||||
const PDB::DirectMSFStream& ds = tpiStream.GetDirectMSFStream();
|
||||
m_stream = PDB::CoalescedMSFStream(ds, ds.GetSize(), 0u);
|
||||
|
||||
m_records = PDB_NEW_ARRAY(const PDB::CodeView::TPI::Record*, m_count);
|
||||
uint32_t idx = 0;
|
||||
tpiStream.ForEachTypeRecordHeaderAndOffset(
|
||||
[this, &idx](const PDB::CodeView::TPI::RecordHeader&, size_t offset) {
|
||||
m_records[idx++] = m_stream.GetDataAtOffset<const PDB::CodeView::TPI::Record>(offset);
|
||||
});
|
||||
}
|
||||
|
||||
~TypeTable() { PDB_DELETE_ARRAY(m_records); }
|
||||
|
||||
uint32_t firstIndex() const { return m_firstIndex; }
|
||||
uint32_t lastIndex() const { return m_lastIndex; }
|
||||
size_t count() const { return m_count; }
|
||||
|
||||
const PDB::CodeView::TPI::Record* get(uint32_t typeIndex) const {
|
||||
if (typeIndex < m_firstIndex || typeIndex >= m_lastIndex) return nullptr;
|
||||
return m_records[typeIndex - m_firstIndex];
|
||||
}
|
||||
|
||||
private:
|
||||
uint32_t m_firstIndex = 0;
|
||||
uint32_t m_lastIndex = 0;
|
||||
size_t m_count = 0;
|
||||
const PDB::CodeView::TPI::Record** m_records = nullptr;
|
||||
PDB::CoalescedMSFStream m_stream;
|
||||
|
||||
TypeTable(const TypeTable&) = delete;
|
||||
TypeTable& operator=(const TypeTable&) = delete;
|
||||
};
|
||||
|
||||
// ── Leaf numeric helpers (variable-length integer encoding) ──
|
||||
|
||||
using TRK = PDB::CodeView::TPI::TypeRecordKind;
|
||||
|
||||
static uint8_t leafSize(TRK kind) {
|
||||
if (kind < TRK::LF_NUMERIC) return sizeof(TRK); // value is the kind itself
|
||||
switch (kind) {
|
||||
case TRK::LF_CHAR: return sizeof(TRK) + sizeof(uint8_t);
|
||||
case TRK::LF_SHORT:
|
||||
case TRK::LF_USHORT: return sizeof(TRK) + sizeof(uint16_t);
|
||||
case TRK::LF_LONG:
|
||||
case TRK::LF_ULONG: return sizeof(TRK) + sizeof(uint32_t);
|
||||
case TRK::LF_QUADWORD:
|
||||
case TRK::LF_UQUADWORD: return sizeof(TRK) + sizeof(uint64_t);
|
||||
default: return sizeof(TRK);
|
||||
}
|
||||
}
|
||||
|
||||
static const char* leafName(const char* data, TRK kind) {
|
||||
return data + leafSize(kind);
|
||||
}
|
||||
|
||||
static uint64_t leafValue(const char* data, TRK kind) {
|
||||
if (kind < TRK::LF_NUMERIC) {
|
||||
return static_cast<uint16_t>(kind);
|
||||
}
|
||||
const char* p = data + sizeof(TRK);
|
||||
switch (kind) {
|
||||
case TRK::LF_CHAR: return *reinterpret_cast<const uint8_t*>(p);
|
||||
case TRK::LF_SHORT: return *reinterpret_cast<const int16_t*>(p);
|
||||
case TRK::LF_USHORT: return *reinterpret_cast<const uint16_t*>(p);
|
||||
case TRK::LF_LONG: return *reinterpret_cast<const int32_t*>(p);
|
||||
case TRK::LF_ULONG: return *reinterpret_cast<const uint32_t*>(p);
|
||||
case TRK::LF_QUADWORD: return *reinterpret_cast<const int64_t*>(p);
|
||||
case TRK::LF_UQUADWORD: return *reinterpret_cast<const uint64_t*>(p);
|
||||
default: return 0;
|
||||
}
|
||||
}
|
||||
|
||||
// ── Primitive type index mapping (< 0x1000) ──
|
||||
|
||||
static NodeKind mapPrimitiveType(uint32_t typeIndex) {
|
||||
uint32_t base = typeIndex & 0xFF;
|
||||
switch (base) {
|
||||
// void
|
||||
case 0x03: return NodeKind::Hex8;
|
||||
// signed char
|
||||
case 0x10: return NodeKind::Int8;
|
||||
// unsigned char
|
||||
case 0x20: return NodeKind::UInt8;
|
||||
// real char
|
||||
case 0x70: return NodeKind::Int8;
|
||||
// wchar
|
||||
case 0x71: return NodeKind::UInt16;
|
||||
// char8
|
||||
case 0x7c: return NodeKind::UInt8;
|
||||
// char16
|
||||
case 0x7a: return NodeKind::UInt16;
|
||||
// char32
|
||||
case 0x7b: return NodeKind::UInt32;
|
||||
// short
|
||||
case 0x11: return NodeKind::Int16;
|
||||
// ushort
|
||||
case 0x21: return NodeKind::UInt16;
|
||||
// long
|
||||
case 0x12: return NodeKind::Int32;
|
||||
// ulong
|
||||
case 0x22: return NodeKind::UInt32;
|
||||
// int8
|
||||
case 0x68: return NodeKind::Int8;
|
||||
// uint8
|
||||
case 0x69: return NodeKind::UInt8;
|
||||
// int16
|
||||
case 0x72: return NodeKind::Int16;
|
||||
// uint16
|
||||
case 0x73: return NodeKind::UInt16;
|
||||
// int32
|
||||
case 0x74: return NodeKind::Int32;
|
||||
// uint32
|
||||
case 0x75: return NodeKind::UInt32;
|
||||
// quad (int64)
|
||||
case 0x13: return NodeKind::Int64;
|
||||
// uquad (uint64)
|
||||
case 0x23: return NodeKind::UInt64;
|
||||
// int64
|
||||
case 0x76: return NodeKind::Int64;
|
||||
// uint64
|
||||
case 0x77: return NodeKind::UInt64;
|
||||
// float
|
||||
case 0x40: return NodeKind::Float;
|
||||
// double
|
||||
case 0x41: return NodeKind::Double;
|
||||
// bool
|
||||
case 0x30: return NodeKind::Bool;
|
||||
case 0x31: return NodeKind::UInt16; // bool16
|
||||
case 0x32: return NodeKind::UInt32; // bool32
|
||||
case 0x33: return NodeKind::UInt64; // bool64
|
||||
// HRESULT
|
||||
case 0x08: return NodeKind::UInt32;
|
||||
// bit
|
||||
case 0x60: return NodeKind::UInt8;
|
||||
// int128 / uint128 approximation
|
||||
case 0x78: return NodeKind::Hex64; // int128 → Hex64 (best we can do)
|
||||
case 0x79: return NodeKind::Hex64; // uint128
|
||||
default: return NodeKind::Hex32;
|
||||
}
|
||||
}
|
||||
|
||||
static NodeKind hexForSize(uint64_t len) {
|
||||
switch (len) {
|
||||
case 1: return NodeKind::Hex8;
|
||||
case 2: return NodeKind::Hex16;
|
||||
case 4: return NodeKind::Hex32;
|
||||
case 8: return NodeKind::Hex64;
|
||||
default: return NodeKind::Hex32;
|
||||
}
|
||||
}
|
||||
|
||||
// ── Helper: read the leaf kind from the start of LF_UNION.data ──
|
||||
// (LF_UNION lacks the lfEasy member that LF_CLASS has)
|
||||
static TRK unionLeafKind(const char* data) {
|
||||
return *reinterpret_cast<const TRK*>(data);
|
||||
}
|
||||
|
||||
// ── Import context ──
|
||||
|
||||
struct PdbCtx {
|
||||
NodeTree tree;
|
||||
const TypeTable* tt = nullptr;
|
||||
QHash<uint32_t, uint64_t> typeCache; // typeIndex → nodeId
|
||||
|
||||
uint64_t importUDT(uint32_t typeIndex);
|
||||
void importFieldList(uint32_t fieldListIndex, uint64_t parentId);
|
||||
void importMemberType(uint32_t typeIndex, int offset, const QString& name, uint64_t parentId);
|
||||
|
||||
// Resolve LF_MODIFIER chain to underlying type index
|
||||
uint32_t unwrapModifier(uint32_t typeIndex) const {
|
||||
if (typeIndex < tt->firstIndex()) return typeIndex;
|
||||
const auto* rec = tt->get(typeIndex);
|
||||
if (!rec) return typeIndex;
|
||||
if (rec->header.kind == TRK::LF_MODIFIER)
|
||||
return rec->data.LF_MODIFIER.type;
|
||||
return typeIndex;
|
||||
}
|
||||
};
|
||||
|
||||
uint64_t PdbCtx::importUDT(uint32_t typeIndex) {
|
||||
if (typeIndex < tt->firstIndex()) return 0;
|
||||
|
||||
auto it = typeCache.find(typeIndex);
|
||||
if (it != typeCache.end()) return it.value();
|
||||
|
||||
const auto* rec = tt->get(typeIndex);
|
||||
if (!rec) return 0;
|
||||
|
||||
const char* name = nullptr;
|
||||
uint32_t fieldListIndex = 0;
|
||||
uint16_t fieldCount = 0;
|
||||
bool isUnion = false;
|
||||
const char* sizeData = nullptr;
|
||||
|
||||
if (rec->header.kind == TRK::LF_STRUCTURE || rec->header.kind == TRK::LF_CLASS) {
|
||||
// Skip forward references — find the definition
|
||||
if (rec->data.LF_CLASS.property.fwdref) return 0;
|
||||
fieldCount = rec->data.LF_CLASS.count;
|
||||
fieldListIndex = rec->data.LF_CLASS.field;
|
||||
sizeData = rec->data.LF_CLASS.data;
|
||||
name = leafName(sizeData, rec->data.LF_CLASS.lfEasy.kind);
|
||||
} else if (rec->header.kind == TRK::LF_UNION) {
|
||||
if (rec->data.LF_UNION.property.fwdref) return 0;
|
||||
isUnion = true;
|
||||
fieldCount = rec->data.LF_UNION.count;
|
||||
fieldListIndex = rec->data.LF_UNION.field;
|
||||
sizeData = rec->data.LF_UNION.data;
|
||||
name = leafName(sizeData, unionLeafKind(sizeData));
|
||||
} else {
|
||||
return 0;
|
||||
}
|
||||
(void)fieldCount;
|
||||
|
||||
QString qname = name ? QString::fromUtf8(name) : QStringLiteral("<anon>");
|
||||
|
||||
Node s;
|
||||
s.kind = NodeKind::Struct;
|
||||
s.name = qname;
|
||||
s.structTypeName = qname;
|
||||
s.classKeyword = isUnion ? QStringLiteral("union") : QStringLiteral("struct");
|
||||
s.parentId = 0;
|
||||
s.collapsed = true;
|
||||
int idx = tree.addNode(s);
|
||||
uint64_t nodeId = tree.nodes[idx].id;
|
||||
|
||||
typeCache[typeIndex] = nodeId;
|
||||
|
||||
importFieldList(fieldListIndex, nodeId);
|
||||
return nodeId;
|
||||
}
|
||||
|
||||
void PdbCtx::importFieldList(uint32_t fieldListIndex, uint64_t parentId) {
|
||||
const auto* rec = tt->get(fieldListIndex);
|
||||
if (!rec || rec->header.kind != TRK::LF_FIELDLIST) return;
|
||||
|
||||
auto maximumSize = rec->header.size - sizeof(uint16_t);
|
||||
QSet<QPair<int,int>> bitfieldSlots;
|
||||
|
||||
for (size_t i = 0; i < maximumSize; ) {
|
||||
auto* field = reinterpret_cast<const PDB::CodeView::TPI::FieldList*>(
|
||||
reinterpret_cast<const uint8_t*>(&rec->data.LF_FIELD.list) + i);
|
||||
|
||||
if (field->kind == TRK::LF_MEMBER) {
|
||||
// Extract offset from variable-length leaf
|
||||
uint16_t offset = 0;
|
||||
if (field->data.LF_MEMBER.lfEasy.kind < TRK::LF_NUMERIC)
|
||||
offset = *reinterpret_cast<const uint16_t*>(field->data.LF_MEMBER.offset);
|
||||
else
|
||||
offset = static_cast<uint16_t>(leafValue(field->data.LF_MEMBER.offset,
|
||||
field->data.LF_MEMBER.lfEasy.kind));
|
||||
|
||||
const char* memberName = leafName(field->data.LF_MEMBER.offset,
|
||||
field->data.LF_MEMBER.lfEasy.kind);
|
||||
uint32_t memberType = field->data.LF_MEMBER.index;
|
||||
QString qname = memberName ? QString::fromUtf8(memberName) : QString();
|
||||
|
||||
// Check for bitfield type
|
||||
uint32_t resolvedType = unwrapModifier(memberType);
|
||||
const auto* typeRec = tt->get(resolvedType);
|
||||
if (typeRec && typeRec->header.kind == TRK::LF_BITFIELD) {
|
||||
uint32_t underlying = typeRec->data.LF_BITFIELD.type;
|
||||
uint8_t bitLen = typeRec->data.LF_BITFIELD.length;
|
||||
(void)bitLen;
|
||||
|
||||
// Determine slot size from underlying type
|
||||
uint64_t slotSize = 4;
|
||||
if (underlying < tt->firstIndex()) {
|
||||
NodeKind k = mapPrimitiveType(underlying);
|
||||
slotSize = sizeForKind(k);
|
||||
}
|
||||
|
||||
auto key = qMakePair((int)offset, (int)slotSize);
|
||||
if (!bitfieldSlots.contains(key)) {
|
||||
bitfieldSlots.insert(key);
|
||||
Node n;
|
||||
n.kind = hexForSize(slotSize);
|
||||
n.name = qname;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
tree.addNode(n);
|
||||
}
|
||||
} else {
|
||||
importMemberType(memberType, offset, qname, parentId);
|
||||
}
|
||||
|
||||
// Advance past this LF_MEMBER
|
||||
i += static_cast<size_t>(memberName - reinterpret_cast<const char*>(field));
|
||||
i += strnlen(memberName, maximumSize - i - 1) + 1;
|
||||
i = (i + 3) & ~size_t(3); // align to 4
|
||||
}
|
||||
else if (field->kind == TRK::LF_BCLASS) {
|
||||
const char* leafEnd = leafName(field->data.LF_BCLASS.offset,
|
||||
field->data.LF_BCLASS.lfEasy.kind);
|
||||
i += static_cast<size_t>(leafEnd - reinterpret_cast<const char*>(field));
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_VBCLASS || field->kind == TRK::LF_IVBCLASS) {
|
||||
TRK vbpKind = *reinterpret_cast<const TRK*>(field->data.LF_IVBCLASS.vbpOffset);
|
||||
uint8_t vbpSize1 = leafSize(vbpKind);
|
||||
TRK vbtKind = *reinterpret_cast<const TRK*>(field->data.LF_IVBCLASS.vbpOffset + vbpSize1);
|
||||
uint8_t vbpSize2 = leafSize(vbtKind);
|
||||
i += sizeof(PDB::CodeView::TPI::FieldList::Data::LF_VBCLASS) + vbpSize1 + vbpSize2;
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_INDEX) {
|
||||
// Continuation of field list in another record
|
||||
importFieldList(field->data.LF_INDEX.type, parentId);
|
||||
i += sizeof(PDB::CodeView::TPI::FieldList::Data::LF_INDEX);
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_VFUNCTAB) {
|
||||
i += sizeof(PDB::CodeView::TPI::FieldList::Data::LF_VFUNCTAB);
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_NESTTYPE) {
|
||||
const char* nestName = field->data.LF_NESTTYPE.name;
|
||||
i += static_cast<size_t>(nestName - reinterpret_cast<const char*>(field));
|
||||
i += strnlen(nestName, maximumSize - i - 1) + 1;
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_STMEMBER) {
|
||||
const char* smName = field->data.LF_STMEMBER.name;
|
||||
i += static_cast<size_t>(smName - reinterpret_cast<const char*>(field));
|
||||
i += strnlen(smName, maximumSize - i - 1) + 1;
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_METHOD) {
|
||||
const char* mName = field->data.LF_METHOD.name;
|
||||
i += static_cast<size_t>(mName - reinterpret_cast<const char*>(field));
|
||||
i += strnlen(mName, maximumSize - i - 1) + 1;
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_ONEMETHOD) {
|
||||
// Determine if it has a vbaseoff field
|
||||
auto prop = static_cast<PDB::CodeView::TPI::MethodProperty>(
|
||||
field->data.LF_ONEMETHOD.attributes.mprop);
|
||||
const char* mName;
|
||||
if (prop == PDB::CodeView::TPI::MethodProperty::Intro ||
|
||||
prop == PDB::CodeView::TPI::MethodProperty::PureIntro)
|
||||
mName = reinterpret_cast<const char*>(field->data.LF_ONEMETHOD.vbaseoff) + sizeof(uint32_t);
|
||||
else
|
||||
mName = reinterpret_cast<const char*>(field->data.LF_ONEMETHOD.vbaseoff);
|
||||
|
||||
i += static_cast<size_t>(mName - reinterpret_cast<const char*>(field));
|
||||
i += strnlen(mName, maximumSize - i - 1) + 1;
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else if (field->kind == TRK::LF_ENUMERATE) {
|
||||
const char* eName = leafName(field->data.LF_ENUMERATE.value,
|
||||
field->data.LF_ENUMERATE.lfEasy.kind);
|
||||
i += static_cast<size_t>(eName - reinterpret_cast<const char*>(field));
|
||||
i += strnlen(eName, maximumSize - i - 1) + 1;
|
||||
i = (i + 3) & ~size_t(3);
|
||||
}
|
||||
else {
|
||||
break; // unknown field kind, stop
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void PdbCtx::importMemberType(uint32_t typeIndex, int offset, const QString& name, uint64_t parentId) {
|
||||
// Handle primitive type indices (< 0x1000)
|
||||
if (typeIndex < tt->firstIndex()) {
|
||||
uint32_t ptrMode = (typeIndex >> 8) & 0xF;
|
||||
if (ptrMode == 0x04 || ptrMode == 0x05) {
|
||||
// 32-bit pointer to a base type
|
||||
Node n;
|
||||
n.kind = NodeKind::Pointer32;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
n.collapsed = true;
|
||||
tree.addNode(n);
|
||||
return;
|
||||
}
|
||||
if (ptrMode == 0x06) {
|
||||
// 64-bit pointer to a base type
|
||||
Node n;
|
||||
n.kind = NodeKind::Pointer64;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
n.collapsed = true;
|
||||
tree.addNode(n);
|
||||
return;
|
||||
}
|
||||
if (ptrMode != 0x00) {
|
||||
// Some other pointer mode (near, far, huge) — treat as 32-bit
|
||||
Node n;
|
||||
n.kind = NodeKind::Pointer32;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
n.collapsed = true;
|
||||
tree.addNode(n);
|
||||
return;
|
||||
}
|
||||
// Direct base type
|
||||
Node n;
|
||||
n.kind = mapPrimitiveType(typeIndex);
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
tree.addNode(n);
|
||||
return;
|
||||
}
|
||||
|
||||
const auto* rec = tt->get(typeIndex);
|
||||
if (!rec) {
|
||||
Node n;
|
||||
n.kind = NodeKind::Hex32;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
tree.addNode(n);
|
||||
return;
|
||||
}
|
||||
|
||||
switch (rec->header.kind) {
|
||||
case TRK::LF_MODIFIER:
|
||||
importMemberType(rec->data.LF_MODIFIER.type, offset, name, parentId);
|
||||
break;
|
||||
|
||||
case TRK::LF_POINTER: {
|
||||
uint32_t ptrSize = rec->data.LF_POINTER.attr.size;
|
||||
uint32_t pointee = rec->data.LF_POINTER.utype;
|
||||
|
||||
// Unwrap modifier on pointee
|
||||
uint32_t realPointee = unwrapModifier(pointee);
|
||||
|
||||
Node n;
|
||||
n.kind = (ptrSize <= 4) ? NodeKind::Pointer32 : NodeKind::Pointer64;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
n.collapsed = true;
|
||||
|
||||
// Check if pointee is a UDT
|
||||
if (realPointee >= tt->firstIndex()) {
|
||||
const auto* pointeeRec = tt->get(realPointee);
|
||||
if (pointeeRec) {
|
||||
if (pointeeRec->header.kind == TRK::LF_STRUCTURE ||
|
||||
pointeeRec->header.kind == TRK::LF_CLASS ||
|
||||
pointeeRec->header.kind == TRK::LF_UNION) {
|
||||
// If this is a forward ref, search for the definition
|
||||
uint32_t defIndex = realPointee;
|
||||
bool isFwd = false;
|
||||
if (pointeeRec->header.kind == TRK::LF_UNION)
|
||||
isFwd = pointeeRec->data.LF_UNION.property.fwdref;
|
||||
else
|
||||
isFwd = pointeeRec->data.LF_CLASS.property.fwdref;
|
||||
|
||||
if (isFwd) {
|
||||
// Need to find the non-fwdref definition by name
|
||||
const char* typeName = nullptr;
|
||||
if (pointeeRec->header.kind == TRK::LF_UNION)
|
||||
typeName = leafName(pointeeRec->data.LF_UNION.data, unionLeafKind(pointeeRec->data.LF_UNION.data));
|
||||
else
|
||||
typeName = leafName(pointeeRec->data.LF_CLASS.data,
|
||||
pointeeRec->data.LF_CLASS.lfEasy.kind);
|
||||
|
||||
if (typeName) {
|
||||
// Linear scan for the definition (cached after first import)
|
||||
for (uint32_t ti = tt->firstIndex(); ti < tt->lastIndex(); ti++) {
|
||||
const auto* candidate = tt->get(ti);
|
||||
if (!candidate) continue;
|
||||
if (candidate->header.kind != pointeeRec->header.kind) continue;
|
||||
bool candidateFwd;
|
||||
const char* candidateName;
|
||||
if (candidate->header.kind == TRK::LF_UNION) {
|
||||
candidateFwd = candidate->data.LF_UNION.property.fwdref;
|
||||
candidateName = leafName(candidate->data.LF_UNION.data, unionLeafKind(candidate->data.LF_UNION.data));
|
||||
} else {
|
||||
candidateFwd = candidate->data.LF_CLASS.property.fwdref;
|
||||
candidateName = leafName(candidate->data.LF_CLASS.data,
|
||||
candidate->data.LF_CLASS.lfEasy.kind);
|
||||
}
|
||||
if (!candidateFwd && candidateName && strcmp(candidateName, typeName) == 0) {
|
||||
defIndex = ti;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
n.refId = importUDT(defIndex);
|
||||
} else if (pointeeRec->header.kind == TRK::LF_PROCEDURE ||
|
||||
pointeeRec->header.kind == TRK::LF_MFUNCTION) {
|
||||
n.kind = (ptrSize <= 4) ? NodeKind::FuncPtr32 : NodeKind::FuncPtr64;
|
||||
}
|
||||
}
|
||||
}
|
||||
tree.addNode(n);
|
||||
break;
|
||||
}
|
||||
|
||||
case TRK::LF_STRUCTURE:
|
||||
case TRK::LF_CLASS:
|
||||
case TRK::LF_UNION: {
|
||||
// Embedded struct/union
|
||||
uint32_t defIndex = typeIndex;
|
||||
|
||||
// Handle forward reference
|
||||
bool isFwd = false;
|
||||
if (rec->header.kind == TRK::LF_UNION)
|
||||
isFwd = rec->data.LF_UNION.property.fwdref;
|
||||
else
|
||||
isFwd = rec->data.LF_CLASS.property.fwdref;
|
||||
|
||||
if (isFwd) {
|
||||
const char* typeName = nullptr;
|
||||
if (rec->header.kind == TRK::LF_UNION)
|
||||
typeName = leafName(rec->data.LF_UNION.data, unionLeafKind(rec->data.LF_UNION.data));
|
||||
else
|
||||
typeName = leafName(rec->data.LF_CLASS.data, rec->data.LF_CLASS.lfEasy.kind);
|
||||
|
||||
if (typeName) {
|
||||
for (uint32_t ti = tt->firstIndex(); ti < tt->lastIndex(); ti++) {
|
||||
const auto* candidate = tt->get(ti);
|
||||
if (!candidate) continue;
|
||||
if (candidate->header.kind != rec->header.kind) continue;
|
||||
bool candidateFwd;
|
||||
const char* candidateName;
|
||||
if (candidate->header.kind == TRK::LF_UNION) {
|
||||
candidateFwd = candidate->data.LF_UNION.property.fwdref;
|
||||
candidateName = leafName(candidate->data.LF_UNION.data, unionLeafKind(candidate->data.LF_UNION.data));
|
||||
} else {
|
||||
candidateFwd = candidate->data.LF_CLASS.property.fwdref;
|
||||
candidateName = leafName(candidate->data.LF_CLASS.data,
|
||||
candidate->data.LF_CLASS.lfEasy.kind);
|
||||
}
|
||||
if (!candidateFwd && candidateName && strcmp(candidateName, typeName) == 0) {
|
||||
defIndex = ti;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
uint64_t refId = importUDT(defIndex);
|
||||
|
||||
const char* typeName = nullptr;
|
||||
bool isUnion = (rec->header.kind == TRK::LF_UNION);
|
||||
if (isUnion)
|
||||
typeName = leafName(rec->data.LF_UNION.data, unionLeafKind(rec->data.LF_UNION.data));
|
||||
else
|
||||
typeName = leafName(rec->data.LF_CLASS.data, rec->data.LF_CLASS.lfEasy.kind);
|
||||
|
||||
Node n;
|
||||
n.kind = NodeKind::Struct;
|
||||
n.name = name;
|
||||
n.structTypeName = typeName ? QString::fromUtf8(typeName) : QString();
|
||||
n.classKeyword = isUnion ? QStringLiteral("union") : QStringLiteral("struct");
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
n.refId = refId;
|
||||
n.collapsed = true;
|
||||
tree.addNode(n);
|
||||
break;
|
||||
}
|
||||
|
||||
case TRK::LF_ARRAY: {
|
||||
uint32_t elemType = rec->data.LF_ARRAY.elemtype;
|
||||
uint64_t totalSize = leafValue(rec->data.LF_ARRAY.data,
|
||||
*reinterpret_cast<const TRK*>(rec->data.LF_ARRAY.data));
|
||||
|
||||
// Get element size
|
||||
uint64_t elemSize = 0;
|
||||
uint32_t realElemType = unwrapModifier(elemType);
|
||||
if (realElemType < tt->firstIndex()) {
|
||||
NodeKind ek = mapPrimitiveType(realElemType);
|
||||
elemSize = sizeForKind(ek);
|
||||
} else {
|
||||
const auto* elemRec = tt->get(realElemType);
|
||||
if (elemRec) {
|
||||
if (elemRec->header.kind == TRK::LF_STRUCTURE || elemRec->header.kind == TRK::LF_CLASS) {
|
||||
const char* sizeData = elemRec->data.LF_CLASS.data;
|
||||
elemSize = leafValue(sizeData, elemRec->data.LF_CLASS.lfEasy.kind);
|
||||
} else if (elemRec->header.kind == TRK::LF_UNION) {
|
||||
const char* sizeData = elemRec->data.LF_UNION.data;
|
||||
elemSize = leafValue(sizeData, *reinterpret_cast<const TRK*>(sizeData));
|
||||
} else if (elemRec->header.kind == TRK::LF_POINTER) {
|
||||
elemSize = elemRec->data.LF_POINTER.attr.size;
|
||||
} else if (elemRec->header.kind == TRK::LF_ENUM) {
|
||||
// Size of enum's underlying type
|
||||
uint32_t ut = elemRec->data.LF_ENUM.utype;
|
||||
if (ut < tt->firstIndex()) {
|
||||
NodeKind ek = mapPrimitiveType(ut);
|
||||
elemSize = sizeForKind(ek);
|
||||
} else {
|
||||
elemSize = 4;
|
||||
}
|
||||
} else if (elemRec->header.kind == TRK::LF_ARRAY) {
|
||||
// Nested array — get total size
|
||||
elemSize = leafValue(elemRec->data.LF_ARRAY.data,
|
||||
*reinterpret_cast<const TRK*>(elemRec->data.LF_ARRAY.data));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
int count = (elemSize > 0) ? static_cast<int>(totalSize / elemSize) : 1;
|
||||
|
||||
Node n;
|
||||
n.kind = NodeKind::Array;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
n.arrayLen = count;
|
||||
|
||||
// Determine element kind
|
||||
if (realElemType < tt->firstIndex()) {
|
||||
n.elementKind = mapPrimitiveType(realElemType);
|
||||
} else {
|
||||
const auto* elemRec = tt->get(realElemType);
|
||||
if (elemRec) {
|
||||
if (elemRec->header.kind == TRK::LF_STRUCTURE ||
|
||||
elemRec->header.kind == TRK::LF_CLASS ||
|
||||
elemRec->header.kind == TRK::LF_UNION) {
|
||||
n.elementKind = NodeKind::Struct;
|
||||
n.refId = importUDT(realElemType);
|
||||
const char* tn = nullptr;
|
||||
if (elemRec->header.kind == TRK::LF_UNION)
|
||||
tn = leafName(elemRec->data.LF_UNION.data, unionLeafKind(elemRec->data.LF_UNION.data));
|
||||
else
|
||||
tn = leafName(elemRec->data.LF_CLASS.data, elemRec->data.LF_CLASS.lfEasy.kind);
|
||||
if (tn) n.structTypeName = QString::fromUtf8(tn);
|
||||
} else if (elemRec->header.kind == TRK::LF_POINTER) {
|
||||
uint32_t sz = elemRec->data.LF_POINTER.attr.size;
|
||||
n.elementKind = (sz <= 4) ? NodeKind::Pointer32 : NodeKind::Pointer64;
|
||||
} else {
|
||||
n.elementKind = hexForSize(elemSize);
|
||||
}
|
||||
}
|
||||
}
|
||||
tree.addNode(n);
|
||||
break;
|
||||
}
|
||||
|
||||
case TRK::LF_ENUM: {
|
||||
// Map enum to its underlying integer type
|
||||
uint32_t utype = rec->data.LF_ENUM.utype;
|
||||
Node n;
|
||||
if (utype < tt->firstIndex()) {
|
||||
n.kind = mapPrimitiveType(utype);
|
||||
} else {
|
||||
n.kind = NodeKind::UInt32; // fallback
|
||||
}
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
tree.addNode(n);
|
||||
break;
|
||||
}
|
||||
|
||||
case TRK::LF_PROCEDURE:
|
||||
case TRK::LF_MFUNCTION: {
|
||||
Node n;
|
||||
n.kind = NodeKind::Hex64;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
tree.addNode(n);
|
||||
break;
|
||||
}
|
||||
|
||||
case TRK::LF_BITFIELD: {
|
||||
uint32_t underlying = rec->data.LF_BITFIELD.type;
|
||||
uint64_t slotSize = 4;
|
||||
if (underlying < tt->firstIndex()) {
|
||||
NodeKind k = mapPrimitiveType(underlying);
|
||||
slotSize = sizeForKind(k);
|
||||
}
|
||||
Node n;
|
||||
n.kind = hexForSize(slotSize);
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
tree.addNode(n);
|
||||
break;
|
||||
}
|
||||
|
||||
default: {
|
||||
// Unknown complex type — emit as Hex32
|
||||
Node n;
|
||||
n.kind = NodeKind::Hex32;
|
||||
n.name = name;
|
||||
n.parentId = parentId;
|
||||
n.offset = offset;
|
||||
tree.addNode(n);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// ── Helper: open PDB and build type table ──
|
||||
|
||||
struct PdbFile {
|
||||
MappedFile mapped;
|
||||
PDB::RawFile* rawFile = nullptr;
|
||||
PDB::TPIStream* tpiStream = nullptr;
|
||||
TypeTable* typeTable = nullptr;
|
||||
|
||||
~PdbFile() {
|
||||
delete typeTable;
|
||||
delete tpiStream;
|
||||
delete rawFile;
|
||||
}
|
||||
|
||||
bool open(const QString& pdbPath, QString* errorMsg) {
|
||||
auto setErr = [&](const QString& msg) { if (errorMsg) *errorMsg = msg; };
|
||||
|
||||
if (!QFile::exists(pdbPath)) {
|
||||
setErr(QStringLiteral("PDB file not found: ") + pdbPath);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!mapped.open(pdbPath)) {
|
||||
setErr(QStringLiteral("Failed to memory-map PDB file: ") + pdbPath);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (PDB::ValidateFile(mapped.base, mapped.size) != PDB::ErrorCode::Success) {
|
||||
setErr(QStringLiteral("Invalid PDB file: ") + pdbPath);
|
||||
return false;
|
||||
}
|
||||
|
||||
rawFile = new PDB::RawFile(PDB::CreateRawFile(mapped.base));
|
||||
|
||||
if (PDB::HasValidTPIStream(*rawFile) != PDB::ErrorCode::Success) {
|
||||
setErr(QStringLiteral("PDB has no valid TPI stream: ") + pdbPath);
|
||||
return false;
|
||||
}
|
||||
|
||||
tpiStream = new PDB::TPIStream(PDB::CreateTPIStream(*rawFile));
|
||||
typeTable = new TypeTable(*tpiStream);
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
// ── Public API: enumeratePdbTypes ──
|
||||
|
||||
QVector<PdbTypeInfo> enumeratePdbTypes(const QString& pdbPath, QString* errorMsg) {
|
||||
PdbFile pdb;
|
||||
if (!pdb.open(pdbPath, errorMsg)) return {};
|
||||
|
||||
const TypeTable& tt = *pdb.typeTable;
|
||||
QVector<PdbTypeInfo> result;
|
||||
|
||||
for (uint32_t ti = tt.firstIndex(); ti < tt.lastIndex(); ti++) {
|
||||
const auto* rec = tt.get(ti);
|
||||
if (!rec) continue;
|
||||
|
||||
bool isUDT = (rec->header.kind == TRK::LF_STRUCTURE ||
|
||||
rec->header.kind == TRK::LF_CLASS ||
|
||||
rec->header.kind == TRK::LF_UNION);
|
||||
if (!isUDT) continue;
|
||||
|
||||
const char* name = nullptr;
|
||||
uint16_t fieldCount = 0;
|
||||
bool isUnion = false;
|
||||
uint64_t size = 0;
|
||||
|
||||
if (rec->header.kind == TRK::LF_UNION) {
|
||||
if (rec->data.LF_UNION.property.fwdref) continue;
|
||||
isUnion = true;
|
||||
fieldCount = rec->data.LF_UNION.count;
|
||||
const char* sizeData = rec->data.LF_UNION.data;
|
||||
TRK sizeKind = *reinterpret_cast<const TRK*>(sizeData);
|
||||
size = leafValue(sizeData, sizeKind);
|
||||
name = leafName(sizeData, sizeKind);
|
||||
} else {
|
||||
if (rec->data.LF_CLASS.property.fwdref) continue;
|
||||
fieldCount = rec->data.LF_CLASS.count;
|
||||
const char* sizeData = rec->data.LF_CLASS.data;
|
||||
size = leafValue(sizeData, rec->data.LF_CLASS.lfEasy.kind);
|
||||
name = leafName(sizeData, rec->data.LF_CLASS.lfEasy.kind);
|
||||
}
|
||||
|
||||
if (!name || name[0] == '\0') continue;
|
||||
// Skip anonymous types with compiler-generated names
|
||||
if (name[0] == '<') continue;
|
||||
|
||||
PdbTypeInfo info;
|
||||
info.typeIndex = ti;
|
||||
info.name = QString::fromUtf8(name);
|
||||
info.size = size;
|
||||
info.childCount = fieldCount;
|
||||
info.isUnion = isUnion;
|
||||
result.append(info);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
// ── Public API: importPdbSelected ──
|
||||
|
||||
NodeTree importPdbSelected(const QString& pdbPath,
|
||||
const QVector<uint32_t>& typeIndices,
|
||||
QString* errorMsg,
|
||||
ProgressCb progressCb) {
|
||||
PdbFile pdb;
|
||||
if (!pdb.open(pdbPath, errorMsg)) return {};
|
||||
|
||||
PdbCtx ctx;
|
||||
ctx.tt = pdb.typeTable;
|
||||
|
||||
int total = typeIndices.size();
|
||||
for (int i = 0; i < total; i++) {
|
||||
ctx.importUDT(typeIndices[i]);
|
||||
if (progressCb && !progressCb(i + 1, total)) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("Import cancelled");
|
||||
return ctx.tree; // return partial result
|
||||
}
|
||||
}
|
||||
|
||||
if (ctx.tree.nodes.isEmpty()) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("No types imported");
|
||||
}
|
||||
return ctx.tree;
|
||||
}
|
||||
|
||||
// ── Public API: importPdb (legacy) ──
|
||||
|
||||
NodeTree importPdb(const QString& pdbPath, const QString& structFilter, QString* errorMsg) {
|
||||
PdbFile pdb;
|
||||
if (!pdb.open(pdbPath, errorMsg)) return {};
|
||||
|
||||
const TypeTable& tt = *pdb.typeTable;
|
||||
PdbCtx ctx;
|
||||
ctx.tt = &tt;
|
||||
|
||||
for (uint32_t ti = tt.firstIndex(); ti < tt.lastIndex(); ti++) {
|
||||
const auto* rec = tt.get(ti);
|
||||
if (!rec) continue;
|
||||
|
||||
bool isUDT = (rec->header.kind == TRK::LF_STRUCTURE ||
|
||||
rec->header.kind == TRK::LF_CLASS ||
|
||||
rec->header.kind == TRK::LF_UNION);
|
||||
if (!isUDT) continue;
|
||||
|
||||
bool fwdref = false;
|
||||
const char* name = nullptr;
|
||||
|
||||
if (rec->header.kind == TRK::LF_UNION) {
|
||||
fwdref = rec->data.LF_UNION.property.fwdref;
|
||||
name = leafName(rec->data.LF_UNION.data, unionLeafKind(rec->data.LF_UNION.data));
|
||||
} else {
|
||||
fwdref = rec->data.LF_CLASS.property.fwdref;
|
||||
name = leafName(rec->data.LF_CLASS.data, rec->data.LF_CLASS.lfEasy.kind);
|
||||
}
|
||||
|
||||
if (fwdref) continue;
|
||||
if (!name) continue;
|
||||
|
||||
if (!structFilter.isEmpty()) {
|
||||
if (QString::fromUtf8(name) != structFilter) continue;
|
||||
}
|
||||
|
||||
ctx.importUDT(ti);
|
||||
|
||||
// If filtering to a single struct, stop after finding it
|
||||
if (!structFilter.isEmpty()) break;
|
||||
}
|
||||
|
||||
if (ctx.tree.nodes.isEmpty()) {
|
||||
if (!structFilter.isEmpty()) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("Type '") + structFilter +
|
||||
QStringLiteral("' not found in PDB");
|
||||
} else {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("No types found in PDB");
|
||||
}
|
||||
}
|
||||
|
||||
return ctx.tree;
|
||||
}
|
||||
|
||||
} // namespace rcx
|
||||
|
||||
#else // !_WIN32
|
||||
|
||||
namespace rcx {
|
||||
|
||||
QVector<PdbTypeInfo> enumeratePdbTypes(const QString&, QString* errorMsg) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("PDB import requires Windows");
|
||||
return {};
|
||||
}
|
||||
|
||||
NodeTree importPdbSelected(const QString&, const QVector<uint32_t>&,
|
||||
QString* errorMsg, ProgressCb) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("PDB import requires Windows");
|
||||
return {};
|
||||
}
|
||||
|
||||
NodeTree importPdb(const QString&, const QString&, QString* errorMsg) {
|
||||
if (errorMsg) *errorMsg = QStringLiteral("PDB import requires Windows");
|
||||
return {};
|
||||
}
|
||||
|
||||
} // namespace rcx
|
||||
|
||||
#endif
|
||||
34
src/imports/import_pdb.h
Normal file
34
src/imports/import_pdb.h
Normal file
@@ -0,0 +1,34 @@
|
||||
#pragma once
|
||||
#include "core.h"
|
||||
#include <QVector>
|
||||
#include <functional>
|
||||
|
||||
namespace rcx {
|
||||
|
||||
struct PdbTypeInfo {
|
||||
uint32_t typeIndex; // TPI type index
|
||||
QString name; // struct/class/union name
|
||||
uint64_t size; // sizeof in bytes
|
||||
int childCount; // direct member count
|
||||
bool isUnion; // union vs struct/class
|
||||
};
|
||||
|
||||
// Phase 1: Enumerate all UDT types in the PDB (fast scan, no recursive import).
|
||||
QVector<PdbTypeInfo> enumeratePdbTypes(const QString& pdbPath,
|
||||
QString* errorMsg = nullptr);
|
||||
|
||||
// Phase 2: Import selected types with full recursive child types.
|
||||
// progressCb is called with (current, total) for each top-level type;
|
||||
// return false from the callback to cancel the import.
|
||||
using ProgressCb = std::function<bool(int current, int total)>;
|
||||
NodeTree importPdbSelected(const QString& pdbPath,
|
||||
const QVector<uint32_t>& typeIndices,
|
||||
QString* errorMsg = nullptr,
|
||||
ProgressCb progressCb = {});
|
||||
|
||||
// Legacy single-call API: import one struct by name (or all if filter empty).
|
||||
NodeTree importPdb(const QString& pdbPath,
|
||||
const QString& structFilter = {},
|
||||
QString* errorMsg = nullptr);
|
||||
|
||||
} // namespace rcx
|
||||
184
src/imports/import_pdb_dialog.cpp
Normal file
184
src/imports/import_pdb_dialog.cpp
Normal file
@@ -0,0 +1,184 @@
|
||||
#include "import_pdb_dialog.h"
|
||||
#include "import_pdb.h"
|
||||
|
||||
#include <QVBoxLayout>
|
||||
#include <QHBoxLayout>
|
||||
#include <QLineEdit>
|
||||
#include <QCheckBox>
|
||||
#include <QListWidget>
|
||||
#include <QLabel>
|
||||
#include <QDialogButtonBox>
|
||||
#include <QPushButton>
|
||||
#include <QFileDialog>
|
||||
#include <QMessageBox>
|
||||
#include <QApplication>
|
||||
|
||||
namespace rcx {
|
||||
|
||||
PdbImportDialog::PdbImportDialog(QWidget* parent)
|
||||
: QDialog(parent)
|
||||
{
|
||||
setWindowTitle("Import from PDB");
|
||||
resize(520, 480);
|
||||
|
||||
auto* layout = new QVBoxLayout(this);
|
||||
|
||||
// PDB path row
|
||||
auto* pathRow = new QHBoxLayout;
|
||||
pathRow->addWidget(new QLabel("PDB File:"));
|
||||
m_pathEdit = new QLineEdit;
|
||||
m_pathEdit->setPlaceholderText("Select a PDB file...");
|
||||
pathRow->addWidget(m_pathEdit);
|
||||
m_browseBtn = new QPushButton("...");
|
||||
m_browseBtn->setFixedWidth(32);
|
||||
pathRow->addWidget(m_browseBtn);
|
||||
layout->addLayout(pathRow);
|
||||
|
||||
// Filter row
|
||||
auto* filterRow = new QHBoxLayout;
|
||||
filterRow->addWidget(new QLabel("Filter:"));
|
||||
m_filterEdit = new QLineEdit;
|
||||
m_filterEdit->setPlaceholderText("Type name filter...");
|
||||
m_filterEdit->setEnabled(false);
|
||||
filterRow->addWidget(m_filterEdit);
|
||||
layout->addLayout(filterRow);
|
||||
|
||||
// Select all checkbox
|
||||
m_selectAll = new QCheckBox("Select All");
|
||||
m_selectAll->setEnabled(false);
|
||||
layout->addWidget(m_selectAll);
|
||||
|
||||
// Type list
|
||||
m_typeList = new QListWidget;
|
||||
m_typeList->setEnabled(false);
|
||||
layout->addWidget(m_typeList);
|
||||
|
||||
// Count label
|
||||
m_countLabel = new QLabel("No PDB loaded");
|
||||
layout->addWidget(m_countLabel);
|
||||
|
||||
// Buttons
|
||||
m_buttons = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
|
||||
m_buttons->button(QDialogButtonBox::Ok)->setText("Import");
|
||||
m_buttons->button(QDialogButtonBox::Ok)->setEnabled(false);
|
||||
layout->addWidget(m_buttons);
|
||||
|
||||
connect(m_browseBtn, &QPushButton::clicked, this, &PdbImportDialog::browsePdb);
|
||||
connect(m_pathEdit, &QLineEdit::returnPressed, this, &PdbImportDialog::loadPdb);
|
||||
connect(m_filterEdit, &QLineEdit::textChanged, this, &PdbImportDialog::filterChanged);
|
||||
connect(m_selectAll, &QCheckBox::toggled, this, &PdbImportDialog::selectAllToggled);
|
||||
connect(m_typeList, &QListWidget::itemChanged, this, &PdbImportDialog::updateSelectionCount);
|
||||
connect(m_buttons, &QDialogButtonBox::accepted, this, &QDialog::accept);
|
||||
connect(m_buttons, &QDialogButtonBox::rejected, this, &QDialog::reject);
|
||||
}
|
||||
|
||||
QString PdbImportDialog::pdbPath() const {
|
||||
return m_pathEdit->text();
|
||||
}
|
||||
|
||||
QVector<uint32_t> PdbImportDialog::selectedTypeIndices() const {
|
||||
QVector<uint32_t> result;
|
||||
for (int i = 0; i < m_typeList->count(); i++) {
|
||||
auto* item = m_typeList->item(i);
|
||||
if (item->checkState() == Qt::Checked) {
|
||||
uint32_t typeIndex = item->data(Qt::UserRole).toUInt();
|
||||
result.append(typeIndex);
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
void PdbImportDialog::browsePdb() {
|
||||
QString path = QFileDialog::getOpenFileName(this,
|
||||
"Select PDB File", {},
|
||||
"PDB Files (*.pdb);;All Files (*)");
|
||||
if (path.isEmpty()) return;
|
||||
m_pathEdit->setText(path);
|
||||
loadPdb();
|
||||
}
|
||||
|
||||
void PdbImportDialog::loadPdb() {
|
||||
QString path = m_pathEdit->text();
|
||||
if (path.isEmpty()) return;
|
||||
|
||||
m_typeList->clear();
|
||||
m_allTypes.clear();
|
||||
m_countLabel->setText("Loading...");
|
||||
m_typeList->setEnabled(false);
|
||||
m_filterEdit->setEnabled(false);
|
||||
m_selectAll->setEnabled(false);
|
||||
m_buttons->button(QDialogButtonBox::Ok)->setEnabled(false);
|
||||
QApplication::processEvents();
|
||||
|
||||
QString error;
|
||||
QVector<PdbTypeInfo> types = enumeratePdbTypes(path, &error);
|
||||
|
||||
if (types.isEmpty()) {
|
||||
m_countLabel->setText(error.isEmpty() ? "No types found" : error);
|
||||
return;
|
||||
}
|
||||
|
||||
m_allTypes.reserve(types.size());
|
||||
for (const auto& t : types) {
|
||||
TypeItem item;
|
||||
item.typeIndex = t.typeIndex;
|
||||
item.name = t.name;
|
||||
item.childCount = t.childCount;
|
||||
item.isUnion = t.isUnion;
|
||||
m_allTypes.append(item);
|
||||
}
|
||||
|
||||
// Sort by name
|
||||
std::sort(m_allTypes.begin(), m_allTypes.end(),
|
||||
[](const TypeItem& a, const TypeItem& b) { return a.name < b.name; });
|
||||
|
||||
m_filterEdit->setEnabled(true);
|
||||
m_selectAll->setEnabled(true);
|
||||
m_typeList->setEnabled(true);
|
||||
populateList();
|
||||
}
|
||||
|
||||
void PdbImportDialog::populateList() {
|
||||
m_typeList->blockSignals(true);
|
||||
m_typeList->clear();
|
||||
|
||||
QString filter = m_filterEdit->text();
|
||||
bool selectAll = m_selectAll->isChecked();
|
||||
|
||||
for (const auto& t : m_allTypes) {
|
||||
if (!filter.isEmpty() && !t.name.contains(filter, Qt::CaseInsensitive))
|
||||
continue;
|
||||
|
||||
QString label = QStringLiteral("%1 (%2 fields)")
|
||||
.arg(t.name).arg(t.childCount);
|
||||
auto* item = new QListWidgetItem(label, m_typeList);
|
||||
item->setFlags(item->flags() | Qt::ItemIsUserCheckable);
|
||||
item->setCheckState(selectAll ? Qt::Checked : Qt::Unchecked);
|
||||
item->setData(Qt::UserRole, t.typeIndex);
|
||||
}
|
||||
|
||||
m_typeList->blockSignals(false);
|
||||
updateSelectionCount();
|
||||
}
|
||||
|
||||
void PdbImportDialog::filterChanged(const QString&) {
|
||||
populateList();
|
||||
}
|
||||
|
||||
void PdbImportDialog::selectAllToggled(bool) {
|
||||
populateList();
|
||||
}
|
||||
|
||||
void PdbImportDialog::updateSelectionCount() {
|
||||
int checked = 0;
|
||||
int total = m_typeList->count();
|
||||
for (int i = 0; i < total; i++) {
|
||||
if (m_typeList->item(i)->checkState() == Qt::Checked)
|
||||
checked++;
|
||||
}
|
||||
m_countLabel->setText(QStringLiteral("%1 of %2 types selected")
|
||||
.arg(checked).arg(m_allTypes.size()));
|
||||
m_buttons->button(QDialogButtonBox::Ok)->setEnabled(checked > 0);
|
||||
}
|
||||
|
||||
} // namespace rcx
|
||||
53
src/imports/import_pdb_dialog.h
Normal file
53
src/imports/import_pdb_dialog.h
Normal file
@@ -0,0 +1,53 @@
|
||||
#pragma once
|
||||
|
||||
#include <QDialog>
|
||||
#include <QVector>
|
||||
#include <cstdint>
|
||||
|
||||
class QLineEdit;
|
||||
class QCheckBox;
|
||||
class QListWidget;
|
||||
class QLabel;
|
||||
class QDialogButtonBox;
|
||||
class QPushButton;
|
||||
|
||||
namespace rcx {
|
||||
|
||||
struct PdbTypeInfo;
|
||||
|
||||
class PdbImportDialog : public QDialog {
|
||||
Q_OBJECT
|
||||
public:
|
||||
explicit PdbImportDialog(QWidget* parent = nullptr);
|
||||
|
||||
QString pdbPath() const;
|
||||
QVector<uint32_t> selectedTypeIndices() const;
|
||||
|
||||
private slots:
|
||||
void browsePdb();
|
||||
void loadPdb();
|
||||
void filterChanged(const QString& text);
|
||||
void selectAllToggled(bool checked);
|
||||
void updateSelectionCount();
|
||||
|
||||
private:
|
||||
QLineEdit* m_pathEdit;
|
||||
QPushButton* m_browseBtn;
|
||||
QLineEdit* m_filterEdit;
|
||||
QCheckBox* m_selectAll;
|
||||
QListWidget* m_typeList;
|
||||
QLabel* m_countLabel;
|
||||
QDialogButtonBox* m_buttons;
|
||||
|
||||
struct TypeItem {
|
||||
uint32_t typeIndex;
|
||||
QString name;
|
||||
int childCount;
|
||||
bool isUnion;
|
||||
};
|
||||
QVector<TypeItem> m_allTypes;
|
||||
|
||||
void populateList();
|
||||
};
|
||||
|
||||
} // namespace rcx
|
||||
312
src/main.cpp
312
src/main.cpp
@@ -1,9 +1,11 @@
|
||||
#include "mainwindow.h"
|
||||
#include "providerregistry.h"
|
||||
#include "generator.h"
|
||||
#include "import_reclass_xml.h"
|
||||
#include "import_source.h"
|
||||
#include "export_reclass_xml.h"
|
||||
#include "imports/import_reclass_xml.h"
|
||||
#include "imports/import_source.h"
|
||||
#include "imports/export_reclass_xml.h"
|
||||
#include "imports/import_pdb.h"
|
||||
#include "imports/import_pdb_dialog.h"
|
||||
#include "mcp/mcp_bridge.h"
|
||||
#include <QApplication>
|
||||
#include <QMainWindow>
|
||||
@@ -41,6 +43,7 @@
|
||||
#include <QDialogButtonBox>
|
||||
#include <QVBoxLayout>
|
||||
#include <QDialog>
|
||||
#include <QProgressDialog>
|
||||
#include <Qsci/qsciscintilla.h>
|
||||
#include <Qsci/qscilexercpp.h>
|
||||
#include <QProxyStyle>
|
||||
@@ -94,6 +97,53 @@ static LONG WINAPI crashHandler(EXCEPTION_POINTERS* ep) {
|
||||
#endif
|
||||
fflush(stderr);
|
||||
|
||||
// Phase 1.5: write a full minidump next to the executable
|
||||
{
|
||||
// Build dump path: <exe_dir>/reclass_crash_<YYYYMMDD_HHMMSS>.dmp
|
||||
wchar_t exePath[MAX_PATH] = {};
|
||||
GetModuleFileNameW(NULL, exePath, MAX_PATH);
|
||||
// Strip exe filename to get directory
|
||||
wchar_t* lastSlash = wcsrchr(exePath, L'\\');
|
||||
if (lastSlash) *(lastSlash + 1) = L'\0';
|
||||
|
||||
SYSTEMTIME st;
|
||||
GetLocalTime(&st);
|
||||
wchar_t dumpPath[MAX_PATH];
|
||||
_snwprintf(dumpPath, MAX_PATH,
|
||||
L"%sreclass_crash_%04d%02d%02d_%02d%02d%02d.dmp",
|
||||
exePath, st.wYear, st.wMonth, st.wDay,
|
||||
st.wHour, st.wMinute, st.wSecond);
|
||||
|
||||
HANDLE hFile = CreateFileW(dumpPath, GENERIC_WRITE, 0, NULL,
|
||||
CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
|
||||
if (hFile != INVALID_HANDLE_VALUE) {
|
||||
MINIDUMP_EXCEPTION_INFORMATION mei;
|
||||
mei.ThreadId = GetCurrentThreadId();
|
||||
mei.ExceptionPointers = ep;
|
||||
mei.ClientPointers = FALSE;
|
||||
|
||||
// MiniDumpWithFullMemory: captures entire process address space
|
||||
// so we can inspect all heap objects, Qt state, node trees, etc.
|
||||
BOOL ok = MiniDumpWriteDump(
|
||||
GetCurrentProcess(), GetCurrentProcessId(), hFile,
|
||||
static_cast<MINIDUMP_TYPE>(MiniDumpWithFullMemory
|
||||
| MiniDumpWithHandleData
|
||||
| MiniDumpWithThreadInfo
|
||||
| MiniDumpWithUnloadedModules),
|
||||
&mei, NULL, NULL);
|
||||
CloseHandle(hFile);
|
||||
|
||||
if (ok) {
|
||||
fprintf(stderr, "Dump : %ls\n", dumpPath);
|
||||
} else {
|
||||
fprintf(stderr, "Dump : FAILED (error %lu)\n", GetLastError());
|
||||
}
|
||||
} else {
|
||||
fprintf(stderr, "Dump : could not create file (error %lu)\n", GetLastError());
|
||||
}
|
||||
fflush(stderr);
|
||||
}
|
||||
|
||||
// Phase 2: attempt symbol resolution + stack walk
|
||||
// Copy context so StackWalk64 can mutate it safely
|
||||
CONTEXT ctxCopy = *ep->ContextRecord;
|
||||
@@ -201,6 +251,9 @@ public:
|
||||
// Kill the 1px frame margin Fusion reserves around QMenu contents
|
||||
if (metric == PM_MenuPanelWidth)
|
||||
return 0;
|
||||
// Kill the separator between dock widgets / central widget
|
||||
if (metric == PM_DockWidgetSeparatorExtent)
|
||||
return 0;
|
||||
return QProxyStyle::pixelMetric(metric, opt, w);
|
||||
}
|
||||
void drawPrimitive(PrimitiveElement elem, const QStyleOption* opt,
|
||||
@@ -211,21 +264,37 @@ public:
|
||||
// Kill the status bar item frame and panel border
|
||||
if (elem == PE_FrameStatusBarItem || elem == PE_PanelStatusBar)
|
||||
return;
|
||||
// Transparent menu bar background (no CSS needed)
|
||||
if (elem == PE_PanelMenuBar)
|
||||
return;
|
||||
QProxyStyle::drawPrimitive(elem, opt, p, w);
|
||||
}
|
||||
void drawControl(ControlElement element, const QStyleOption* opt,
|
||||
QPainter* p, const QWidget* w) const override {
|
||||
// Menu bar items (File, Edit, View…) — direct paint, Fusion ignores palette
|
||||
// Suppress Fusion's CE_MenuBarEmptyArea — it fills with palette.window()
|
||||
// bypassing PE_PanelMenuBar. TitleBarWidget paints the background.
|
||||
if (element == CE_MenuBarEmptyArea)
|
||||
return;
|
||||
// Menu bar items — fully owned painting (Fusion fills full rect, hiding border)
|
||||
if (element == CE_MenuBarItem) {
|
||||
if (auto* mi = qstyleoption_cast<const QStyleOptionMenuItem*>(opt)) {
|
||||
if (mi->state & (State_Selected | State_Sunken)) {
|
||||
QStyleOptionMenuItem patched = *mi;
|
||||
patched.state &= ~(State_Selected | State_Sunken);
|
||||
patched.palette.setColor(QPalette::ButtonText,
|
||||
mi->palette.color(QPalette::Link)); // amber text only
|
||||
QProxyStyle::drawControl(element, &patched, p, w);
|
||||
return;
|
||||
}
|
||||
QRect area = mi->rect.adjusted(0, 0, 0, -1); // leave 1px for border
|
||||
bool selected = mi->state & State_Selected;
|
||||
bool sunken = mi->state & State_Sunken;
|
||||
|
||||
// Only fill background for hover/pressed — non-hovered stays
|
||||
// transparent so the parent's border line shows through.
|
||||
if (sunken)
|
||||
p->fillRect(area, mi->palette.color(QPalette::Mid).darker(130));
|
||||
else if (selected)
|
||||
p->fillRect(area, mi->palette.color(QPalette::Mid));
|
||||
|
||||
QColor fg = (selected || sunken)
|
||||
? mi->palette.color(QPalette::Link)
|
||||
: mi->palette.color(QPalette::ButtonText);
|
||||
p->setPen(fg);
|
||||
p->drawText(area, Qt::AlignCenter | Qt::TextShowMnemonic, mi->text);
|
||||
return; // never delegate to Fusion
|
||||
}
|
||||
}
|
||||
// Popup menu items — palette patch then delegate to Fusion
|
||||
@@ -235,7 +304,7 @@ public:
|
||||
&& mi->menuItemType != QStyleOptionMenuItem::Separator) {
|
||||
QStyleOptionMenuItem patched = *mi;
|
||||
patched.palette.setColor(QPalette::Highlight,
|
||||
mi->palette.color(QPalette::Mid)); // theme.border
|
||||
mi->palette.color(QPalette::Mid)); // theme.hover
|
||||
patched.palette.setColor(QPalette::HighlightedText,
|
||||
mi->palette.color(QPalette::Link)); // theme.indHoverSpan
|
||||
QProxyStyle::drawControl(element, &patched, p, w);
|
||||
@@ -431,6 +500,7 @@ void MainWindow::createMenus() {
|
||||
Qt5Qt6AddAction(file, "Export ReClass &XML...", QKeySequence::UnknownKey, QIcon(), this, &MainWindow::exportReclassXmlAction);
|
||||
Qt5Qt6AddAction(file, "Import from &Source...", QKeySequence::UnknownKey, QIcon(), this, &MainWindow::importFromSource);
|
||||
Qt5Qt6AddAction(file, "&Import ReClass XML...", QKeySequence::UnknownKey, QIcon(), this, &MainWindow::importReclassXml);
|
||||
Qt5Qt6AddAction(file, "Import &PDB...", QKeySequence::UnknownKey, QIcon(), this, &MainWindow::importPdb);
|
||||
// Examples submenu — scan once at init
|
||||
{
|
||||
QDir exDir(QCoreApplication::applicationDirPath() + "/examples");
|
||||
@@ -566,12 +636,14 @@ private:
|
||||
// ── Custom-painted view tab button (no CSS) ──
|
||||
class ViewTabButton : public QPushButton {
|
||||
public:
|
||||
static constexpr int kAccentH = 2; // accent line height in pixels
|
||||
static constexpr int kAccentH = 3; // accent line height in pixels
|
||||
static constexpr int kPadLR = 12; // horizontal padding
|
||||
static constexpr int kPadBot = 4; // extra bottom padding
|
||||
|
||||
int baselineY = -1; // set by FlatStatusBar for cross-widget text alignment
|
||||
|
||||
QColor colBg, colBgChecked, colBgHover, colBgPressed;
|
||||
QColor colText, colTextMuted, colAccent;
|
||||
QColor colText, colTextMuted, colAccent, colBorder;
|
||||
|
||||
explicit ViewTabButton(const QString& text, QWidget* parent = nullptr)
|
||||
: QPushButton(text, parent) {
|
||||
@@ -599,15 +671,23 @@ protected:
|
||||
else if (isChecked()) bg = colBgChecked;
|
||||
p.fillRect(rect(), bg);
|
||||
|
||||
// Accent line at y=0 when checked
|
||||
// Top border (continuous with status bar hairline)
|
||||
if (colBorder.isValid())
|
||||
p.fillRect(0, 0, width(), 1, colBorder);
|
||||
|
||||
// Accent line at y=0 when checked (paints over border)
|
||||
if (isChecked())
|
||||
p.fillRect(0, 0, width(), kAccentH, colAccent);
|
||||
|
||||
// Text
|
||||
// Text — use shared baseline if set, otherwise fall back to VCenter
|
||||
p.setPen(isChecked() || underMouse() || isDown() ? colText : colTextMuted);
|
||||
p.setFont(font());
|
||||
QRect textRect(kPadLR, kAccentH, width() - 2 * kPadLR, height() - kAccentH);
|
||||
p.drawText(textRect, Qt::AlignVCenter | Qt::AlignLeft, text());
|
||||
if (baselineY >= 0) {
|
||||
p.drawText(kPadLR, baselineY, text());
|
||||
} else {
|
||||
QRect textRect(kPadLR, kAccentH, width() - 2 * kPadLR, height() - kAccentH);
|
||||
p.drawText(textRect, Qt::AlignVCenter | Qt::AlignLeft, text());
|
||||
}
|
||||
}
|
||||
|
||||
void enterEvent(QEnterEvent*) override { update(); }
|
||||
@@ -624,13 +704,34 @@ public:
|
||||
QWidget* tabRow = nullptr; // set by createStatusBar
|
||||
QLabel* label = nullptr; // set by createStatusBar
|
||||
|
||||
void setDividerColor(const QColor& c) { m_div = c; update(); }
|
||||
void setTopLineColor(const QColor& c) { m_top = c; update(); }
|
||||
|
||||
explicit FlatStatusBar(QWidget* parent = nullptr) : QStatusBar(parent) {
|
||||
setSizeGripEnabled(false);
|
||||
}
|
||||
|
||||
QSize sizeHint() const override {
|
||||
const int tabH = tabRow ? tabRow->sizeHint().height() : 0;
|
||||
const int textH = fontMetrics().height();
|
||||
const int base = qMax(tabH, textH + 6);
|
||||
const int h = qRound(base * 1.15);
|
||||
return { QStatusBar::sizeHint().width(), h };
|
||||
}
|
||||
QSize minimumSizeHint() const override { return sizeHint(); }
|
||||
|
||||
protected:
|
||||
void paintEvent(QPaintEvent*) override {
|
||||
QPainter p(this);
|
||||
p.fillRect(rect(), palette().window());
|
||||
|
||||
// Top hairline separator
|
||||
if (m_top.isValid())
|
||||
p.fillRect(0, 0, width(), 1, m_top);
|
||||
|
||||
// Vertical divider between tabRow and label
|
||||
if (m_div.isValid() && m_divX >= 0)
|
||||
p.fillRect(m_divX, 4, 1, height() - 8, m_div);
|
||||
}
|
||||
void resizeEvent(QResizeEvent* e) override {
|
||||
QStatusBar::resizeEvent(e);
|
||||
@@ -641,12 +742,35 @@ protected:
|
||||
manualLayout();
|
||||
}
|
||||
private:
|
||||
QColor m_div, m_top;
|
||||
int m_divX = -1;
|
||||
|
||||
void manualLayout() {
|
||||
if (!tabRow || !label) return;
|
||||
int h = height();
|
||||
int tw = tabRow->sizeHint().width();
|
||||
const int h = height();
|
||||
const int tw = tabRow->sizeHint().width();
|
||||
const int gutter = 6;
|
||||
tabRow->setGeometry(0, 0, tw, h);
|
||||
label->setGeometry(tw, 0, width() - tw, h);
|
||||
m_divX = tw;
|
||||
label->setGeometry(tw + 1 + gutter, 0,
|
||||
qMax(0, width() - (tw + 1 + gutter)), h);
|
||||
|
||||
// Shared baseline so tab text and status text align.
|
||||
// Nudge up by half the accent-line height so text centres
|
||||
// in the visible area below the accent bar, not in the full bar.
|
||||
QFontMetrics fm(font());
|
||||
int by = (h + fm.ascent()) / 2 - (ViewTabButton::kAccentH + 1) / 2;
|
||||
|
||||
// Push baseline to buttons
|
||||
auto* lay = tabRow->layout();
|
||||
if (lay) {
|
||||
for (int i = 0; i < lay->count(); i++)
|
||||
static_cast<ViewTabButton*>(lay->itemAt(i)->widget())->baselineY = by;
|
||||
}
|
||||
// Align label: set top margin so text baseline matches
|
||||
int labelTop = by - fm.ascent();
|
||||
label->setContentsMargins(0, labelTop, 0, 0);
|
||||
label->setAlignment(Qt::AlignLeft | Qt::AlignTop);
|
||||
}
|
||||
};
|
||||
|
||||
@@ -657,7 +781,8 @@ void MainWindow::createStatusBar() {
|
||||
setStatusBar(sb);
|
||||
|
||||
m_statusLabel = new QLabel("Ready", sb);
|
||||
m_statusLabel->setContentsMargins(10, 0, 0, 0);
|
||||
m_statusLabel->setContentsMargins(0, 0, 0, 0);
|
||||
m_statusLabel->setAlignment(Qt::AlignVCenter | Qt::AlignLeft);
|
||||
|
||||
// View toggle buttons (Reclass / C/C++) — custom painted, no CSS
|
||||
m_viewBtnGroup = new QButtonGroup(this);
|
||||
@@ -671,7 +796,7 @@ void MainWindow::createStatusBar() {
|
||||
m_viewBtnGroup->addButton(m_btnReclass, 0);
|
||||
m_viewBtnGroup->addButton(m_btnRendered, 1);
|
||||
|
||||
// Wrap buttons in a zero-margin container — direct child of status bar
|
||||
// Wrap buttons in a plain container — FlatStatusBar paints the chrome
|
||||
auto* tabRow = new QWidget(sb);
|
||||
auto* tabLay = new QHBoxLayout(tabRow);
|
||||
tabLay->setContentsMargins(0, 0, 0, 0);
|
||||
@@ -682,6 +807,9 @@ void MainWindow::createStatusBar() {
|
||||
sb->tabRow = tabRow;
|
||||
sb->label = m_statusLabel;
|
||||
|
||||
sb->setMinimumHeight(qMax(m_btnReclass->sizeHint().height(),
|
||||
sb->fontMetrics().height() + 6));
|
||||
|
||||
connect(m_viewBtnGroup, &QButtonGroup::idClicked, this, [this](int id) {
|
||||
setViewMode(id == 1 ? VM_Rendered : VM_Reclass);
|
||||
});
|
||||
@@ -700,6 +828,9 @@ void MainWindow::createStatusBar() {
|
||||
statusBar()->setPalette(sbPal);
|
||||
statusBar()->setAutoFillBackground(true);
|
||||
|
||||
sb->setTopLineColor(t.border);
|
||||
sb->setDividerColor(t.border);
|
||||
|
||||
auto applyViewTabColors = [&](ViewTabButton* btn) {
|
||||
btn->colBg = t.background;
|
||||
btn->colBgChecked = t.backgroundAlt;
|
||||
@@ -708,20 +839,12 @@ void MainWindow::createStatusBar() {
|
||||
btn->colText = t.text;
|
||||
btn->colTextMuted = t.textMuted;
|
||||
btn->colAccent = t.indHoverSpan;
|
||||
btn->colBorder = t.border;
|
||||
};
|
||||
applyViewTabColors(static_cast<ViewTabButton*>(m_btnReclass));
|
||||
applyViewTabColors(static_cast<ViewTabButton*>(m_btnRendered));
|
||||
}
|
||||
|
||||
// Sync status bar font with editor font at startup
|
||||
{
|
||||
QString fontName = QSettings("Reclass", "Reclass").value("font", "JetBrains Mono").toString();
|
||||
QFont f(fontName, 12);
|
||||
f.setFixedPitch(true);
|
||||
statusBar()->setFont(f);
|
||||
m_btnReclass->setFont(f);
|
||||
m_btnRendered->setFont(f);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1081,6 +1204,7 @@ void MainWindow::selfTest() {
|
||||
// Attach process memory to self — provider base will be set to the editor address
|
||||
DWORD pid = GetCurrentProcessId();
|
||||
QString target = QString("%1:Reclass.exe").arg(pid);
|
||||
|
||||
ctrl->attachViaPlugin(QStringLiteral("processmemory"), target);
|
||||
#else
|
||||
project_new();
|
||||
@@ -1247,8 +1371,7 @@ void MainWindow::toggleMcp() {
|
||||
void MainWindow::applyTheme(const Theme& theme) {
|
||||
applyGlobalTheme(theme);
|
||||
|
||||
// Kill the 1px separator line between central widget and status bar
|
||||
setStyleSheet("QMainWindow::separator { height: 0px; width: 0px; }");
|
||||
// Separator killed via PM_DockWidgetSeparatorExtent in MenuBarStyle
|
||||
|
||||
// Custom title bar
|
||||
m_titleBar->applyTheme(theme);
|
||||
@@ -1276,7 +1399,7 @@ void MainWindow::applyTheme(const Theme& theme) {
|
||||
sbPal.setColor(QPalette::WindowText, theme.textDim);
|
||||
statusBar()->setPalette(sbPal);
|
||||
}
|
||||
// View toggle buttons in status bar
|
||||
// View toggle buttons + status bar chrome
|
||||
{
|
||||
auto applyColors = [&](ViewTabButton* btn) {
|
||||
btn->colBg = theme.background;
|
||||
@@ -1286,10 +1409,16 @@ void MainWindow::applyTheme(const Theme& theme) {
|
||||
btn->colText = theme.text;
|
||||
btn->colTextMuted = theme.textMuted;
|
||||
btn->colAccent = theme.indHoverSpan;
|
||||
btn->colBorder = theme.border;
|
||||
btn->update();
|
||||
};
|
||||
applyColors(static_cast<ViewTabButton*>(m_btnReclass));
|
||||
applyColors(static_cast<ViewTabButton*>(m_btnRendered));
|
||||
|
||||
{ auto* fsb = static_cast<FlatStatusBar*>(statusBar());
|
||||
fsb->setTopLineColor(theme.border);
|
||||
fsb->setDividerColor(theme.border);
|
||||
}
|
||||
}
|
||||
// Resize grip (direct child of main window, not in status bar)
|
||||
if (auto* w = findChild<QWidget*>("resizeGrip"))
|
||||
@@ -1427,10 +1556,6 @@ void MainWindow::setEditorFont(const QString& fontName) {
|
||||
// Sync dock titlebar font
|
||||
if (m_dockTitleLabel)
|
||||
m_dockTitleLabel->setFont(f);
|
||||
// Sync status bar font
|
||||
statusBar()->setFont(f);
|
||||
m_btnReclass->setFont(f);
|
||||
m_btnRendered->setFont(f);
|
||||
}
|
||||
|
||||
RcxController* MainWindow::activeController() const {
|
||||
@@ -1751,6 +1876,56 @@ void MainWindow::importFromSource() {
|
||||
m_statusLabel->setText(QStringLiteral("Imported %1 classes from source").arg(classCount));
|
||||
}
|
||||
|
||||
// ── Import PDB ──
|
||||
|
||||
void MainWindow::importPdb() {
|
||||
rcx::PdbImportDialog dlg(this);
|
||||
if (dlg.exec() != QDialog::Accepted) return;
|
||||
|
||||
QString pdbPath = dlg.pdbPath();
|
||||
QVector<uint32_t> indices = dlg.selectedTypeIndices();
|
||||
if (indices.isEmpty()) return;
|
||||
|
||||
QProgressDialog progress("Importing types...", "Cancel", 0, indices.size(), this);
|
||||
progress.setWindowModality(Qt::WindowModal);
|
||||
progress.setMinimumDuration(200);
|
||||
bool cancelled = false;
|
||||
|
||||
QString error;
|
||||
NodeTree tree = rcx::importPdbSelected(pdbPath, indices, &error,
|
||||
[&](int current, int total) -> bool {
|
||||
progress.setMaximum(total);
|
||||
progress.setValue(current);
|
||||
QApplication::processEvents();
|
||||
if (progress.wasCanceled()) {
|
||||
cancelled = true;
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
});
|
||||
progress.close();
|
||||
|
||||
if (tree.nodes.isEmpty()) {
|
||||
if (!cancelled)
|
||||
QMessageBox::warning(this, "Import Failed", error.isEmpty()
|
||||
? QStringLiteral("No types imported") : error);
|
||||
return;
|
||||
}
|
||||
|
||||
int classCount = 0;
|
||||
for (const auto& n : tree.nodes)
|
||||
if (n.parentId == 0 && n.kind == rcx::NodeKind::Struct) classCount++;
|
||||
|
||||
auto* doc = new rcx::RcxDocument(this);
|
||||
doc->tree = std::move(tree);
|
||||
|
||||
m_mdiArea->closeAllSubWindows();
|
||||
createTab(doc);
|
||||
rebuildWorkspaceModel();
|
||||
m_statusLabel->setText(QStringLiteral("Imported %1 classes from %2")
|
||||
.arg(classCount).arg(QFileInfo(pdbPath).fileName()));
|
||||
}
|
||||
|
||||
// ── Type Aliases Dialog ──
|
||||
|
||||
void MainWindow::showTypeAliasesDialog() {
|
||||
@@ -1819,7 +1994,22 @@ QMdiSubWindow* MainWindow::project_new(const QString& classKeyword) {
|
||||
|
||||
buildEmptyStruct(doc->tree, classKeyword);
|
||||
|
||||
// Inherit source from current tab (if any)
|
||||
auto* currentCtrl = activeController();
|
||||
if (currentCtrl && currentCtrl->document()->provider
|
||||
&& currentCtrl->document()->provider->isValid()) {
|
||||
doc->provider = currentCtrl->document()->provider;
|
||||
}
|
||||
|
||||
auto* sub = createTab(doc);
|
||||
|
||||
// Copy saved sources to new tab's controller
|
||||
if (currentCtrl && !currentCtrl->savedSources().isEmpty()) {
|
||||
auto& newTab = m_tabs[sub];
|
||||
newTab.ctrl->copySavedSources(currentCtrl->savedSources(),
|
||||
currentCtrl->activeSourceIndex());
|
||||
}
|
||||
|
||||
rebuildWorkspaceModel();
|
||||
return sub;
|
||||
}
|
||||
@@ -2115,14 +2305,39 @@ void MainWindow::populateSourceMenu() {
|
||||
m_sourceMenu->clear();
|
||||
auto* ctrl = activeController();
|
||||
|
||||
m_sourceMenu->addAction("File", this, [this]() {
|
||||
// Icon map for known provider identifiers
|
||||
static const QHash<QString, QString> s_providerIcons = {
|
||||
{QStringLiteral("processmemory"), QStringLiteral(":/vsicons/server-process.svg")},
|
||||
{QStringLiteral("remoteprocessmemory"), QStringLiteral(":/vsicons/remote.svg")},
|
||||
{QStringLiteral("windbgmemory"), QStringLiteral(":/vsicons/debug.svg")},
|
||||
{QStringLiteral("reclass.netcompatlayer"), QStringLiteral(":/vsicons/plug.svg")},
|
||||
};
|
||||
|
||||
auto addSourceAction = [this](const QString& text, const QIcon& icon, auto&& slot) {
|
||||
auto* act = m_sourceMenu->addAction(icon, text);
|
||||
act->setIconVisibleInMenu(true);
|
||||
connect(act, &QAction::triggered, this, std::forward<decltype(slot)>(slot));
|
||||
return act;
|
||||
};
|
||||
|
||||
addSourceAction(QStringLiteral("File"),
|
||||
makeIcon(QStringLiteral(":/vsicons/file-binary.svg")),
|
||||
[this]() {
|
||||
if (auto* c = activeController()) c->selectSource(QStringLiteral("File"));
|
||||
});
|
||||
|
||||
const auto& providers = ProviderRegistry::instance().providers();
|
||||
for (const auto& prov : providers) {
|
||||
QString name = prov.name;
|
||||
m_sourceMenu->addAction(name, this, [this, name]() {
|
||||
auto it = s_providerIcons.constFind(prov.identifier);
|
||||
QIcon icon = makeIcon(it != s_providerIcons.constEnd() ? *it
|
||||
: QStringLiteral(":/vsicons/extensions.svg"));
|
||||
|
||||
QString label = prov.dllFileName.isEmpty()
|
||||
? name
|
||||
: QStringLiteral("%1 (%2)").arg(name, prov.dllFileName);
|
||||
|
||||
addSourceAction(label, icon, [this, name]() {
|
||||
if (auto* c = activeController()) c->selectSource(name);
|
||||
});
|
||||
}
|
||||
@@ -2132,17 +2347,20 @@ void MainWindow::populateSourceMenu() {
|
||||
for (int i = 0; i < ctrl->savedSources().size(); i++) {
|
||||
const auto& e = ctrl->savedSources()[i];
|
||||
auto* act = m_sourceMenu->addAction(
|
||||
QStringLiteral("%1 '%2'").arg(e.kind, e.displayName),
|
||||
this, [this, i]() {
|
||||
if (auto* c = activeController()) c->switchSource(i);
|
||||
});
|
||||
QStringLiteral("%1 '%2'").arg(e.kind, e.displayName));
|
||||
act->setCheckable(true);
|
||||
act->setChecked(i == ctrl->activeSourceIndex());
|
||||
connect(act, &QAction::triggered, this, [this, i]() {
|
||||
if (auto* c = activeController()) c->switchSource(i);
|
||||
});
|
||||
}
|
||||
m_sourceMenu->addSeparator();
|
||||
m_sourceMenu->addAction("Clear All", this, [this]() {
|
||||
auto* clearAct = addSourceAction(QStringLiteral("Clear All"),
|
||||
makeIcon(QStringLiteral(":/vsicons/clear-all.svg")),
|
||||
[this]() {
|
||||
if (auto* c = activeController()) c->clearSources();
|
||||
});
|
||||
Q_UNUSED(clearAct);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -53,6 +53,7 @@ private slots:
|
||||
void exportReclassXmlAction();
|
||||
void importFromSource();
|
||||
void importReclassXml();
|
||||
void importPdb();
|
||||
void showTypeAliasesDialog();
|
||||
void editTheme();
|
||||
void showOptionsDialog();
|
||||
|
||||
@@ -92,7 +92,8 @@ bool PluginManager::LoadPlugin(const QString& path)
|
||||
IProviderPlugin* provider = static_cast<IProviderPlugin*>(plugin);
|
||||
QString name = QString::fromStdString(plugin->Name());
|
||||
QString identifier = name.toLower().replace(" ", "");
|
||||
ProviderRegistry::instance().registerProvider(name, identifier, provider);
|
||||
QString dllFileName = QFileInfo(path).fileName();
|
||||
ProviderRegistry::instance().registerProvider(name, identifier, provider, dllFileName);
|
||||
}
|
||||
|
||||
return true;
|
||||
|
||||
@@ -6,7 +6,8 @@ ProviderRegistry& ProviderRegistry::instance() {
|
||||
return s_instance;
|
||||
}
|
||||
|
||||
void ProviderRegistry::registerProvider(const QString& name, const QString& identifier, IProviderPlugin* plugin) {
|
||||
void ProviderRegistry::registerProvider(const QString& name, const QString& identifier,
|
||||
IProviderPlugin* plugin, const QString& dllFileName) {
|
||||
// Check if already registered
|
||||
for (const auto& info : m_providers) {
|
||||
if (info.identifier == identifier) {
|
||||
@@ -14,8 +15,8 @@ void ProviderRegistry::registerProvider(const QString& name, const QString& iden
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
m_providers.append(ProviderInfo(name, identifier, plugin));
|
||||
|
||||
m_providers.append(ProviderInfo(name, identifier, plugin, dllFileName));
|
||||
qDebug() << "ProviderRegistry: Registered plugin provider:" << name << "(" << identifier << ")";
|
||||
}
|
||||
|
||||
|
||||
@@ -25,10 +25,13 @@ public:
|
||||
IProviderPlugin* plugin; // Plugin (if plugin-based)
|
||||
BuiltinFactory factory; // Factory (if built-in)
|
||||
bool isBuiltin;
|
||||
|
||||
ProviderInfo(const QString& n, const QString& id, IProviderPlugin* p)
|
||||
: name(n), identifier(id), plugin(p), factory(nullptr), isBuiltin(false) {}
|
||||
|
||||
QString dllFileName; // Original DLL/SO filename (plugin-based only)
|
||||
|
||||
ProviderInfo(const QString& n, const QString& id, IProviderPlugin* p,
|
||||
const QString& dll = {})
|
||||
: name(n), identifier(id), plugin(p), factory(nullptr),
|
||||
isBuiltin(false), dllFileName(dll) {}
|
||||
|
||||
ProviderInfo(const QString& n, const QString& id, BuiltinFactory f)
|
||||
: name(n), identifier(id), plugin(nullptr), factory(f), isBuiltin(true) {}
|
||||
};
|
||||
@@ -36,7 +39,8 @@ public:
|
||||
static ProviderRegistry& instance();
|
||||
|
||||
// Register a plugin-based provider
|
||||
void registerProvider(const QString& name, const QString& identifier, IProviderPlugin* plugin);
|
||||
void registerProvider(const QString& name, const QString& identifier, IProviderPlugin* plugin,
|
||||
const QString& dllFileName = {});
|
||||
|
||||
// Register a built-in provider with a factory function
|
||||
void registerBuiltinProvider(const QString& name, const QString& identifier, BuiltinFactory factory);
|
||||
|
||||
@@ -47,6 +47,13 @@ public:
|
||||
return {};
|
||||
}
|
||||
|
||||
// Resolve a module/symbol name to its address (reverse of getSymbol).
|
||||
// Returns 0 if the name is not found.
|
||||
virtual uint64_t symbolToAddress(const QString& name) const {
|
||||
Q_UNUSED(name);
|
||||
return 0;
|
||||
}
|
||||
|
||||
// --- Derived convenience (non-virtual, never override) ---
|
||||
|
||||
bool isValid() const { return size() > 0; }
|
||||
|
||||
@@ -67,6 +67,9 @@ public:
|
||||
QString getSymbol(uint64_t addr) const override {
|
||||
return m_real ? m_real->getSymbol(addr) : QString();
|
||||
}
|
||||
uint64_t symbolToAddress(const QString& n) const override {
|
||||
return m_real ? m_real->symbolToAddress(n) : 0;
|
||||
}
|
||||
|
||||
bool write(uint64_t addr, const void* buf, int len) override {
|
||||
if (!m_real) return false;
|
||||
|
||||
@@ -51,5 +51,9 @@
|
||||
<file alias="chevron-down.svg">vsicons/chevron-down.svg</file>
|
||||
<file alias="folder.svg">vsicons/folder.svg</file>
|
||||
<file alias="symbol-enum.svg">vsicons/symbol-enum.svg</file>
|
||||
<file alias="server-process.svg">vsicons/server-process.svg</file>
|
||||
<file alias="remote.svg">vsicons/remote.svg</file>
|
||||
<file alias="plug.svg">vsicons/plug.svg</file>
|
||||
<file alias="clear-all.svg">vsicons/clear-all.svg</file>
|
||||
</qresource>
|
||||
</RCC>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include "theme.h"
|
||||
#include <QtGlobal>
|
||||
#include <type_traits>
|
||||
|
||||
namespace rcx {
|
||||
@@ -61,6 +62,15 @@ Theme Theme::fromJson(const QJsonObject& o) {
|
||||
t.indHeatWarm = t.indHoverSpan.isValid() ? t.indHoverSpan : t.syntaxString;
|
||||
if (!t.indHeatHot.isValid())
|
||||
t.indHeatHot = t.markerPtr;
|
||||
|
||||
// Ensure hover is visually distinct from background
|
||||
if (t.hover.isValid() && t.background.isValid()) {
|
||||
int dist = qAbs(t.hover.red() - t.background.red())
|
||||
+ qAbs(t.hover.green() - t.background.green())
|
||||
+ qAbs(t.hover.blue() - t.background.blue());
|
||||
if (dist < 20)
|
||||
t.hover = t.background.lighter(130);
|
||||
}
|
||||
return t;
|
||||
}
|
||||
|
||||
|
||||
@@ -76,14 +76,16 @@ void TitleBarWidget::applyTheme(const Theme& theme) {
|
||||
QStringLiteral("QLabel { color: %1; font-size: 12px; font-weight: bold; }")
|
||||
.arg(theme.textDim.name()));
|
||||
|
||||
// Menu bar styling — transparent background, themed text
|
||||
m_menuBar->setStyleSheet(
|
||||
QStringLiteral(
|
||||
"QMenuBar { background: transparent; border: none; }"
|
||||
"QMenuBar::item { background: transparent; color: %1; padding: 8px 8px 4px 8px; }"
|
||||
"QMenuBar::item:selected { background: %2; }"
|
||||
"QMenuBar::item:pressed { background: %2; }")
|
||||
.arg(theme.textDim.name(), theme.hover.name()));
|
||||
// Menu bar palette — hover/bg handled by MenuBarStyle QProxyStyle.
|
||||
// Set Window + Button to background so Fusion never paints a foreign color.
|
||||
{
|
||||
QPalette mbPal = m_menuBar->palette();
|
||||
mbPal.setColor(QPalette::Window, theme.background);
|
||||
mbPal.setColor(QPalette::Button, theme.background);
|
||||
mbPal.setColor(QPalette::ButtonText, theme.textDim);
|
||||
m_menuBar->setPalette(mbPal);
|
||||
m_menuBar->setAutoFillBackground(false);
|
||||
}
|
||||
|
||||
// Chrome buttons
|
||||
QString btnStyle = QStringLiteral(
|
||||
|
||||
82
tests/bench_import_pdb.cpp
Normal file
82
tests/bench_import_pdb.cpp
Normal file
@@ -0,0 +1,82 @@
|
||||
#include <QtTest/QtTest>
|
||||
#include "core.h"
|
||||
#include "imports/import_pdb.h"
|
||||
|
||||
using namespace rcx;
|
||||
|
||||
class BenchImportPdb : public QObject {
|
||||
Q_OBJECT
|
||||
private slots:
|
||||
void benchEnumerateAll();
|
||||
void benchImportAll();
|
||||
};
|
||||
|
||||
static const QString kPdbPath = QStringLiteral(
|
||||
"C:/Symbols/ntkrnlmp.pdb/0762CF42EF7F3E8116EF7329ADAA09A31/ntkrnlmp.pdb");
|
||||
|
||||
void BenchImportPdb::benchEnumerateAll() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
QString err;
|
||||
QElapsedTimer timer;
|
||||
timer.start();
|
||||
QVector<PdbTypeInfo> types = enumeratePdbTypes(kPdbPath, &err);
|
||||
qint64 elapsed = timer.elapsed();
|
||||
|
||||
QVERIFY2(!types.isEmpty(), qPrintable(err));
|
||||
qDebug() << "enumeratePdbTypes:" << types.size() << "types in" << elapsed << "ms";
|
||||
}
|
||||
|
||||
void BenchImportPdb::benchImportAll() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
// Phase 1: enumerate
|
||||
QString err;
|
||||
QElapsedTimer timer;
|
||||
timer.start();
|
||||
QVector<PdbTypeInfo> types = enumeratePdbTypes(kPdbPath, &err);
|
||||
qint64 enumerateMs = timer.elapsed();
|
||||
QVERIFY2(!types.isEmpty(), qPrintable(err));
|
||||
|
||||
// Collect all type indices
|
||||
QVector<uint32_t> indices;
|
||||
indices.reserve(types.size());
|
||||
for (const auto& t : types)
|
||||
indices.append(t.typeIndex);
|
||||
|
||||
// Phase 2: import all
|
||||
timer.restart();
|
||||
int lastProgress = 0;
|
||||
NodeTree tree = importPdbSelected(kPdbPath, indices, &err,
|
||||
[&](int cur, int total) -> bool {
|
||||
// Report progress at 25% intervals
|
||||
int pct = (cur * 100) / total;
|
||||
if (pct >= lastProgress + 25) {
|
||||
qDebug() << " progress:" << cur << "/" << total
|
||||
<< "(" << pct << "%)";
|
||||
lastProgress = pct;
|
||||
}
|
||||
return true;
|
||||
});
|
||||
qint64 importMs = timer.elapsed();
|
||||
|
||||
QVERIFY2(!tree.nodes.isEmpty(), qPrintable(err));
|
||||
|
||||
// Count root structs
|
||||
int rootCount = 0;
|
||||
for (const auto& n : tree.nodes)
|
||||
if (n.parentId == 0 && n.kind == NodeKind::Struct) rootCount++;
|
||||
|
||||
qDebug() << "";
|
||||
qDebug() << "=== PDB Import Benchmark (ntkrnlmp.pdb) ===";
|
||||
qDebug() << " Enumerate:" << types.size() << "types in" << enumerateMs << "ms";
|
||||
qDebug() << " Import all:" << rootCount << "root structs,"
|
||||
<< tree.nodes.size() << "total nodes in" << importMs << "ms";
|
||||
qDebug() << " Total:" << (enumerateMs + importMs) << "ms";
|
||||
qDebug() << "============================================";
|
||||
}
|
||||
|
||||
QTEST_MAIN(BenchImportPdb)
|
||||
#include "bench_import_pdb.moc"
|
||||
219
tests/test_addressparser.cpp
Normal file
219
tests/test_addressparser.cpp
Normal file
@@ -0,0 +1,219 @@
|
||||
#include "addressparser.h"
|
||||
#include <QTest>
|
||||
|
||||
using rcx::AddressParser;
|
||||
using rcx::AddressParserCallbacks;
|
||||
using rcx::AddressParseResult;
|
||||
|
||||
class TestAddressParser : public QObject {
|
||||
Q_OBJECT
|
||||
|
||||
private slots:
|
||||
// -- Hex literals --
|
||||
|
||||
void bareHex() { auto r = AddressParser::evaluate("AB"); QVERIFY(r.ok); QCOMPARE(r.value, 0xABULL); }
|
||||
void prefixedHex() { auto r = AddressParser::evaluate("0x1F4"); QVERIFY(r.ok); QCOMPARE(r.value, 0x1F4ULL); }
|
||||
void zeroLiteral() { auto r = AddressParser::evaluate("0"); QVERIFY(r.ok); QCOMPARE(r.value, 0ULL); }
|
||||
void large64bit() { auto r = AddressParser::evaluate("7FF66CCE0000");QVERIFY(r.ok); QCOMPARE(r.value, 0x7FF66CCE0000ULL); }
|
||||
|
||||
// -- Arithmetic --
|
||||
|
||||
void addition() {
|
||||
auto r = AddressParser::evaluate("0x100 + 0x200");
|
||||
QVERIFY(r.ok); QCOMPARE(r.value, 0x300ULL);
|
||||
}
|
||||
void subtraction() {
|
||||
auto r = AddressParser::evaluate("0x300 - 0x100");
|
||||
QVERIFY(r.ok); QCOMPARE(r.value, 0x200ULL);
|
||||
}
|
||||
void multiplication() {
|
||||
auto r = AddressParser::evaluate("0x10 * 4");
|
||||
QVERIFY(r.ok); QCOMPARE(r.value, 0x40ULL);
|
||||
}
|
||||
void division() {
|
||||
auto r = AddressParser::evaluate("0x100 / 2");
|
||||
QVERIFY(r.ok); QCOMPARE(r.value, 0x80ULL);
|
||||
}
|
||||
void precedence() {
|
||||
// 0x10 + 2*3 = 0x10 + 6 = 0x16
|
||||
auto r = AddressParser::evaluate("0x10 + 2 * 3");
|
||||
QVERIFY(r.ok); QCOMPARE(r.value, 0x16ULL);
|
||||
}
|
||||
void parentheses() {
|
||||
// (0x10 + 2) * 3 = 0x12 * 3 = 0x36
|
||||
auto r = AddressParser::evaluate("(0x10 + 2) * 3");
|
||||
QVERIFY(r.ok); QCOMPARE(r.value, 0x36ULL);
|
||||
}
|
||||
|
||||
// -- Unary minus --
|
||||
|
||||
void unaryMinus() {
|
||||
auto r = AddressParser::evaluate("-0x10 + 0x20");
|
||||
QVERIFY(r.ok); QCOMPARE(r.value, 0x10ULL);
|
||||
}
|
||||
|
||||
// -- Module resolution --
|
||||
|
||||
void moduleResolve() {
|
||||
AddressParserCallbacks cbs;
|
||||
cbs.resolveModule = [](const QString& name, bool* ok) -> uint64_t {
|
||||
*ok = (name == "Program.exe");
|
||||
return *ok ? 0x140000000ULL : 0;
|
||||
};
|
||||
auto r = AddressParser::evaluate("<Program.exe> + 0x123", 8, &cbs);
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0x140000123ULL);
|
||||
}
|
||||
|
||||
void moduleNotFound() {
|
||||
AddressParserCallbacks cbs;
|
||||
cbs.resolveModule = [](const QString&, bool* ok) -> uint64_t {
|
||||
*ok = false;
|
||||
return 0;
|
||||
};
|
||||
auto r = AddressParser::evaluate("<NoSuch.dll>", 8, &cbs);
|
||||
QVERIFY(!r.ok);
|
||||
QVERIFY(r.error.contains("not found"));
|
||||
}
|
||||
|
||||
// -- Dereference --
|
||||
|
||||
void derefSimple() {
|
||||
AddressParserCallbacks cbs;
|
||||
cbs.readPointer = [](uint64_t addr, bool* ok) -> uint64_t {
|
||||
*ok = (addr == 0x1000);
|
||||
return *ok ? 0xDEADBEEFULL : 0;
|
||||
};
|
||||
auto r = AddressParser::evaluate("[0x1000]", 8, &cbs);
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0xDEADBEEFULL);
|
||||
}
|
||||
|
||||
void derefNested() {
|
||||
AddressParserCallbacks cbs;
|
||||
cbs.resolveModule = [](const QString& name, bool* ok) -> uint64_t {
|
||||
*ok = (name == "mod");
|
||||
return *ok ? 0x400000ULL : 0;
|
||||
};
|
||||
cbs.readPointer = [](uint64_t addr, bool* ok) -> uint64_t {
|
||||
*ok = true;
|
||||
if (addr == 0x400100) return 0x500000;
|
||||
if (addr == 0x900000) return 0xABCDEF;
|
||||
return 0;
|
||||
};
|
||||
// [<mod> + [<mod> + 0x100]] = [0x400000 + [0x400000+0x100]]
|
||||
// inner deref: [0x400100] = 0x500000
|
||||
// outer: [0x400000 + 0x500000] = [0x900000] = 0xABCDEF
|
||||
auto r = AddressParser::evaluate("[<mod> + [<mod> + 0x100]]", 8, &cbs);
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0xABCDEFULL);
|
||||
}
|
||||
|
||||
void derefReadFailure() {
|
||||
AddressParserCallbacks cbs;
|
||||
cbs.readPointer = [](uint64_t, bool* ok) -> uint64_t {
|
||||
*ok = false;
|
||||
return 0;
|
||||
};
|
||||
auto r = AddressParser::evaluate("[0x1000]", 8, &cbs);
|
||||
QVERIFY(!r.ok);
|
||||
QVERIFY(r.error.contains("failed to read"));
|
||||
}
|
||||
|
||||
// -- Complex expression from plan --
|
||||
|
||||
void complexExpr() {
|
||||
AddressParserCallbacks cbs;
|
||||
cbs.resolveModule = [](const QString& name, bool* ok) -> uint64_t {
|
||||
*ok = (name == "Program.exe");
|
||||
return *ok ? 0x140000000ULL : 0;
|
||||
};
|
||||
cbs.readPointer = [](uint64_t addr, bool* ok) -> uint64_t {
|
||||
*ok = true;
|
||||
if (addr == 0x1400000DEULL) return 0x500000;
|
||||
return 0;
|
||||
};
|
||||
// [<Program.exe> + 0xDE] - AB = [0x1400000DE] - 0xAB = 0x500000 - 0xAB = 0x4FFF55
|
||||
auto r = AddressParser::evaluate("[<Program.exe> + 0xDE] - AB", 8, &cbs);
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0x4FFF55ULL);
|
||||
}
|
||||
|
||||
// -- Errors --
|
||||
|
||||
void emptyInput() {
|
||||
auto r = AddressParser::evaluate("");
|
||||
QVERIFY(!r.ok);
|
||||
}
|
||||
void unmatchedBracket() {
|
||||
auto r = AddressParser::evaluate("[0x1000");
|
||||
QVERIFY(!r.ok);
|
||||
QVERIFY(r.error.contains("']'"));
|
||||
}
|
||||
void unmatchedAngle() {
|
||||
auto r = AddressParser::evaluate("<Program.exe");
|
||||
QVERIFY(!r.ok);
|
||||
QVERIFY(r.error.contains("'>'"));
|
||||
}
|
||||
void divisionByZero() {
|
||||
auto r = AddressParser::evaluate("0x100 / 0");
|
||||
QVERIFY(!r.ok);
|
||||
QVERIFY(r.error.contains("division by zero"));
|
||||
}
|
||||
void trailingGarbage() {
|
||||
auto r = AddressParser::evaluate("0x100 xyz");
|
||||
QVERIFY(!r.ok);
|
||||
QVERIFY(r.error.contains("unexpected"));
|
||||
}
|
||||
void trailingOperator() {
|
||||
auto r = AddressParser::evaluate("0x100 +");
|
||||
QVERIFY(!r.ok);
|
||||
}
|
||||
|
||||
// -- Validation --
|
||||
|
||||
void validateValid() {
|
||||
QCOMPARE(AddressParser::validate("0x100 + 0x200"), QString());
|
||||
QCOMPARE(AddressParser::validate("<Prog.exe> + [0x100]"), QString());
|
||||
}
|
||||
void validateInvalid() {
|
||||
QVERIFY(!AddressParser::validate("").isEmpty());
|
||||
QVERIFY(!AddressParser::validate("[0x100").isEmpty());
|
||||
QVERIFY(!AddressParser::validate("0x100 xyz").isEmpty());
|
||||
}
|
||||
|
||||
// -- Backtick stripping --
|
||||
|
||||
void backtickStripping() {
|
||||
auto r = AddressParser::evaluate("7ff6`6cce0000");
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0x7FF66CCE0000ULL);
|
||||
}
|
||||
|
||||
// -- Whitespace tolerance --
|
||||
|
||||
void whitespace() {
|
||||
auto r = AddressParser::evaluate(" 0x100 + 0x200 ");
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0x300ULL);
|
||||
}
|
||||
|
||||
// -- Legacy compat: simple hex --
|
||||
|
||||
void simpleHexAddress() {
|
||||
auto r = AddressParser::evaluate("140000000");
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0x140000000ULL);
|
||||
}
|
||||
|
||||
// -- Multiple additions --
|
||||
|
||||
void multipleAdditions() {
|
||||
auto r = AddressParser::evaluate("0x100 + 0x200 + 0x300");
|
||||
QVERIFY(r.ok);
|
||||
QCOMPARE(r.value, 0x600ULL);
|
||||
}
|
||||
};
|
||||
|
||||
QTEST_GUILESS_MAIN(TestAddressParser)
|
||||
#include "test_addressparser.moc"
|
||||
@@ -1,8 +1,8 @@
|
||||
#include <QtTest/QtTest>
|
||||
#include <QTemporaryFile>
|
||||
#include "core.h"
|
||||
#include "export_reclass_xml.h"
|
||||
#include "import_reclass_xml.h"
|
||||
#include "imports/export_reclass_xml.h"
|
||||
#include "imports/import_reclass_xml.h"
|
||||
|
||||
using namespace rcx;
|
||||
|
||||
|
||||
237
tests/test_import_pdb.cpp
Normal file
237
tests/test_import_pdb.cpp
Normal file
@@ -0,0 +1,237 @@
|
||||
#include <QtTest/QtTest>
|
||||
#include "core.h"
|
||||
#include "imports/import_pdb.h"
|
||||
|
||||
using namespace rcx;
|
||||
|
||||
class TestImportPdb : public QObject {
|
||||
Q_OBJECT
|
||||
private slots:
|
||||
void missingFileReturnsError();
|
||||
void importKProcess();
|
||||
void verifyDispatcherHeader();
|
||||
void verifyListEntry();
|
||||
void importFilteredStruct();
|
||||
void enumerateTypes();
|
||||
void importSelected();
|
||||
};
|
||||
|
||||
static const QString kPdbPath = QStringLiteral(
|
||||
"C:/Symbols/ntkrnlmp.pdb/0762CF42EF7F3E8116EF7329ADAA09A31/ntkrnlmp.pdb");
|
||||
|
||||
// Find a root struct by structTypeName
|
||||
static int findRootStruct(const NodeTree& tree, const QString& name) {
|
||||
for (int i = 0; i < tree.nodes.size(); i++) {
|
||||
if (tree.nodes[i].parentId == 0 &&
|
||||
tree.nodes[i].kind == NodeKind::Struct &&
|
||||
tree.nodes[i].structTypeName == name)
|
||||
return i;
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
// Find a child of parentId by name
|
||||
static int findChildNode(const NodeTree& tree, uint64_t parentId, const QString& name) {
|
||||
for (int i = 0; i < tree.nodes.size(); i++) {
|
||||
if (tree.nodes[i].parentId == parentId && tree.nodes[i].name == name)
|
||||
return i;
|
||||
}
|
||||
return -1;
|
||||
}
|
||||
|
||||
void TestImportPdb::missingFileReturnsError() {
|
||||
QString err;
|
||||
NodeTree tree = importPdb(QStringLiteral("C:/nonexistent.pdb"), {}, &err);
|
||||
QVERIFY(tree.nodes.isEmpty());
|
||||
QVERIFY(!err.isEmpty());
|
||||
}
|
||||
|
||||
void TestImportPdb::importKProcess() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
QString err;
|
||||
NodeTree tree = importPdb(kPdbPath, QStringLiteral("_KPROCESS"), &err);
|
||||
QVERIFY2(!tree.nodes.isEmpty(), qPrintable(err));
|
||||
|
||||
// Find _KPROCESS root struct
|
||||
int kpIdx = findRootStruct(tree, QStringLiteral("_KPROCESS"));
|
||||
QVERIFY2(kpIdx >= 0, "Expected _KPROCESS root struct");
|
||||
uint64_t kpId = tree.nodes[kpIdx].id;
|
||||
|
||||
// Verify Header field at offset 0 → embedded _DISPATCHER_HEADER
|
||||
int headerIdx = findChildNode(tree, kpId, QStringLiteral("Header"));
|
||||
QVERIFY2(headerIdx >= 0, "Expected 'Header' child of _KPROCESS");
|
||||
QCOMPARE(tree.nodes[headerIdx].kind, NodeKind::Struct);
|
||||
QCOMPARE(tree.nodes[headerIdx].structTypeName, QStringLiteral("_DISPATCHER_HEADER"));
|
||||
QCOMPARE(tree.nodes[headerIdx].offset, 0);
|
||||
|
||||
// Verify ProfileListHead at offset 0x18 → embedded _LIST_ENTRY
|
||||
int profileIdx = findChildNode(tree, kpId, QStringLiteral("ProfileListHead"));
|
||||
QVERIFY2(profileIdx >= 0, "Expected 'ProfileListHead' child of _KPROCESS");
|
||||
QCOMPARE(tree.nodes[profileIdx].kind, NodeKind::Struct);
|
||||
QCOMPARE(tree.nodes[profileIdx].structTypeName, QStringLiteral("_LIST_ENTRY"));
|
||||
QCOMPARE(tree.nodes[profileIdx].offset, 0x18);
|
||||
}
|
||||
|
||||
void TestImportPdb::verifyDispatcherHeader() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
QString err;
|
||||
NodeTree tree = importPdb(kPdbPath, QStringLiteral("_KPROCESS"), &err);
|
||||
QVERIFY2(!tree.nodes.isEmpty(), qPrintable(err));
|
||||
|
||||
// _DISPATCHER_HEADER should be imported as a transitive dependency
|
||||
int dhIdx = findRootStruct(tree, QStringLiteral("_DISPATCHER_HEADER"));
|
||||
QVERIFY2(dhIdx >= 0, "_DISPATCHER_HEADER should be imported as a dependency");
|
||||
|
||||
uint64_t dhId = tree.nodes[dhIdx].id;
|
||||
auto kids = tree.childrenOf(dhId);
|
||||
QVERIFY2(!kids.isEmpty(), "_DISPATCHER_HEADER should have children (fields)");
|
||||
|
||||
// Look for WaitListHead — a _LIST_ENTRY at offset 0x10 in most builds
|
||||
int waitIdx = findChildNode(tree, dhId, QStringLiteral("WaitListHead"));
|
||||
QVERIFY2(waitIdx >= 0, "Expected 'WaitListHead' in _DISPATCHER_HEADER");
|
||||
QCOMPARE(tree.nodes[waitIdx].kind, NodeKind::Struct);
|
||||
QCOMPARE(tree.nodes[waitIdx].structTypeName, QStringLiteral("_LIST_ENTRY"));
|
||||
}
|
||||
|
||||
void TestImportPdb::verifyListEntry() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
QString err;
|
||||
NodeTree tree = importPdb(kPdbPath, QStringLiteral("_KPROCESS"), &err);
|
||||
QVERIFY2(!tree.nodes.isEmpty(), qPrintable(err));
|
||||
|
||||
// _LIST_ENTRY should be imported (used by ProfileListHead and others)
|
||||
int leIdx = findRootStruct(tree, QStringLiteral("_LIST_ENTRY"));
|
||||
QVERIFY2(leIdx >= 0, "_LIST_ENTRY should be imported");
|
||||
|
||||
uint64_t leId = tree.nodes[leIdx].id;
|
||||
|
||||
// Flink at offset 0 — pointer to _LIST_ENTRY
|
||||
int flinkIdx = findChildNode(tree, leId, QStringLiteral("Flink"));
|
||||
QVERIFY2(flinkIdx >= 0, "Expected 'Flink' in _LIST_ENTRY");
|
||||
QCOMPARE(tree.nodes[flinkIdx].kind, NodeKind::Pointer64);
|
||||
QCOMPARE(tree.nodes[flinkIdx].offset, 0);
|
||||
|
||||
// Blink at offset 8 — pointer to _LIST_ENTRY
|
||||
int blinkIdx = findChildNode(tree, leId, QStringLiteral("Blink"));
|
||||
QVERIFY2(blinkIdx >= 0, "Expected 'Blink' in _LIST_ENTRY");
|
||||
QCOMPARE(tree.nodes[blinkIdx].kind, NodeKind::Pointer64);
|
||||
QCOMPARE(tree.nodes[blinkIdx].offset, 8);
|
||||
|
||||
// Both should point back to _LIST_ENTRY (self-referencing)
|
||||
QCOMPARE(tree.nodes[flinkIdx].refId, leId);
|
||||
QCOMPARE(tree.nodes[blinkIdx].refId, leId);
|
||||
}
|
||||
|
||||
void TestImportPdb::importFilteredStruct() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
QString err;
|
||||
NodeTree tree = importPdb(kPdbPath, QStringLiteral("_LIST_ENTRY"), &err);
|
||||
QVERIFY2(!tree.nodes.isEmpty(), qPrintable(err));
|
||||
|
||||
int leIdx = findRootStruct(tree, QStringLiteral("_LIST_ENTRY"));
|
||||
QVERIFY(leIdx >= 0);
|
||||
|
||||
// _LIST_ENTRY only references itself, so exactly 1 root struct
|
||||
int rootCount = 0;
|
||||
for (const auto& n : tree.nodes)
|
||||
if (n.parentId == 0 && n.kind == NodeKind::Struct) rootCount++;
|
||||
QCOMPARE(rootCount, 1);
|
||||
}
|
||||
|
||||
void TestImportPdb::enumerateTypes() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
QString err;
|
||||
QVector<PdbTypeInfo> types = enumeratePdbTypes(kPdbPath, &err);
|
||||
QVERIFY2(!types.isEmpty(), qPrintable(err));
|
||||
|
||||
// Should have hundreds of types in ntkrnlmp
|
||||
QVERIFY2(types.size() > 100,
|
||||
qPrintable(QStringLiteral("Expected >100 types, got %1").arg(types.size())));
|
||||
|
||||
// Verify _KPROCESS is present
|
||||
bool foundKProcess = false;
|
||||
bool foundListEntry = false;
|
||||
for (const auto& t : types) {
|
||||
if (t.name == QStringLiteral("_KPROCESS")) {
|
||||
foundKProcess = true;
|
||||
QVERIFY2(t.childCount > 0, "_KPROCESS should have children");
|
||||
QVERIFY2(t.size > 0, "_KPROCESS should have non-zero size");
|
||||
}
|
||||
if (t.name == QStringLiteral("_LIST_ENTRY")) {
|
||||
foundListEntry = true;
|
||||
}
|
||||
}
|
||||
QVERIFY2(foundKProcess, "_KPROCESS not found in enumerated types");
|
||||
QVERIFY2(foundListEntry, "_LIST_ENTRY not found in enumerated types");
|
||||
}
|
||||
|
||||
void TestImportPdb::importSelected() {
|
||||
if (!QFile::exists(kPdbPath))
|
||||
QSKIP("ntkrnlmp.pdb not found at expected path");
|
||||
|
||||
// First enumerate to find _LIST_ENTRY's type index
|
||||
QString err;
|
||||
QVector<PdbTypeInfo> types = enumeratePdbTypes(kPdbPath, &err);
|
||||
QVERIFY2(!types.isEmpty(), qPrintable(err));
|
||||
|
||||
uint32_t listEntryIdx = 0;
|
||||
bool found = false;
|
||||
for (const auto& t : types) {
|
||||
if (t.name == QStringLiteral("_LIST_ENTRY")) {
|
||||
listEntryIdx = t.typeIndex;
|
||||
found = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
QVERIFY2(found, "_LIST_ENTRY not found in enumeration");
|
||||
|
||||
// Import just _LIST_ENTRY
|
||||
QVector<uint32_t> indices = { listEntryIdx };
|
||||
int progressCalls = 0;
|
||||
NodeTree tree = importPdbSelected(kPdbPath, indices, &err,
|
||||
[&](int cur, int total) -> bool {
|
||||
progressCalls++;
|
||||
Q_UNUSED(total);
|
||||
Q_ASSERT(cur <= total);
|
||||
return true; // don't cancel
|
||||
});
|
||||
QVERIFY2(!tree.nodes.isEmpty(), qPrintable(err));
|
||||
QVERIFY(progressCalls > 0);
|
||||
|
||||
// Verify _LIST_ENTRY root struct
|
||||
int leIdx = findRootStruct(tree, QStringLiteral("_LIST_ENTRY"));
|
||||
QVERIFY2(leIdx >= 0, "_LIST_ENTRY should be imported");
|
||||
|
||||
// Flink and Blink
|
||||
uint64_t leId = tree.nodes[leIdx].id;
|
||||
int flinkIdx = findChildNode(tree, leId, QStringLiteral("Flink"));
|
||||
QVERIFY2(flinkIdx >= 0, "Expected 'Flink' in _LIST_ENTRY");
|
||||
QCOMPARE(tree.nodes[flinkIdx].kind, NodeKind::Pointer64);
|
||||
|
||||
int blinkIdx = findChildNode(tree, leId, QStringLiteral("Blink"));
|
||||
QVERIFY2(blinkIdx >= 0, "Expected 'Blink' in _LIST_ENTRY");
|
||||
QCOMPARE(tree.nodes[blinkIdx].kind, NodeKind::Pointer64);
|
||||
|
||||
// Self-referencing pointers
|
||||
QCOMPARE(tree.nodes[flinkIdx].refId, leId);
|
||||
QCOMPARE(tree.nodes[blinkIdx].refId, leId);
|
||||
|
||||
// Only 1 root struct
|
||||
int rootCount = 0;
|
||||
for (const auto& n : tree.nodes)
|
||||
if (n.parentId == 0 && n.kind == NodeKind::Struct) rootCount++;
|
||||
QCOMPARE(rootCount, 1);
|
||||
}
|
||||
|
||||
QTEST_MAIN(TestImportPdb)
|
||||
#include "test_import_pdb.moc"
|
||||
@@ -1,6 +1,6 @@
|
||||
#include <QtTest/QtTest>
|
||||
#include "core.h"
|
||||
#include "import_source.h"
|
||||
#include "imports/import_source.h"
|
||||
|
||||
using namespace rcx;
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
#include <QtTest/QtTest>
|
||||
#include "core.h"
|
||||
#include "import_reclass_xml.h"
|
||||
#include "imports/import_reclass_xml.h"
|
||||
|
||||
using namespace rcx;
|
||||
|
||||
|
||||
@@ -483,7 +483,7 @@ private slots:
|
||||
QVERIFY(!fmt::validateBaseAddress("").isEmpty()); // empty
|
||||
QVERIFY(!fmt::validateBaseAddress(" ").isEmpty()); // whitespace only - no hex digits
|
||||
QVERIFY(!fmt::validateBaseAddress("0xGGGG").isEmpty());
|
||||
QVERIFY(!fmt::validateBaseAddress("0x1000 * 2").isEmpty()); // multiplication not supported
|
||||
QVERIFY(fmt::validateBaseAddress("0x1000 * 2").isEmpty()); // multiplication supported
|
||||
QVERIFY(!fmt::validateBaseAddress("0x1000 ++ 0x100").isEmpty()); // double operator
|
||||
QVERIFY(!fmt::validateBaseAddress("hello").isEmpty());
|
||||
}
|
||||
@@ -1028,7 +1028,7 @@ private slots:
|
||||
|
||||
// Test the validation function directly
|
||||
QVERIFY(!fmt::validateBaseAddress("0x1000 ** 2").isEmpty());
|
||||
QVERIFY(!fmt::validateBaseAddress("0x1000 / 2").isEmpty());
|
||||
QVERIFY(fmt::validateBaseAddress("0x1000 / 2").isEmpty()); // division supported
|
||||
QVERIFY(!fmt::validateBaseAddress("abc xyz").isEmpty());
|
||||
|
||||
// Original base should be unchanged
|
||||
|
||||
@@ -256,8 +256,9 @@ private slots:
|
||||
{
|
||||
WinDbgMemoryProvider prov(m_connString);
|
||||
QVERIFY(prov.isValid());
|
||||
QVERIFY2(prov.base() != 0, "Should have a non-zero base from first module");
|
||||
qDebug() << "Base address:" << QString("0x%1").arg(prov.base(), 0, 16);
|
||||
// WinDbg provider no longer auto-selects a module base — it returns 0
|
||||
// so the controller doesn't override the user's chosen base address.
|
||||
QCOMPARE(prov.base(), (uint64_t)0);
|
||||
}
|
||||
|
||||
// ── Read: MZ header on main thread ──
|
||||
@@ -446,6 +447,139 @@ private slots:
|
||||
QCOMPARE(raw->Name(), std::string("WinDbg Memory"));
|
||||
delete raw;
|
||||
}
|
||||
|
||||
// ── Kernel session tests ──
|
||||
// Requires a WinDbg instance with a kernel dump loaded and
|
||||
// .server tcp:port=5055 running. Skipped automatically if
|
||||
// no server is available. Override with WINDBG_KERNEL_CONN env var.
|
||||
|
||||
void provider_kernel_connect()
|
||||
{
|
||||
QString kernelConn = qEnvironmentVariable("WINDBG_KERNEL_CONN",
|
||||
"tcp:Port=5055,Server=localhost");
|
||||
if (!canConnect(kernelConn))
|
||||
QSKIP("No kernel debug server available (set WINDBG_KERNEL_CONN)");
|
||||
|
||||
WinDbgMemoryProvider prov(kernelConn);
|
||||
QVERIFY2(prov.isValid(), "Should connect to kernel debug server");
|
||||
QCOMPARE(prov.kind(), QStringLiteral("WinDbg"));
|
||||
|
||||
qDebug() << "Kernel provider name:" << prov.name();
|
||||
qDebug() << "Kernel provider base:" << QString("0x%1").arg(prov.base(), 0, 16);
|
||||
qDebug() << "Kernel provider isLive:" << prov.isLive();
|
||||
|
||||
// Name should not be an arbitrary user-mode DLL
|
||||
QVERIFY2(!prov.name().contains("WS2_32", Qt::CaseInsensitive),
|
||||
qPrintable("Name should not be 'WS2_32', got: " + prov.name()));
|
||||
}
|
||||
|
||||
void provider_kernel_read_base()
|
||||
{
|
||||
QString kernelConn = qEnvironmentVariable("WINDBG_KERNEL_CONN",
|
||||
"tcp:Port=5055,Server=localhost");
|
||||
if (!canConnect(kernelConn))
|
||||
QSKIP("No kernel debug server available");
|
||||
|
||||
WinDbgMemoryProvider prov(kernelConn);
|
||||
QVERIFY(prov.isValid());
|
||||
|
||||
// Provider no longer auto-selects a base. Use a known kernel address
|
||||
// from env, or skip.
|
||||
QString addrStr = qEnvironmentVariable("WINDBG_KERNEL_ADDR", "");
|
||||
if (addrStr.isEmpty())
|
||||
QSKIP("Set WINDBG_KERNEL_ADDR to a readable kernel address");
|
||||
|
||||
bool ok = false;
|
||||
uint64_t addr = addrStr.toULongLong(&ok, 16);
|
||||
QVERIFY2(ok && addr != 0, "WINDBG_KERNEL_ADDR must be a valid hex address");
|
||||
|
||||
uint8_t buf[16] = {};
|
||||
ok = prov.read(addr, buf, 16);
|
||||
QVERIFY2(ok, "Should read from kernel address");
|
||||
|
||||
bool allZero = true;
|
||||
for (int i = 0; i < 16; ++i) {
|
||||
if (buf[i] != 0) { allZero = false; break; }
|
||||
}
|
||||
QVERIFY2(!allZero, "Kernel read returned all zeros");
|
||||
}
|
||||
|
||||
void provider_kernel_read_high_address()
|
||||
{
|
||||
QString kernelConn = qEnvironmentVariable("WINDBG_KERNEL_CONN",
|
||||
"tcp:Port=5055,Server=localhost");
|
||||
if (!canConnect(kernelConn))
|
||||
QSKIP("No kernel debug server available");
|
||||
|
||||
WinDbgMemoryProvider prov(kernelConn);
|
||||
QVERIFY(prov.isValid());
|
||||
|
||||
// Use env var for a specific kernel address (e.g. _EPROCESS),
|
||||
// otherwise fall back to the provider's base.
|
||||
QString addrStr = qEnvironmentVariable("WINDBG_KERNEL_ADDR", "");
|
||||
uint64_t addr = 0;
|
||||
if (!addrStr.isEmpty()) {
|
||||
bool ok = false;
|
||||
addr = addrStr.toULongLong(&ok, 16);
|
||||
if (!ok) addr = 0;
|
||||
}
|
||||
if (addr == 0) addr = prov.base();
|
||||
|
||||
uint8_t buf[64] = {};
|
||||
bool ok = prov.read(addr, buf, 64);
|
||||
QVERIFY2(ok, qPrintable(QString("Should read kernel addr 0x%1")
|
||||
.arg(addr, 0, 16)));
|
||||
|
||||
bool allZero = true;
|
||||
for (int i = 0; i < 64; ++i) {
|
||||
if (buf[i] != 0) { allZero = false; break; }
|
||||
}
|
||||
QVERIFY2(!allZero, "Kernel high-address read returned all zeros");
|
||||
|
||||
qDebug() << "Read 64 bytes at" << QString("0x%1").arg(addr, 0, 16)
|
||||
<< "first 8:" << QString("%1 %2 %3 %4 %5 %6 %7 %8")
|
||||
.arg(buf[0], 2, 16, QChar('0'))
|
||||
.arg(buf[1], 2, 16, QChar('0'))
|
||||
.arg(buf[2], 2, 16, QChar('0'))
|
||||
.arg(buf[3], 2, 16, QChar('0'))
|
||||
.arg(buf[4], 2, 16, QChar('0'))
|
||||
.arg(buf[5], 2, 16, QChar('0'))
|
||||
.arg(buf[6], 2, 16, QChar('0'))
|
||||
.arg(buf[7], 2, 16, QChar('0'));
|
||||
}
|
||||
|
||||
void provider_kernel_read_backgroundThread()
|
||||
{
|
||||
QString kernelConn = qEnvironmentVariable("WINDBG_KERNEL_CONN",
|
||||
"tcp:Port=5055,Server=localhost");
|
||||
if (!canConnect(kernelConn))
|
||||
QSKIP("No kernel debug server available");
|
||||
|
||||
QString addrStr = qEnvironmentVariable("WINDBG_KERNEL_ADDR", "");
|
||||
if (addrStr.isEmpty())
|
||||
QSKIP("Set WINDBG_KERNEL_ADDR to a readable kernel address");
|
||||
|
||||
bool ok = false;
|
||||
uint64_t addr = addrStr.toULongLong(&ok, 16);
|
||||
QVERIFY2(ok && addr != 0, "WINDBG_KERNEL_ADDR must be a valid hex address");
|
||||
|
||||
WinDbgMemoryProvider prov(kernelConn);
|
||||
QVERIFY(prov.isValid());
|
||||
|
||||
// Simulate the controller's async refresh pattern
|
||||
QFuture<QByteArray> future = QtConcurrent::run([&prov, addr]() -> QByteArray {
|
||||
return prov.readBytes(addr, 4096);
|
||||
});
|
||||
future.waitForFinished();
|
||||
QByteArray data = future.result();
|
||||
|
||||
QCOMPARE(data.size(), 4096);
|
||||
bool allZero = true;
|
||||
for (int i = 0; i < data.size(); ++i) {
|
||||
if (data[i] != '\0') { allZero = false; break; }
|
||||
}
|
||||
QVERIFY2(!allZero, "Kernel background read returned all zeros");
|
||||
}
|
||||
};
|
||||
|
||||
QTEST_MAIN(TestWinDbgProvider)
|
||||
|
||||
431
third_party/raw_pdb/.gitignore
vendored
Normal file
431
third_party/raw_pdb/.gitignore
vendored
Normal file
@@ -0,0 +1,431 @@
|
||||
# CLion
|
||||
.idea/
|
||||
|
||||
## Ignore Visual Studio temporary files, build results, and
|
||||
## files generated by popular Visual Studio add-ons.
|
||||
##
|
||||
## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
|
||||
|
||||
# User-specific files
|
||||
*.rsuser
|
||||
*.suo
|
||||
*.user
|
||||
*.userosscache
|
||||
*.sln.docstates
|
||||
*.env
|
||||
|
||||
# User-specific files (MonoDevelop/Xamarin Studio)
|
||||
*.userprefs
|
||||
|
||||
# Mono auto generated files
|
||||
mono_crash.*
|
||||
|
||||
# Build results
|
||||
[Dd]ebug/
|
||||
[Dd]ebugPublic/
|
||||
[Rr]elease/
|
||||
[Rr]eleases/
|
||||
|
||||
[Dd]ebug/x64/
|
||||
[Dd]ebugPublic/x64/
|
||||
[Rr]elease/x64/
|
||||
[Rr]eleases/x64/
|
||||
bin/x64/
|
||||
obj/x64/
|
||||
|
||||
[Dd]ebug/x86/
|
||||
[Dd]ebugPublic/x86/
|
||||
[Rr]elease/x86/
|
||||
[Rr]eleases/x86/
|
||||
bin/x86/
|
||||
obj/x86/
|
||||
|
||||
[Ww][Ii][Nn]32/
|
||||
[Aa][Rr][Mm]/
|
||||
[Aa][Rr][Mm]64/
|
||||
[Aa][Rr][Mm]64[Ee][Cc]/
|
||||
bld/
|
||||
[Oo]bj/
|
||||
[Oo]ut/
|
||||
[Ll]og/
|
||||
[Ll]ogs/
|
||||
|
||||
# Build results on 'Bin' directories
|
||||
**/[Bb]in/*
|
||||
# Uncomment if you have tasks that rely on *.refresh files to move binaries
|
||||
# (https://github.com/github/gitignore/pull/3736)
|
||||
#!**/[Bb]in/*.refresh
|
||||
|
||||
# Visual Studio 2015/2017 cache/options directory
|
||||
.vs/
|
||||
# Uncomment if you have tasks that create the project's static files in wwwroot
|
||||
#wwwroot/
|
||||
|
||||
# Visual Studio 2017 auto generated files
|
||||
Generated\ Files/
|
||||
|
||||
# MSTest test Results
|
||||
[Tt]est[Rr]esult*/
|
||||
[Bb]uild[Ll]og.*
|
||||
*.trx
|
||||
|
||||
# NUnit
|
||||
*.VisualState.xml
|
||||
TestResult.xml
|
||||
nunit-*.xml
|
||||
|
||||
# Approval Tests result files
|
||||
*.received.*
|
||||
|
||||
# Build Results of an ATL Project
|
||||
[Dd]ebugPS/
|
||||
[Rr]eleasePS/
|
||||
dlldata.c
|
||||
|
||||
# Benchmark Results
|
||||
BenchmarkDotNet.Artifacts/
|
||||
|
||||
# .NET Core
|
||||
project.lock.json
|
||||
project.fragment.lock.json
|
||||
artifacts/
|
||||
|
||||
# ASP.NET Scaffolding
|
||||
ScaffoldingReadMe.txt
|
||||
|
||||
# StyleCop
|
||||
StyleCopReport.xml
|
||||
|
||||
# Files built by Visual Studio
|
||||
*_i.c
|
||||
*_p.c
|
||||
*_h.h
|
||||
*.ilk
|
||||
*.meta
|
||||
*.obj
|
||||
*.idb
|
||||
*.iobj
|
||||
*.pch
|
||||
*.pdb
|
||||
*.ipdb
|
||||
*.pgc
|
||||
*.pgd
|
||||
*.rsp
|
||||
# but not Directory.Build.rsp, as it configures directory-level build defaults
|
||||
!Directory.Build.rsp
|
||||
*.sbr
|
||||
*.tlb
|
||||
*.tli
|
||||
*.tlh
|
||||
*.tmp
|
||||
*.tmp_proj
|
||||
*_wpftmp.csproj
|
||||
*.log
|
||||
*.tlog
|
||||
*.vspscc
|
||||
*.vssscc
|
||||
.builds
|
||||
*.pidb
|
||||
*.svclog
|
||||
*.scc
|
||||
|
||||
# Chutzpah Test files
|
||||
_Chutzpah*
|
||||
|
||||
# Visual C++ cache files
|
||||
ipch/
|
||||
*.aps
|
||||
*.ncb
|
||||
*.opendb
|
||||
*.opensdf
|
||||
*.sdf
|
||||
*.cachefile
|
||||
*.VC.db
|
||||
*.VC.VC.opendb
|
||||
|
||||
# Visual Studio profiler
|
||||
*.psess
|
||||
*.vsp
|
||||
*.vspx
|
||||
*.sap
|
||||
|
||||
# Visual Studio Trace Files
|
||||
*.e2e
|
||||
|
||||
# TFS 2012 Local Workspace
|
||||
$tf/
|
||||
|
||||
# Guidance Automation Toolkit
|
||||
*.gpState
|
||||
|
||||
# ReSharper is a .NET coding add-in
|
||||
_ReSharper*/
|
||||
*.[Rr]e[Ss]harper
|
||||
*.DotSettings.user
|
||||
|
||||
# TeamCity is a build add-in
|
||||
_TeamCity*
|
||||
|
||||
# DotCover is a Code Coverage Tool
|
||||
*.dotCover
|
||||
|
||||
# AxoCover is a Code Coverage Tool
|
||||
.axoCover/*
|
||||
!.axoCover/settings.json
|
||||
|
||||
# Coverlet is a free, cross platform Code Coverage Tool
|
||||
coverage*.json
|
||||
coverage*.xml
|
||||
coverage*.info
|
||||
|
||||
# Visual Studio code coverage results
|
||||
*.coverage
|
||||
*.coveragexml
|
||||
|
||||
# NCrunch
|
||||
_NCrunch_*
|
||||
.NCrunch_*
|
||||
.*crunch*.local.xml
|
||||
nCrunchTemp_*
|
||||
|
||||
# MightyMoose
|
||||
*.mm.*
|
||||
AutoTest.Net/
|
||||
|
||||
# Web workbench (sass)
|
||||
.sass-cache/
|
||||
|
||||
# Installshield output folder
|
||||
[Ee]xpress/
|
||||
|
||||
# DocProject is a documentation generator add-in
|
||||
DocProject/buildhelp/
|
||||
DocProject/Help/*.HxT
|
||||
DocProject/Help/*.HxC
|
||||
DocProject/Help/*.hhc
|
||||
DocProject/Help/*.hhk
|
||||
DocProject/Help/*.hhp
|
||||
DocProject/Help/Html2
|
||||
DocProject/Help/html
|
||||
|
||||
# Click-Once directory
|
||||
publish/
|
||||
|
||||
# Publish Web Output
|
||||
*.[Pp]ublish.xml
|
||||
*.azurePubxml
|
||||
# Note: Comment the next line if you want to checkin your web deploy settings,
|
||||
# but database connection strings (with potential passwords) will be unencrypted
|
||||
*.pubxml
|
||||
*.publishproj
|
||||
|
||||
# Microsoft Azure Web App publish settings. Comment the next line if you want to
|
||||
# checkin your Azure Web App publish settings, but sensitive information contained
|
||||
# in these scripts will be unencrypted
|
||||
PublishScripts/
|
||||
|
||||
# NuGet Packages
|
||||
*.nupkg
|
||||
# NuGet Symbol Packages
|
||||
*.snupkg
|
||||
# The packages folder can be ignored because of Package Restore
|
||||
**/[Pp]ackages/*
|
||||
# except build/, which is used as an MSBuild target.
|
||||
!**/[Pp]ackages/build/
|
||||
# Uncomment if necessary however generally it will be regenerated when needed
|
||||
#!**/[Pp]ackages/repositories.config
|
||||
# NuGet v3's project.json files produces more ignorable files
|
||||
*.nuget.props
|
||||
*.nuget.targets
|
||||
|
||||
# Microsoft Azure Build Output
|
||||
csx/
|
||||
*.build.csdef
|
||||
|
||||
# Microsoft Azure Emulator
|
||||
ecf/
|
||||
rcf/
|
||||
|
||||
# Windows Store app package directories and files
|
||||
AppPackages/
|
||||
BundleArtifacts/
|
||||
Package.StoreAssociation.xml
|
||||
_pkginfo.txt
|
||||
*.appx
|
||||
*.appxbundle
|
||||
*.appxupload
|
||||
|
||||
# Visual Studio cache files
|
||||
# files ending in .cache can be ignored
|
||||
*.[Cc]ache
|
||||
# but keep track of directories ending in .cache
|
||||
!?*.[Cc]ache/
|
||||
|
||||
# Others
|
||||
ClientBin/
|
||||
~$*
|
||||
*~
|
||||
*.dbmdl
|
||||
*.dbproj.schemaview
|
||||
*.jfm
|
||||
*.pfx
|
||||
*.publishsettings
|
||||
orleans.codegen.cs
|
||||
|
||||
# Including strong name files can present a security risk
|
||||
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
|
||||
#*.snk
|
||||
|
||||
# Since there are multiple workflows, uncomment next line to ignore bower_components
|
||||
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
|
||||
#bower_components/
|
||||
|
||||
# RIA/Silverlight projects
|
||||
Generated_Code/
|
||||
|
||||
# Backup & report files from converting an old project file
|
||||
# to a newer Visual Studio version. Backup files are not needed,
|
||||
# because we have git ;-)
|
||||
_UpgradeReport_Files/
|
||||
Backup*/
|
||||
UpgradeLog*.XML
|
||||
UpgradeLog*.htm
|
||||
ServiceFabricBackup/
|
||||
*.rptproj.bak
|
||||
|
||||
# SQL Server files
|
||||
*.mdf
|
||||
*.ldf
|
||||
*.ndf
|
||||
|
||||
# Business Intelligence projects
|
||||
*.rdl.data
|
||||
*.bim.layout
|
||||
*.bim_*.settings
|
||||
*.rptproj.rsuser
|
||||
*- [Bb]ackup.rdl
|
||||
*- [Bb]ackup ([0-9]).rdl
|
||||
*- [Bb]ackup ([0-9][0-9]).rdl
|
||||
|
||||
# Microsoft Fakes
|
||||
FakesAssemblies/
|
||||
|
||||
# GhostDoc plugin setting file
|
||||
*.GhostDoc.xml
|
||||
|
||||
# Node.js Tools for Visual Studio
|
||||
.ntvs_analysis.dat
|
||||
node_modules/
|
||||
|
||||
# Visual Studio 6 build log
|
||||
*.plg
|
||||
|
||||
# Visual Studio 6 workspace options file
|
||||
*.opt
|
||||
|
||||
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
|
||||
*.vbw
|
||||
|
||||
# Visual Studio 6 workspace and project file (working project files containing files to include in project)
|
||||
*.dsw
|
||||
*.dsp
|
||||
|
||||
# Visual Studio 6 technical files
|
||||
*.ncb
|
||||
*.aps
|
||||
|
||||
# Visual Studio LightSwitch build output
|
||||
**/*.HTMLClient/GeneratedArtifacts
|
||||
**/*.DesktopClient/GeneratedArtifacts
|
||||
**/*.DesktopClient/ModelManifest.xml
|
||||
**/*.Server/GeneratedArtifacts
|
||||
**/*.Server/ModelManifest.xml
|
||||
_Pvt_Extensions
|
||||
|
||||
# Paket dependency manager
|
||||
**/.paket/paket.exe
|
||||
paket-files/
|
||||
|
||||
# FAKE - F# Make
|
||||
**/.fake/
|
||||
|
||||
# CodeRush personal settings
|
||||
**/.cr/personal
|
||||
|
||||
# Python Tools for Visual Studio (PTVS)
|
||||
**/__pycache__/
|
||||
*.pyc
|
||||
|
||||
# Cake - Uncomment if you are using it
|
||||
#tools/**
|
||||
#!tools/packages.config
|
||||
|
||||
# Tabs Studio
|
||||
*.tss
|
||||
|
||||
# Telerik's JustMock configuration file
|
||||
*.jmconfig
|
||||
|
||||
# BizTalk build output
|
||||
*.btp.cs
|
||||
*.btm.cs
|
||||
*.odx.cs
|
||||
*.xsd.cs
|
||||
|
||||
# OpenCover UI analysis results
|
||||
OpenCover/
|
||||
|
||||
# Azure Stream Analytics local run output
|
||||
ASALocalRun/
|
||||
|
||||
# MSBuild Binary and Structured Log
|
||||
*.binlog
|
||||
MSBuild_Logs/
|
||||
|
||||
# AWS SAM Build and Temporary Artifacts folder
|
||||
.aws-sam
|
||||
|
||||
# NVidia Nsight GPU debugger configuration file
|
||||
*.nvuser
|
||||
|
||||
# MFractors (Xamarin productivity tool) working folder
|
||||
**/.mfractor/
|
||||
|
||||
# Local History for Visual Studio
|
||||
**/.localhistory/
|
||||
|
||||
# Visual Studio History (VSHistory) files
|
||||
.vshistory/
|
||||
|
||||
# BeatPulse healthcheck temp database
|
||||
healthchecksdb
|
||||
|
||||
# Backup folder for Package Reference Convert tool in Visual Studio 2017
|
||||
MigrationBackup/
|
||||
|
||||
# Ionide (cross platform F# VS Code tools) working folder
|
||||
**/.ionide/
|
||||
|
||||
# Fody - auto-generated XML schema
|
||||
FodyWeavers.xsd
|
||||
|
||||
# VS Code files for those working on multiple tools
|
||||
.vscode/*
|
||||
!.vscode/settings.json
|
||||
!.vscode/tasks.json
|
||||
!.vscode/launch.json
|
||||
!.vscode/extensions.json
|
||||
!.vscode/*.code-snippets
|
||||
|
||||
# Local History for Visual Studio Code
|
||||
.history/
|
||||
|
||||
# Built Visual Studio Code Extensions
|
||||
*.vsix
|
||||
|
||||
# Windows Installer files from build outputs
|
||||
*.cab
|
||||
*.msi
|
||||
*.msix
|
||||
*.msm
|
||||
*.msp
|
||||
9
third_party/raw_pdb/CMakeLists.txt
vendored
Normal file
9
third_party/raw_pdb/CMakeLists.txt
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
cmake_minimum_required(VERSION 3.16)
|
||||
|
||||
project(raw_pdb)
|
||||
|
||||
set(CMAKE_CXX_STANDARD 11)
|
||||
|
||||
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
|
||||
|
||||
add_subdirectory(src)
|
||||
25
third_party/raw_pdb/LICENSE
vendored
Normal file
25
third_party/raw_pdb/LICENSE
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
BSD 2-Clause License
|
||||
|
||||
Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this
|
||||
list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
190
third_party/raw_pdb/README.md
vendored
Normal file
190
third_party/raw_pdb/README.md
vendored
Normal file
@@ -0,0 +1,190 @@
|
||||
# RawPDB
|
||||
|
||||
**RawPDB** is a C++11 library that directly reads Microsoft Program DataBase PDB files. The code is extracted almost directly from <a href="https://liveplusplus.tech/">Live++ 2</a>, a battle-tested hot-reload tool for C++.
|
||||
|
||||
## Design
|
||||
|
||||
**RawPDB** gives you direct access to the stream data contained in a PDB file. It does not attempt to offer abstractions for iterating symbols, translation units, contributions, etc.
|
||||
|
||||
Building a high-level abstraction over the provided low-level data is an ill-fated attempt that can never really be performant for everybody, because different tools like debuggers, hot-reload tools (e.g. <a href="https://liveplusplus.tech/">Live++</a>), profilers (e.g. <a href="https://superluminal.eu/">Superluminal</a>), need to perform different queries against the stored data.
|
||||
|
||||
We therefore believe the best solution is to offer direct access to the underlying data, with applications bringing that data into their own structures.
|
||||
|
||||
## Goal
|
||||
|
||||
Eventually, we want **RawPDB** to become the de-facto replacement of <a href="https://docs.microsoft.com/en-us/visualstudio/debugger/debug-interface-access/debug-interface-access-sdk">Microsoft's DIA SDK</a> that most C++ developers (have to) use.
|
||||
|
||||
## Features
|
||||
|
||||
* Fast - **RawPDB** works directly with memory-mapped data, so only the data from the streams you touch affect performance. It is orders of magnitudes faster than the DIA SDK, and faster than comparable LLVM code
|
||||
* Scalable - **RawPDB's** API gives you access to individual streams that can all be read concurrently in a trivial fashion, since all returned data structures are immutable. There are no locks or waits anywhere inside the library
|
||||
* Lightweight - **RawPDB** is small and compiles in roughly 1 second
|
||||
* Allocation-friendly - **RawPDB** performs only a few allocations, and those can be overridden easily by changing the underlying macro
|
||||
* No STL - **RawPDB** does not need any STL containers or algorithms
|
||||
* No exceptions - **RawPDB** does not use exceptions
|
||||
* No RTTI - **RawPDB** does not need RTTI or use class hierarchies
|
||||
* High-quality code - **RawPDB** compiles clean under -Wall
|
||||
|
||||
## Building
|
||||
|
||||
The code compiles clean under Visual Studio 2015, 2017, 2019, or 2022. A solution for Visual Studio 2019 is included.
|
||||
|
||||
## Performance
|
||||
|
||||
Running the **Symbols** and **Contributions** examples on a 1GiB PDB yields the following output:
|
||||
|
||||
<pre>
|
||||
Opening PDB file C:\Development\llvm-project\build\tools\clang\unittests\Tooling\RelWithDebInfo\ToolingTests.pdb
|
||||
|
||||
Running example "Symbols"
|
||||
| Reading image section stream
|
||||
| ---> done in 0.066ms
|
||||
| Reading module info stream
|
||||
| ---> done in 0.562ms
|
||||
| Reading symbol record stream
|
||||
| ---> done in 25.185ms
|
||||
| Reading public symbol stream
|
||||
| ---> done in 1.133ms
|
||||
| Storing public symbols
|
||||
| ---> done in 46.171ms (212023 elements)
|
||||
| Reading global symbol stream
|
||||
| ---> done in 1.381ms
|
||||
| Storing global symbols
|
||||
| ---> done in 12.769ms (448957 elements)
|
||||
| Storing symbols from modules
|
||||
| ---> done in 145.849ms (2243 elements)
|
||||
---> done in 233.694ms (539611 elements)
|
||||
</pre>
|
||||
|
||||
<pre>
|
||||
Opening PDB file C:\Development\llvm-project\build\tools\clang\unittests\Tooling\RelWithDebInfo\ToolingTests.pdb
|
||||
|
||||
Running example "Contributions"
|
||||
| Reading image section stream
|
||||
| ---> done in 0.066ms
|
||||
| Reading module info stream
|
||||
| ---> done in 0.594ms
|
||||
| Reading section contribution stream
|
||||
| ---> done in 9.839ms
|
||||
| Storing contributions
|
||||
| ---> done in 67.346ms (630924 elements)
|
||||
| std::sort contributions
|
||||
| ---> done in 19.218ms
|
||||
---> done in 97.283ms
|
||||
20 largest contributions:
|
||||
1: 1896496 bytes from LLVMAMDGPUCodeGen.dir\RelWithDebInfo\AMDGPUInstructionSelector.obj
|
||||
2: 1700720 bytes from LLVMHexagonCodeGen.dir\RelWithDebInfo\HexagonInstrInfo.obj
|
||||
3: 1536470 bytes from LLVMRISCVCodeGen.dir\RelWithDebInfo\RISCVISelDAGToDAG.obj
|
||||
4: 1441408 bytes from LLVMAArch64CodeGen.dir\RelWithDebInfo\AArch64InstructionSelector.obj
|
||||
5: 1187048 bytes from LLVMRISCVCodeGen.dir\RelWithDebInfo\RISCVInstructionSelector.obj
|
||||
6: 1026504 bytes from LLVMARMCodeGen.dir\RelWithDebInfo\ARMInstructionSelector.obj
|
||||
7: 952080 bytes from LLVMAMDGPUDesc.dir\RelWithDebInfo\AMDGPUMCTargetDesc.obj
|
||||
8: 849888 bytes from LLVMX86Desc.dir\RelWithDebInfo\X86MCTargetDesc.obj
|
||||
9: 712176 bytes from LLVMHexagonCodeGen.dir\RelWithDebInfo\HexagonInstrInfo.obj
|
||||
10: 679035 bytes from LLVMX86CodeGen.dir\RelWithDebInfo\X86ISelDAGToDAG.obj
|
||||
11: 525174 bytes from LLVMAMDGPUDesc.dir\RelWithDebInfo\AMDGPUMCTargetDesc.obj
|
||||
12: 523035 bytes from * Linker *
|
||||
13: 519312 bytes from LLVMRISCVDesc.dir\RelWithDebInfo\RISCVMCTargetDesc.obj
|
||||
14: 512496 bytes from LLVMVEDesc.dir\RelWithDebInfo\VEMCTargetDesc.obj
|
||||
15: 498768 bytes from LLVMX86CodeGen.dir\RelWithDebInfo\X86InstructionSelector.obj
|
||||
16: 483528 bytes from LLVMMipsCodeGen.dir\RelWithDebInfo\MipsInstructionSelector.obj
|
||||
17: 449472 bytes from LLVMAMDGPUCodeGen.dir\RelWithDebInfo\AMDGPUISelDAGToDAG.obj
|
||||
18: 444246 bytes from C:\Development\llvm-project\build\tools\clang\lib\Basic\obj.clangBasic.dir\RelWithDebInfo\DiagnosticIDs.obj
|
||||
19: 371584 bytes from LLVMAArch64CodeGen.dir\RelWithDebInfo\AArch64ISelDAGToDAG.obj
|
||||
20: 370272 bytes from LLVMNVPTXDesc.dir\RelWithDebInfo\NVPTXMCTargetDesc.obj
|
||||
</pre>
|
||||
|
||||
This is at least an order of magnitude faster than DIA, even though the example code is completely serial and uses std::vector, std::string, and std::sort, which are used for illustration purposes only.
|
||||
|
||||
When reading streams in a concurrent fashion, you will most likely be limited by the speed at which the OS can bring the data into your process.
|
||||
|
||||
Running the **Lines** example on a 1.37 GiB PDB yields the following output:
|
||||
|
||||
<pre>
|
||||
|
||||
Opening PDB file C:\pdb-test-files\clang-debug.pdb
|
||||
Version 20000404, signature 1658696914, age 1, GUID 563dd8f1-f32b-459b-8c2beae0e70bc19b
|
||||
|
||||
Running example "Lines"
|
||||
| Reading image section stream
|
||||
| ---> done in 0.313ms
|
||||
| Reading module info stream
|
||||
| ---> done in 0.403ms
|
||||
| Reading names stream
|
||||
| ---> done in 0.126ms
|
||||
| Storing lines from modules
|
||||
| ---> done in 306.720ms (1847 elements)
|
||||
| std::sort sections
|
||||
| ---> done in 103.090ms (4023680 elements)
|
||||
|
||||
</pre>
|
||||
|
||||
## Supported streams
|
||||
|
||||
**RawPDB** gives you access to the following PDB stream data:
|
||||
|
||||
* DBI stream data
|
||||
* Public symbols
|
||||
* Global symbols
|
||||
* Modules
|
||||
* Module symbols
|
||||
* Module lines (C13 line information)
|
||||
* Image sections
|
||||
* Info stream
|
||||
* "/names" stream
|
||||
* Section contributions
|
||||
* Source files
|
||||
|
||||
* IPI stream data
|
||||
|
||||
* TPI stream data
|
||||
|
||||
Furthermore, PDBs linked using /DEBUG:FASTLINK are not supported. These PDBs do not contain much information, since private symbol information is distributed among object files and library files.
|
||||
|
||||
## Documentation
|
||||
|
||||
If you are unfamiliar with the basic structure of a PDB file, the <a href="https://llvm.org/docs/PDB/index.html">LLVM documentation</a> serves as a good introduction.
|
||||
|
||||
Consult the example code to see how to read and parse the PDB streams.
|
||||
|
||||
## Directory structure
|
||||
|
||||
* bin: contains final binary output files (.exe and .pdb)
|
||||
* build: contains Visual Studio 2019 solution and project files
|
||||
* lib: contains the RawPDB library output files (.lib and .pdb)
|
||||
* src: contains the RawPDB source code, as well as example code
|
||||
* temp: contains intermediate build artefacts
|
||||
|
||||
## Examples
|
||||
|
||||
### Symbols (<a href="https://github.com/MolecularMatters/raw_pdb/blob/main/src/Examples/ExampleSymbols.cpp">ExampleSymbols.cpp</a>)
|
||||
|
||||
A basic example that shows how to load symbols from public, global, and module streams.
|
||||
|
||||
### Contributions (<a href="https://github.com/MolecularMatters/raw_pdb/blob/main/src/Examples/ExampleContributions.cpp">ExampleContributions.cpp</a>)
|
||||
|
||||
A basic example that shows how to load contributions, sort them by size, and output the 20 largest ones along with the object file they originated from.
|
||||
|
||||
### Function symbols (<a href="https://github.com/MolecularMatters/raw_pdb/blob/main/src/Examples/ExampleFunctionSymbols.cpp">ExampleFunctionSymbols.cpp</a>)
|
||||
|
||||
An example intended for profiler developers that shows how to enumerate all function symbols and retrieve or compute their code size.
|
||||
|
||||
### Function variables (<a href="https://github.com/MolecularMatters/raw_pdb/blob/main/src/Examples/ExampleFunctionVariables.cpp">ExampleFunctionVariables.cpp</a>)
|
||||
|
||||
An example intended for debugger developers that shows how to enumerate all function records needed for displaying function variables.
|
||||
|
||||
### Lines (<a href="https://github.com/MolecularMatters/raw_pdb/blob/main/src/Examples/ExampleLines.cpp">ExampleLines.cpp</a>)
|
||||
|
||||
An example that shows to how to load line information for all modules.
|
||||
|
||||
### Types (<a href="https://github.com/MolecularMatters/raw_pdb/blob/main/src/Examples/ExampleTypes.cpp">ExampleTypes.cpp</a>)
|
||||
|
||||
An example that prints all type records.
|
||||
|
||||
### PDBSize (<a href="https://github.com/MolecularMatters/raw_pdb/blob/main/src/Examples/ExamplePDBSize.cpp">ExamplePDBSize.cpp</a>)
|
||||
|
||||
An example that could serve as a starting point for people wanting to investigate and optimize the size of their PDBs.
|
||||
|
||||
## Sponsoring or supporting RawPDB
|
||||
|
||||
We have chosen a very liberal license to let **RawPDB** be used in as many scenarios as possible, including commercial applications. If you would like to support its development, consider licensing <a href="https://liveplusplus.tech/">Live++</a> instead. Not only do you give something back, but get a great productivity enhancement on top!
|
||||
12
third_party/raw_pdb/raw_pdb.natvis
vendored
Normal file
12
third_party/raw_pdb/raw_pdb.natvis
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
|
||||
<Type Name="PDB::ArrayView<*>">
|
||||
<DisplayString>{{ size={m_length} }}</DisplayString>
|
||||
<Expand>
|
||||
<ArrayItems>
|
||||
<Size>m_length</Size>
|
||||
<ValuePointer>m_data</ValuePointer>
|
||||
</ArrayItems>
|
||||
</Expand>
|
||||
</Type>
|
||||
</AutoVisualizer>
|
||||
112
third_party/raw_pdb/src/CMakeLists.txt
vendored
Normal file
112
third_party/raw_pdb/src/CMakeLists.txt
vendored
Normal file
@@ -0,0 +1,112 @@
|
||||
set(SOURCES
|
||||
Foundation/PDB_ArrayView.h
|
||||
Foundation/PDB_Assert.h
|
||||
Foundation/PDB_BitOperators.h
|
||||
Foundation/PDB_BitUtil.h
|
||||
Foundation/PDB_CRT.h
|
||||
Foundation/PDB_Forward.h
|
||||
Foundation/PDB_Log.h
|
||||
Foundation/PDB_Macros.h
|
||||
Foundation/PDB_Memory.h
|
||||
Foundation/PDB_Move.h
|
||||
Foundation/PDB_Platform.h
|
||||
Foundation/PDB_PointerUtil.h
|
||||
Foundation/PDB_TypeTraits.h
|
||||
Foundation/PDB_Warnings.h
|
||||
|
||||
PDB.cpp
|
||||
PDB.h
|
||||
PDB_CoalescedMSFStream.cpp
|
||||
PDB_CoalescedMSFStream.h
|
||||
PDB_DBIStream.cpp
|
||||
PDB_DBIStream.h
|
||||
PDB_DBITypes.cpp
|
||||
PDB_DBITypes.h
|
||||
PDB_DirectMSFStream.cpp
|
||||
PDB_DirectMSFStream.h
|
||||
PDB_ErrorCodes.h
|
||||
PDB_GlobalSymbolStream.cpp
|
||||
PDB_GlobalSymbolStream.h
|
||||
PDB_ImageSectionStream.cpp
|
||||
PDB_ImageSectionStream.h
|
||||
PDB_InfoStream.cpp
|
||||
PDB_InfoStream.h
|
||||
PDB_IPIStream.cpp
|
||||
PDB_IPIStream.h
|
||||
PDB_IPITypes.h
|
||||
PDB_ModuleInfoStream.cpp
|
||||
PDB_ModuleInfoStream.h
|
||||
PDB_ModuleLineStream.cpp
|
||||
PDB_ModuleLineStream.h
|
||||
PDB_ModuleSymbolStream.cpp
|
||||
PDB_ModuleSymbolStream.h
|
||||
PDB_NamesStream.cpp
|
||||
PDB_NamesStream.h
|
||||
PDB_PCH.cpp
|
||||
PDB_PCH.h
|
||||
PDB_PublicSymbolStream.cpp
|
||||
PDB_PublicSymbolStream.h
|
||||
PDB_RawFile.cpp
|
||||
PDB_RawFile.h
|
||||
PDB_SectionContributionStream.cpp
|
||||
PDB_SectionContributionStream.h
|
||||
PDB_SourceFileStream.cpp
|
||||
PDB_SourceFileStream.h
|
||||
PDB_TPIStream.cpp
|
||||
PDB_TPIStream.h
|
||||
PDB_TPITypes.h
|
||||
PDB_Types.cpp
|
||||
PDB_Types.h
|
||||
PDB_Util.h
|
||||
)
|
||||
|
||||
source_group(src FILES
|
||||
${SOURCES}
|
||||
)
|
||||
|
||||
add_library(raw_pdb
|
||||
${SOURCES}
|
||||
)
|
||||
|
||||
target_include_directories(raw_pdb
|
||||
PUBLIC
|
||||
.
|
||||
)
|
||||
|
||||
target_precompile_headers(raw_pdb
|
||||
PRIVATE
|
||||
PDB_PCH.h
|
||||
)
|
||||
|
||||
option(RAWPDB_BUILD_EXAMPLES "Build Examples" ON)
|
||||
|
||||
if (RAWPDB_BUILD_EXAMPLES)
|
||||
add_subdirectory(Examples)
|
||||
endif()
|
||||
|
||||
if (UNIX)
|
||||
include(GNUInstallDirs)
|
||||
|
||||
install(
|
||||
TARGETS raw_pdb
|
||||
LIBRARY DESTINATION "${CMAKE_INSTALL_LIBDIR}"
|
||||
)
|
||||
|
||||
file(GLOB_RECURSE HEADER_FILES
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/*.h"
|
||||
)
|
||||
|
||||
file(GLOB_RECURSE HEADER_FILES_FOUNDATION
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}/Foundation/*.h"
|
||||
)
|
||||
|
||||
install(
|
||||
FILES ${HEADER_FILES}
|
||||
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/raw_pdb/"
|
||||
)
|
||||
|
||||
install(
|
||||
FILES ${HEADER_FILES_FOUNDATION}
|
||||
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/raw_pdb/Foundation"
|
||||
)
|
||||
endif (UNIX)
|
||||
39
third_party/raw_pdb/src/Examples/CMakeLists.txt
vendored
Normal file
39
third_party/raw_pdb/src/Examples/CMakeLists.txt
vendored
Normal file
@@ -0,0 +1,39 @@
|
||||
project(Examples)
|
||||
|
||||
set(SOURCES
|
||||
ExampleContributions.cpp
|
||||
ExampleFunctionSymbols.cpp
|
||||
ExampleFunctionVariables.cpp
|
||||
ExampleIPI.cpp
|
||||
ExampleLines.cpp
|
||||
ExampleMain.cpp
|
||||
ExampleMemoryMappedFile.cpp
|
||||
ExampleMemoryMappedFile.h
|
||||
ExamplePDBSize.cpp
|
||||
Examples_PCH.cpp
|
||||
Examples_PCH.h
|
||||
ExampleSymbols.cpp
|
||||
ExampleTimedScope.cpp
|
||||
ExampleTimedScope.h
|
||||
ExampleTypes.cpp
|
||||
ExampleTypeTable.cpp
|
||||
ExampleTypeTable.h
|
||||
)
|
||||
|
||||
source_group(src FILES
|
||||
${SOURCES}
|
||||
)
|
||||
|
||||
add_executable(Examples
|
||||
${SOURCES}
|
||||
)
|
||||
|
||||
target_link_libraries(Examples
|
||||
PUBLIC
|
||||
raw_pdb
|
||||
)
|
||||
|
||||
target_precompile_headers(Examples
|
||||
PUBLIC
|
||||
Examples_PCH.h
|
||||
)
|
||||
96
third_party/raw_pdb/src/Examples/ExampleContributions.cpp
vendored
Normal file
96
third_party/raw_pdb/src/Examples/ExampleContributions.cpp
vendored
Normal file
@@ -0,0 +1,96 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
|
||||
|
||||
namespace
|
||||
{
|
||||
// we don't have to store std::string in the contributions, since all the data is memory-mapped anyway.
|
||||
// we do it in this example to ensure that we don't "cheat" when reading the PDB file. memory-mapped data will only
|
||||
// be faulted into the process once it's touched, so actually copying the string data makes us touch the needed data,
|
||||
// giving us a real performance measurement.
|
||||
struct Contribution
|
||||
{
|
||||
std::string objectFile;
|
||||
uint32_t rva;
|
||||
uint32_t size;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
void ExampleContributions(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream);
|
||||
void ExampleContributions(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream)
|
||||
{
|
||||
TimedScope total("\nRunning example \"Contributions\"");
|
||||
|
||||
// in order to keep the example easy to understand, we load the PDB data serially.
|
||||
// note that this can be improved a lot by reading streams concurrently.
|
||||
|
||||
// prepare the image section stream first. it is needed for converting section + offset into an RVA
|
||||
TimedScope sectionScope("Reading image section stream");
|
||||
const PDB::ImageSectionStream imageSectionStream = dbiStream.CreateImageSectionStream(rawPdbFile);
|
||||
sectionScope.Done();
|
||||
|
||||
|
||||
// prepare the module info stream for matching contributions against files
|
||||
TimedScope moduleScope("Reading module info stream");
|
||||
const PDB::ModuleInfoStream moduleInfoStream = dbiStream.CreateModuleInfoStream(rawPdbFile);
|
||||
moduleScope.Done();
|
||||
|
||||
|
||||
// read contribution stream
|
||||
TimedScope contributionScope("Reading section contribution stream");
|
||||
const PDB::SectionContributionStream sectionContributionStream = dbiStream.CreateSectionContributionStream(rawPdbFile);
|
||||
contributionScope.Done();
|
||||
|
||||
std::vector<Contribution> contributions;
|
||||
{
|
||||
TimedScope scope("Storing contributions");
|
||||
|
||||
const PDB::ArrayView<PDB::DBI::SectionContribution> sectionContributions = sectionContributionStream.GetContributions();
|
||||
const size_t count = sectionContributions.GetLength();
|
||||
|
||||
contributions.reserve(count);
|
||||
|
||||
for (const PDB::DBI::SectionContribution& contribution : sectionContributions)
|
||||
{
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(contribution.section, contribution.offset);
|
||||
if (rva == 0u)
|
||||
{
|
||||
printf("Contribution has invalid RVA\n");
|
||||
continue;
|
||||
}
|
||||
|
||||
const PDB::ModuleInfoStream::Module& module = moduleInfoStream.GetModule(contribution.moduleIndex);
|
||||
|
||||
contributions.push_back(Contribution { module.GetName().Decay(), rva, contribution.size });
|
||||
}
|
||||
|
||||
scope.Done(count);
|
||||
}
|
||||
|
||||
TimedScope sortScope("std::sort contributions");
|
||||
std::sort(contributions.begin(), contributions.end(), [](const Contribution& lhs, const Contribution& rhs)
|
||||
{
|
||||
return lhs.size > rhs.size;
|
||||
});
|
||||
sortScope.Done();
|
||||
|
||||
total.Done();
|
||||
|
||||
// log the 20 largest contributions
|
||||
{
|
||||
printf("20 largest contributions:\n");
|
||||
|
||||
const size_t countToShow = std::min<size_t>(20ul, contributions.size());
|
||||
for (size_t i = 0u; i < countToShow; ++i)
|
||||
{
|
||||
const Contribution& contribution = contributions[i];
|
||||
printf("%zu: %u bytes from %s\n", i + 1u, contribution.size, contribution.objectFile.c_str());
|
||||
}
|
||||
}
|
||||
}
|
||||
262
third_party/raw_pdb/src/Examples/ExampleFunctionSymbols.cpp
vendored
Normal file
262
third_party/raw_pdb/src/Examples/ExampleFunctionSymbols.cpp
vendored
Normal file
@@ -0,0 +1,262 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
|
||||
namespace
|
||||
{
|
||||
// in this example, we are only interested in function symbols: function name, RVA, and size.
|
||||
// this is what most profilers need, they aren't interested in any other data.
|
||||
struct FunctionSymbol
|
||||
{
|
||||
std::string name;
|
||||
uint32_t rva;
|
||||
uint32_t size;
|
||||
const PDB::CodeView::DBI::Record* frameProc;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
void ExampleFunctionSymbols(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream);
|
||||
void ExampleFunctionSymbols(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream)
|
||||
{
|
||||
TimedScope total("\nRunning example \"Function symbols\"");
|
||||
|
||||
// in order to keep the example easy to understand, we load the PDB data serially.
|
||||
// note that this can be improved a lot by reading streams concurrently.
|
||||
|
||||
// prepare the image section stream first. it is needed for converting section + offset into an RVA
|
||||
TimedScope sectionScope("Reading image section stream");
|
||||
const PDB::ImageSectionStream imageSectionStream = dbiStream.CreateImageSectionStream(rawPdbFile);
|
||||
sectionScope.Done();
|
||||
|
||||
|
||||
// prepare the module info stream for grabbing function symbols from modules
|
||||
TimedScope moduleScope("Reading module info stream");
|
||||
const PDB::ModuleInfoStream moduleInfoStream = dbiStream.CreateModuleInfoStream(rawPdbFile);
|
||||
moduleScope.Done();
|
||||
|
||||
|
||||
// prepare symbol record stream needed by the public stream
|
||||
TimedScope symbolStreamScope("Reading symbol record stream");
|
||||
const PDB::CoalescedMSFStream symbolRecordStream = dbiStream.CreateSymbolRecordStream(rawPdbFile);
|
||||
symbolStreamScope.Done();
|
||||
|
||||
|
||||
// note that we only use unordered_set in order to keep the example code easy to understand.
|
||||
// using other hash set implementations like e.g. abseil's Swiss Tables (https://abseil.io/about/design/swisstables) is *much* faster.
|
||||
std::vector<FunctionSymbol> functionSymbols;
|
||||
std::unordered_set<uint32_t> seenFunctionRVAs;
|
||||
|
||||
// start by reading the module stream, grabbing every function symbol we can find.
|
||||
// in most cases, this gives us ~90% of all function symbols already, along with their size.
|
||||
{
|
||||
TimedScope scope("Storing function symbols from modules");
|
||||
|
||||
const PDB::ArrayView<PDB::ModuleInfoStream::Module> modules = moduleInfoStream.GetModules();
|
||||
|
||||
for (const PDB::ModuleInfoStream::Module& module : modules)
|
||||
{
|
||||
if (!module.HasSymbolStream())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
const PDB::ModuleSymbolStream moduleSymbolStream = module.CreateSymbolStream(rawPdbFile);
|
||||
moduleSymbolStream.ForEachSymbol([&functionSymbols, &seenFunctionRVAs, &imageSectionStream](const PDB::CodeView::DBI::Record* record)
|
||||
{
|
||||
// only grab function symbols from the module streams
|
||||
const char* name = nullptr;
|
||||
uint32_t rva = 0u;
|
||||
uint32_t size = 0u;
|
||||
if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_FRAMEPROC)
|
||||
{
|
||||
functionSymbols[functionSymbols.size() - 1].frameProc = record;
|
||||
return;
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_THUNK32)
|
||||
{
|
||||
if (record->data.S_THUNK32.thunk == PDB::CodeView::DBI::ThunkOrdinal::TrampolineIncremental)
|
||||
{
|
||||
// we have never seen incremental linking thunks stored inside a S_THUNK32 symbol, but better safe than sorry
|
||||
name = "ILT";
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_THUNK32.section, record->data.S_THUNK32.offset);
|
||||
size = 5u;
|
||||
}
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_TRAMPOLINE)
|
||||
{
|
||||
// incremental linking thunks are stored in the linker module
|
||||
name = "ILT";
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_TRAMPOLINE.thunkSection, record->data.S_TRAMPOLINE.thunkOffset);
|
||||
size = 5u;
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LPROC32)
|
||||
{
|
||||
name = record->data.S_LPROC32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LPROC32.section, record->data.S_LPROC32.offset);
|
||||
size = record->data.S_LPROC32.codeSize;
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_GPROC32)
|
||||
{
|
||||
name = record->data.S_GPROC32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_GPROC32.section, record->data.S_GPROC32.offset);
|
||||
size = record->data.S_GPROC32.codeSize;
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LPROC32_ID)
|
||||
{
|
||||
name = record->data.S_LPROC32_ID.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LPROC32_ID.section, record->data.S_LPROC32_ID.offset);
|
||||
size = record->data.S_LPROC32_ID.codeSize;
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_GPROC32_ID)
|
||||
{
|
||||
name = record->data.S_GPROC32_ID.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_GPROC32_ID.section, record->data.S_GPROC32_ID.offset);
|
||||
size = record->data.S_GPROC32_ID.codeSize;
|
||||
}
|
||||
|
||||
if (rva == 0u)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
functionSymbols.push_back(FunctionSymbol { name, rva, size, nullptr });
|
||||
seenFunctionRVAs.emplace(rva);
|
||||
});
|
||||
}
|
||||
|
||||
scope.Done(modules.GetLength());
|
||||
}
|
||||
|
||||
// we don't need to touch global symbols in this case.
|
||||
// most of the data we need can be obtained from the module symbol streams, and the global symbol stream only offers data symbols on top of that, which we are not interested in.
|
||||
// however, there can still be public function symbols we haven't seen yet in any of the modules, especially for PDBs that don't provide module-specific information.
|
||||
|
||||
// read public symbols
|
||||
TimedScope publicScope("Reading public symbol stream");
|
||||
const PDB::PublicSymbolStream publicSymbolStream = dbiStream.CreatePublicSymbolStream(rawPdbFile);
|
||||
publicScope.Done();
|
||||
{
|
||||
TimedScope scope("Storing public function symbols");
|
||||
|
||||
const PDB::ArrayView<PDB::HashRecord> hashRecords = publicSymbolStream.GetRecords();
|
||||
const size_t count = hashRecords.GetLength();
|
||||
|
||||
for (const PDB::HashRecord& hashRecord : hashRecords)
|
||||
{
|
||||
const PDB::CodeView::DBI::Record* record = publicSymbolStream.GetRecord(symbolRecordStream, hashRecord);
|
||||
if (record->header.kind != PDB::CodeView::DBI::SymbolRecordKind::S_PUB32)
|
||||
{
|
||||
// normally, a PDB only contains S_PUB32 symbols in the public symbol stream, but we have seen PDBs that also store S_CONSTANT as public symbols.
|
||||
// ignore these.
|
||||
continue;
|
||||
}
|
||||
|
||||
if ((PDB_AS_UNDERLYING(record->data.S_PUB32.flags) & PDB_AS_UNDERLYING(PDB::CodeView::DBI::PublicSymbolFlags::Function)) == 0u)
|
||||
{
|
||||
// ignore everything that is not a function
|
||||
continue;
|
||||
}
|
||||
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_PUB32.section, record->data.S_PUB32.offset);
|
||||
if (rva == 0u)
|
||||
{
|
||||
// certain symbols (e.g. control-flow guard symbols) don't have a valid RVA, ignore those
|
||||
continue;
|
||||
}
|
||||
|
||||
// check whether we already know this symbol from one of the module streams
|
||||
const auto it = seenFunctionRVAs.find(rva);
|
||||
if (it != seenFunctionRVAs.end())
|
||||
{
|
||||
// we know this symbol already, ignore it
|
||||
continue;
|
||||
}
|
||||
|
||||
// this is a new function symbol, so store it.
|
||||
// note that we don't know its size yet.
|
||||
functionSymbols.push_back(FunctionSymbol { record->data.S_PUB32.name, rva, 0u, nullptr });
|
||||
}
|
||||
|
||||
scope.Done(count);
|
||||
}
|
||||
|
||||
|
||||
// we still need to find the size of the public function symbols.
|
||||
// this can be deduced by sorting the symbols by their RVA, and then computing the distance between the current and the next symbol.
|
||||
// this works since functions are always mapped to executable pages, so they aren't interleaved by any data symbols.
|
||||
TimedScope sortScope("std::sort function symbols");
|
||||
std::sort(functionSymbols.begin(), functionSymbols.end(), [](const FunctionSymbol& lhs, const FunctionSymbol& rhs)
|
||||
{
|
||||
return lhs.rva < rhs.rva;
|
||||
});
|
||||
sortScope.Done();
|
||||
|
||||
const size_t symbolCount = functionSymbols.size();
|
||||
if (symbolCount != 0u)
|
||||
{
|
||||
TimedScope computeScope("Computing function symbol sizes");
|
||||
|
||||
size_t foundCount = 0u;
|
||||
|
||||
// we have at least 1 symbol.
|
||||
// compute missing symbol sizes by computing the distance from this symbol to the next.
|
||||
// note that this includes "int 3" padding after the end of a function. if you don't want that, but the actual number of bytes of
|
||||
// the function's code, your best bet is to use a disassembler instead.
|
||||
for (size_t i = 0u; i < symbolCount - 1u; ++i)
|
||||
{
|
||||
FunctionSymbol& currentSymbol = functionSymbols[i];
|
||||
if (currentSymbol.size != 0u)
|
||||
{
|
||||
// the symbol's size is already known
|
||||
continue;
|
||||
}
|
||||
|
||||
const FunctionSymbol& nextSymbol = functionSymbols[i + 1u];
|
||||
const size_t size = nextSymbol.rva - currentSymbol.rva;
|
||||
(void)size; // unused
|
||||
++foundCount;
|
||||
}
|
||||
|
||||
// we know have the sizes of all symbols, except the last.
|
||||
// this can be found by going through the contributions, if needed.
|
||||
FunctionSymbol& lastSymbol = functionSymbols[symbolCount - 1u];
|
||||
if (lastSymbol.size == 0u)
|
||||
{
|
||||
// bad luck, we can't deduce the last symbol's size, so have to consult the contributions instead.
|
||||
// we do a linear search in this case to keep the code simple.
|
||||
const PDB::SectionContributionStream sectionContributionStream = dbiStream.CreateSectionContributionStream(rawPdbFile);
|
||||
const PDB::ArrayView<PDB::DBI::SectionContribution> sectionContributions = sectionContributionStream.GetContributions();
|
||||
for (const PDB::DBI::SectionContribution& contribution : sectionContributions)
|
||||
{
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(contribution.section, contribution.offset);
|
||||
if (rva == 0u)
|
||||
{
|
||||
printf("Contribution has invalid RVA\n");
|
||||
continue;
|
||||
}
|
||||
|
||||
if (rva == lastSymbol.rva)
|
||||
{
|
||||
lastSymbol.size = contribution.size;
|
||||
break;
|
||||
}
|
||||
|
||||
if (rva > lastSymbol.rva)
|
||||
{
|
||||
// should have found the contribution by now
|
||||
printf("Unknown contribution for symbol %s at RVA 0x%X", lastSymbol.name.c_str(), lastSymbol.rva);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
computeScope.Done(foundCount);
|
||||
}
|
||||
|
||||
total.Done(functionSymbols.size());
|
||||
}
|
||||
382
third_party/raw_pdb/src/Examples/ExampleFunctionVariables.cpp
vendored
Normal file
382
third_party/raw_pdb/src/Examples/ExampleFunctionVariables.cpp
vendored
Normal file
@@ -0,0 +1,382 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
#include "ExampleTypeTable.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
#include "PDB_TPIStream.h"
|
||||
|
||||
using SymbolRecordKind = PDB::CodeView::DBI::SymbolRecordKind;
|
||||
|
||||
static std::string GetVariableTypeName(const TypeTable& typeTable, uint32_t typeIndex)
|
||||
{
|
||||
// Defined in ExampleTypes.cpp
|
||||
extern std::string GetTypeName(const TypeTable & typeTable, uint32_t typeIndex);
|
||||
|
||||
std::string typeName = GetTypeName(typeTable, typeIndex);
|
||||
|
||||
// Remove any '%s' substring used to insert a variable/field name.
|
||||
const uint64_t markerPos = typeName.find("%s");
|
||||
if (markerPos != typeName.npos)
|
||||
{
|
||||
typeName.erase(markerPos, 2);
|
||||
}
|
||||
|
||||
return typeName;
|
||||
}
|
||||
|
||||
static void Printf(uint32_t indent, const char* format, ...)
|
||||
{
|
||||
va_list args;
|
||||
va_start(args, format);
|
||||
|
||||
printf("%*s", indent * 4, "");
|
||||
vprintf(format, args);
|
||||
|
||||
va_end(args);
|
||||
}
|
||||
|
||||
void ExampleFunctionVariables(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream, const PDB::TPIStream& tpiStream);
|
||||
void ExampleFunctionVariables(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream, const PDB::TPIStream& tpiStream)
|
||||
{
|
||||
TimedScope total("\nRunning example \"Function variables\"");
|
||||
|
||||
TimedScope typeTableScope("Create TypeTable");
|
||||
TypeTable typeTable(tpiStream);
|
||||
typeTableScope.Done();
|
||||
|
||||
// in order to keep the example easy to understand, we load the PDB data serially.
|
||||
// note that this can be improved a lot by reading streams concurrently.
|
||||
|
||||
// prepare the image section stream first. it is needed for converting section + offset into an RVA
|
||||
TimedScope sectionScope("Reading image section stream");
|
||||
const PDB::ImageSectionStream imageSectionStream = dbiStream.CreateImageSectionStream(rawPdbFile);
|
||||
sectionScope.Done();
|
||||
|
||||
// prepare the module info stream for grabbing function symbols from modules
|
||||
TimedScope moduleScope("Reading module info stream");
|
||||
const PDB::ModuleInfoStream moduleInfoStream = dbiStream.CreateModuleInfoStream(rawPdbFile);
|
||||
moduleScope.Done();
|
||||
|
||||
// prepare symbol record stream needed by the public stream
|
||||
TimedScope symbolStreamScope("Reading symbol record stream");
|
||||
const PDB::CoalescedMSFStream symbolRecordStream = dbiStream.CreateSymbolRecordStream(rawPdbFile);
|
||||
symbolStreamScope.Done();
|
||||
|
||||
{
|
||||
TimedScope scope("Printing function variable records from modules\n");
|
||||
|
||||
const PDB::ArrayView<PDB::ModuleInfoStream::Module> modules = moduleInfoStream.GetModules();
|
||||
|
||||
uint32_t blockLevel = 0;
|
||||
uint32_t recordCount = 0;
|
||||
|
||||
for (const PDB::ModuleInfoStream::Module& module : modules)
|
||||
{
|
||||
if (!module.HasSymbolStream())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
const PDB::ModuleSymbolStream moduleSymbolStream = module.CreateSymbolStream(rawPdbFile);
|
||||
moduleSymbolStream.ForEachSymbol([&typeTable, &imageSectionStream, &blockLevel, &recordCount](const PDB::CodeView::DBI::Record* record)
|
||||
{
|
||||
const SymbolRecordKind kind = record->header.kind;
|
||||
const PDB::CodeView::DBI::Record::Data& data = record->data;
|
||||
|
||||
if (kind == SymbolRecordKind::S_END)
|
||||
{
|
||||
PDB_ASSERT(blockLevel > 0, "Block level for S_END is 0");
|
||||
blockLevel--;
|
||||
Printf(blockLevel, "S_END\n");
|
||||
|
||||
if (blockLevel == 0)
|
||||
{
|
||||
Printf(0, "\n");
|
||||
}
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_SKIP)
|
||||
{
|
||||
Printf(blockLevel, "S_SKIP\n");
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_BLOCK32)
|
||||
{
|
||||
const uint32_t offset = imageSectionStream.ConvertSectionOffsetToRVA(data.S_BLOCK32.section, data.S_BLOCK32.offset);
|
||||
|
||||
Printf(blockLevel, "S_BLOCK32: '%s' | Code Offset 0x%X\n", data.S_BLOCK32.name, offset);
|
||||
blockLevel++;
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_LABEL32)
|
||||
{
|
||||
Printf(blockLevel, "S_LABEL32: '%s' | Offset 0x%X\n", data.S_LABEL32.name, data.S_LABEL32.offset);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_CONSTANT)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_CONSTANT.typeIndex);
|
||||
|
||||
Printf(blockLevel, "S_CONSTANT: '%s' -> '%s' | Value 0x%X\n", typeName.c_str(), data.S_CONSTANT.name, data.S_CONSTANT.value);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_LOCAL)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_LOCAL.typeIndex);
|
||||
Printf(blockLevel, "S_LOCAL: '%s' -> '%s' | Param: %s | Optimized Out: %s\n", typeName.c_str(), data.S_LOCAL.name, data.S_LOCAL.flags.fIsParam ? "True" : "False", data.S_LOCAL.flags.fIsOptimizedOut ? "True" : "False");
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_DEFRANGE_REGISTER)
|
||||
{
|
||||
Printf(blockLevel, "S_DEFRANGE_REGISTER: Register 0x%X\n", data.S_DEFRANGE_REGISTER.reg);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_DEFRANGE_FRAMEPOINTER_REL)
|
||||
{
|
||||
Printf(blockLevel, "S_DEFRANGE_FRAMEPOINTER_REL: Frame Pointer Offset 0x%X | Range Start 0x%X | Range Section Start 0x%X | Range Length %u\n",
|
||||
data.S_DEFRANGE_FRAMEPOINTER_REL.offsetFramePointer,
|
||||
data.S_DEFRANGE_FRAMEPOINTER_REL.range.offsetStart,
|
||||
data.S_DEFRANGE_FRAMEPOINTER_REL.range.isectionStart,
|
||||
data.S_DEFRANGE_FRAMEPOINTER_REL.range.length);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_DEFRANGE_SUBFIELD_REGISTER)
|
||||
{
|
||||
Printf(blockLevel, "S_DEFRANGE_SUBFIELD_REGISTER: Register %u | Parent offset 0x%X | Range Start 0x%X | Range Section Start 0x%X | Range Length %u\n",
|
||||
data.S_DEFRANGE_SUBFIELD_REGISTER.reg,
|
||||
data.S_DEFRANGE_SUBFIELD_REGISTER.offsetParent,
|
||||
data.S_DEFRANGE_SUBFIELD_REGISTER.range.offsetStart,
|
||||
data.S_DEFRANGE_SUBFIELD_REGISTER.range.isectionStart,
|
||||
data.S_DEFRANGE_SUBFIELD_REGISTER.range.length);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE)
|
||||
{
|
||||
Printf(blockLevel, "S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE: Offset 0x%X\n", data.S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE.offsetFramePointer);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_DEFRANGE_REGISTER_REL)
|
||||
{
|
||||
Printf(blockLevel, "S_DEFRANGE_REGISTER_REL: Base Register %u | Parent offset 0x%X | Base Register Offset 0x%X | Range Start 0x%X | Range Section Start 0x%X | Range Length %u\n",
|
||||
data.S_DEFRANGE_REGISTER_REL.baseRegister,
|
||||
data.S_DEFRANGE_REGISTER_REL.offsetParent,
|
||||
data.S_DEFRANGE_REGISTER_REL.offsetBasePointer,
|
||||
data.S_DEFRANGE_REGISTER_REL.offsetParent,
|
||||
data.S_DEFRANGE_REGISTER_REL.range.offsetStart,
|
||||
data.S_DEFRANGE_REGISTER_REL.range.isectionStart,
|
||||
data.S_DEFRANGE_REGISTER_REL.range.length);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_FILESTATIC)
|
||||
{
|
||||
Printf(blockLevel, "S_FILESTATIC: '%s'\n", data.S_FILESTATIC.name);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_INLINESITE)
|
||||
{
|
||||
Printf(blockLevel, "S_INLINESITE: Parent 0x%X\n", data.S_INLINESITE.parent);
|
||||
blockLevel++;
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_INLINESITE_END)
|
||||
{
|
||||
PDB_ASSERT(blockLevel > 0, "Block level for S_INLINESITE_END is 0");
|
||||
blockLevel--;
|
||||
Printf(blockLevel, "S_INLINESITE_END:\n");
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_CALLEES)
|
||||
{
|
||||
Printf(blockLevel, "S_CALLEES: Count %u\n", data.S_CALLEES.count);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_CALLERS)
|
||||
{
|
||||
Printf(blockLevel, "S_CALLERS: Count %u\n", data.S_CALLERS.count);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_INLINEES)
|
||||
{
|
||||
Printf(blockLevel, "S_INLINEES: Count %u\n", data.S_INLINEES.count);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_LDATA32)
|
||||
{
|
||||
if (blockLevel > 0)
|
||||
{
|
||||
// Not sure why some type index 0 (T_NO_TYPE) are included in some PDBs.
|
||||
if (data.S_LDATA32.typeIndex != 0) // PDB::CodeView::TPI::TypeIndexKind::T_NOTYPE)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_LDATA32.typeIndex);
|
||||
Printf(blockLevel, "S_LDATA32: '%s' -> '%s'\n", data.S_LDATA32.name, typeName.c_str());
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_LTHREAD32)
|
||||
{
|
||||
if (blockLevel > 0)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_LTHREAD32.typeIndex);
|
||||
Printf(blockLevel, "S_LTHREAD32: '%s' -> '%s'\n", data.S_LTHREAD32.name, typeName.c_str());
|
||||
}
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_UDT)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_UDT.typeIndex);
|
||||
|
||||
Printf(blockLevel, "S_UDT: '%s' -> '%s'\n", data.S_UDT.name, typeName.c_str());
|
||||
}
|
||||
else if (kind == PDB::CodeView::DBI::SymbolRecordKind::S_REGISTER)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_REGSYM.typeIndex);
|
||||
|
||||
Printf(blockLevel, "S_REGSYM: '%s' -> '%s' | Register %i\n",
|
||||
data.S_REGSYM.name, typeName.c_str(),
|
||||
data.S_REGSYM.reg);
|
||||
}
|
||||
else if (kind == PDB::CodeView::DBI::SymbolRecordKind::S_BPREL32)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_BPRELSYM32.typeIndex);
|
||||
|
||||
Printf(blockLevel, "S_BPRELSYM32: '%s' -> '%s' | BP register Offset 0x%X\n",
|
||||
data.S_BPRELSYM32.name, typeName.c_str(),
|
||||
data.S_BPRELSYM32.offset);
|
||||
}
|
||||
else if (kind == PDB::CodeView::DBI::SymbolRecordKind::S_REGREL32)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_REGREL32.typeIndex);
|
||||
|
||||
Printf(blockLevel, "S_REGREL32: '%s' -> '%s' | Register %i | Register Offset 0x%X\n",
|
||||
data.S_REGREL32.name, typeName.c_str(),
|
||||
data.S_REGREL32.reg,
|
||||
data.S_REGREL32.offset);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_FRAMECOOKIE)
|
||||
{
|
||||
Printf(blockLevel, "S_FRAMECOOKIE: Offset 0x%X | Register %u | Type %u\n",
|
||||
data.S_FRAMECOOKIE.offset,
|
||||
data.S_FRAMECOOKIE.reg,
|
||||
data.S_FRAMECOOKIE.cookietype);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_CALLSITEINFO)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_CALLSITEINFO.typeIndex);
|
||||
Printf(blockLevel, "S_CALLSITEINFO: '%s' | Offset 0x%X | Section %u\n", typeName.c_str(), data.S_CALLSITEINFO.offset, data.S_CALLSITEINFO.section);
|
||||
}
|
||||
else if(kind == SymbolRecordKind::S_HEAPALLOCSITE)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_HEAPALLOCSITE.typeIndex);
|
||||
Printf(blockLevel, "S_HEAPALLOCSITE: '%s' | Offset 0x%X | Section %u | Instruction Length %u\n", typeName.c_str(),
|
||||
data.S_HEAPALLOCSITE.offset,
|
||||
data.S_HEAPALLOCSITE.section,
|
||||
data.S_HEAPALLOCSITE.instructionLength);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_FRAMEPROC)
|
||||
{
|
||||
Printf(blockLevel, "S_FRAMEPROC: Size %u | Padding %u | Padding Offset 0x%X | Callee Registers Size %u\n",
|
||||
data.S_FRAMEPROC.cbFrame,
|
||||
data.S_FRAMEPROC.cbPad,
|
||||
data.S_FRAMEPROC.offPad,
|
||||
data.S_FRAMEPROC.cbSaveRegs);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_ANNOTATION)
|
||||
{
|
||||
Printf(blockLevel, "S_ANNOTATION: Offset 0x%X | Count %u\n", data.S_ANNOTATIONSYM.offset, data.S_ANNOTATIONSYM.annotationsCount);
|
||||
// print N null-terminated annotation strings, skipping their null-terminators to get to the next string
|
||||
const char* annotation = data.S_ANNOTATIONSYM.annotations;
|
||||
for (int i = 0; i < data.S_ANNOTATIONSYM.annotationsCount; ++i, annotation += strlen(annotation) + 1)
|
||||
Printf(blockLevel + 1, "S_ANNOTATION.%u: %s\n", i, annotation);
|
||||
PDB_ASSERT(annotation <= (const char*)record + record->header.size + sizeof(record->header.size),
|
||||
"Annotation strings end beyond the record size %X; annotaions count: %u", record->header.size, data.S_ANNOTATIONSYM.annotationsCount);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_THUNK32)
|
||||
{
|
||||
PDB_ASSERT(blockLevel == 0, "BlockLevel %u != 0", blockLevel);
|
||||
|
||||
if (data.S_THUNK32.thunk == PDB::CodeView::DBI::ThunkOrdinal::TrampolineIncremental)
|
||||
{
|
||||
// we have never seen incremental linking thunks stored inside a S_THUNK32 symbol, but better safe than sorry
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(data.S_THUNK32.section, data.S_THUNK32.offset);
|
||||
Printf(blockLevel, "Function: 'ILT/Thunk' | RVA 0x%X\n", rva);
|
||||
}
|
||||
else
|
||||
{
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(data.S_THUNK32.section, data.S_THUNK32.offset);
|
||||
Printf(blockLevel, "S_THUNK32 Function '%s' | RVA 0x%X\n", data.S_THUNK32.name, rva);
|
||||
blockLevel++;
|
||||
}
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_TRAMPOLINE)
|
||||
{
|
||||
PDB_ASSERT(blockLevel == 0, "BlockLevel %u != 0", blockLevel);
|
||||
// incremental linking thunks are stored in the linker module
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(data.S_TRAMPOLINE.thunkSection, data.S_TRAMPOLINE.thunkOffset);
|
||||
Printf(blockLevel, "Function 'ILT/Trampoline' | RVA 0x%X\n", rva);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_LPROC32)
|
||||
{
|
||||
PDB_ASSERT(blockLevel == 0, "BlockLevel %u != 0", blockLevel);
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(data.S_LPROC32.section, data.S_LPROC32.offset);
|
||||
Printf(blockLevel, "S_LPROC32 Function '%s' | RVA 0x%X\n", data.S_LPROC32.name, rva);
|
||||
blockLevel++;
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_GPROC32)
|
||||
{
|
||||
PDB_ASSERT(blockLevel == 0, "BlockLevel %u != 0", blockLevel);
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(data.S_GPROC32.section, data.S_GPROC32.offset);
|
||||
Printf(blockLevel, "S_GPROC32 Function '%s' | RVA 0x%X\n", data.S_GPROC32.name, rva);
|
||||
blockLevel++;
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_LPROC32_ID)
|
||||
{
|
||||
PDB_ASSERT(blockLevel == 0, "BlockLevel %u != 0", blockLevel);
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(data.S_LPROC32_ID.section, data.S_LPROC32_ID.offset);
|
||||
Printf(blockLevel, "S_LPROC32_ID Function '%s' | RVA 0x%X\n", data.S_LPROC32_ID.name, rva);
|
||||
blockLevel++;
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_GPROC32_ID)
|
||||
{
|
||||
PDB_ASSERT(blockLevel == 0, "BlockLevel %u != 0", blockLevel);
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(data.S_GPROC32_ID.section, data.S_GPROC32_ID.offset);
|
||||
Printf(blockLevel, "S_GPROC32_ID Function '%s' | RVA 0x%X\n", data.S_GPROC32_ID.name, rva);
|
||||
blockLevel++;
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_REGREL32_INDIR)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_REGREL32_INDIR.typeIndex);
|
||||
|
||||
Printf(blockLevel, "S_REGREL32_INDIR: '%s' -> '%s' | Register %i | Unknown1 0x%X | Unknown2 0x%X\n",
|
||||
data.S_REGREL32_INDIR.name, typeName.c_str(),
|
||||
data.S_REGREL32_INDIR.unknown1,
|
||||
data.S_REGREL32_INDIR.unknown1);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_REGREL32_ENCTMP)
|
||||
{
|
||||
const std::string typeName = GetVariableTypeName(typeTable, data.S_REGREL32.typeIndex);
|
||||
|
||||
Printf(blockLevel, "S_REGREL32_ENCTMP: '%s' -> '%s' | Register %i | Register Offset 0x%X\n",
|
||||
data.S_REGREL32.name, typeName.c_str(),
|
||||
data.S_REGREL32.reg,
|
||||
data.S_REGREL32.offset);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_UNAMESPACE)
|
||||
{
|
||||
Printf(blockLevel, "S_UNAMESPACE: '%s'\n", data.S_UNAMESPACE.name);
|
||||
}
|
||||
else if (kind == SymbolRecordKind::S_ARMSWITCHTABLE)
|
||||
{
|
||||
Printf(blockLevel, "S_ARMSWITCHTABLE: "
|
||||
"Switch Type: %u | Num Entries: %u | Base Section: %u | Base Offset: 0x%X | "
|
||||
"Branch Section: %u | Branch Offset: 0x%X | Table Section: %u | Table Offset: 0x%X\n",
|
||||
data.S_ARMSWITCHTABLE.switchType,
|
||||
data.S_ARMSWITCHTABLE.numEntries,
|
||||
data.S_ARMSWITCHTABLE.sectionBase,
|
||||
data.S_ARMSWITCHTABLE.offsetBase,
|
||||
data.S_ARMSWITCHTABLE.sectionBranch,
|
||||
data.S_ARMSWITCHTABLE.offsetBranch,
|
||||
data.S_ARMSWITCHTABLE.sectionTable,
|
||||
data.S_ARMSWITCHTABLE.offsetTable);
|
||||
}
|
||||
else
|
||||
{
|
||||
// We only care about records inside functions.
|
||||
if (blockLevel > 0)
|
||||
{
|
||||
PDB_ASSERT(false, "Unhandled record kind 0x%X with block level %u\n", static_cast<uint16_t>(kind), blockLevel);
|
||||
}
|
||||
}
|
||||
|
||||
recordCount++;
|
||||
|
||||
});
|
||||
}
|
||||
|
||||
scope.Done(recordCount);
|
||||
}
|
||||
}
|
||||
198
third_party/raw_pdb/src/Examples/ExampleIPI.cpp
vendored
Normal file
198
third_party/raw_pdb/src/Examples/ExampleIPI.cpp
vendored
Normal file
@@ -0,0 +1,198 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
#include "ExampleTypeTable.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_InfoStream.h"
|
||||
#include "PDB_IPIStream.h"
|
||||
#include "PDB_TPIStream.h"
|
||||
|
||||
static std::string GetTypeNameIPI(const TypeTable& typeTable, uint32_t typeIndex)
|
||||
{
|
||||
// Defined in ExampleTypes.cpp
|
||||
extern std::string GetTypeName(const TypeTable & typeTable, uint32_t typeIndex);
|
||||
|
||||
std::string typeName = GetTypeName(typeTable, typeIndex);
|
||||
|
||||
// Remove any '%s' substring used to insert a variable/field name.
|
||||
const uint64_t markerPos = typeName.find("%s");
|
||||
if (markerPos != typeName.npos)
|
||||
{
|
||||
typeName.erase(markerPos, 2);
|
||||
}
|
||||
|
||||
return typeName;
|
||||
}
|
||||
|
||||
void ExampleIPI(const PDB::RawFile& rawPdbFile, const PDB::InfoStream& infoStream, const PDB::TPIStream& tpiStream, const PDB::IPIStream& ipiStream);
|
||||
|
||||
void ExampleIPI(const PDB::RawFile& rawPdbFile, const PDB::InfoStream& infoStream, const PDB::TPIStream& tpiStream, const PDB::IPIStream& ipiStream)
|
||||
{
|
||||
if (!infoStream.HasIPIStream())
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
TimedScope total("\nRunning example \"IPI\"");
|
||||
|
||||
TimedScope typeTableScope("Create TypeTable");
|
||||
TypeTable typeTable(tpiStream);
|
||||
typeTableScope.Done();
|
||||
|
||||
// prepare names stream for grabbing file paths from lines
|
||||
TimedScope namesScope("Reading names stream");
|
||||
const PDB::NamesStream namesStream = infoStream.CreateNamesStream(rawPdbFile);
|
||||
namesScope.Done();
|
||||
|
||||
const uint32_t firstTypeIndex = ipiStream.GetFirstTypeIndex();
|
||||
|
||||
PDB::ArrayView<const PDB::CodeView::IPI::Record*> records = ipiStream.GetTypeRecords();
|
||||
|
||||
std::vector<const char*> strings;
|
||||
|
||||
strings.resize(records.GetLength(), nullptr);
|
||||
|
||||
size_t index = 0;
|
||||
|
||||
for (const PDB::CodeView::IPI::Record* record : records)
|
||||
{
|
||||
const PDB::CodeView::IPI::RecordHeader& header = record->header;
|
||||
|
||||
if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_STRING_ID)
|
||||
{
|
||||
strings[index] = record->data.LF_STRING_ID.name;
|
||||
}
|
||||
|
||||
index++;
|
||||
}
|
||||
|
||||
uint32_t identifier = firstTypeIndex;
|
||||
|
||||
std::string typeName, parentTypeName;
|
||||
|
||||
printf("\n --- IPI Records ---\n\n");
|
||||
|
||||
for(const PDB::CodeView::IPI::Record* record : records)
|
||||
{
|
||||
const PDB::CodeView::IPI::RecordHeader& header = record->header;
|
||||
|
||||
if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_FUNC_ID)
|
||||
{
|
||||
typeName = GetTypeNameIPI(typeTable, record->data.LF_FUNC_ID.typeIndex);
|
||||
|
||||
printf("Kind: 'LF_FUNC_ID' Size: %i ID: %u\n", header.size, identifier);
|
||||
printf(" Scope ID: %u\n Type: '%s'\n Name: '%s'\n\n",
|
||||
record->data.LF_FUNC_ID.scopeId,
|
||||
typeName.c_str(),
|
||||
record->data.LF_FUNC_ID.name);
|
||||
|
||||
}
|
||||
else if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_MFUNC_ID)
|
||||
{
|
||||
typeName = GetTypeNameIPI(typeTable, record->data.LF_MFUNC_ID.typeIndex);
|
||||
parentTypeName = GetTypeNameIPI(typeTable, record->data.LF_MFUNC_ID.parentTypeIndex);
|
||||
|
||||
printf("Kind: 'LF_MFUNC_ID' Size: %i ID: %u\n", header.size, identifier);
|
||||
printf(" Parent Type: '%s'\n Type: '%s'\n Name: '%s'\n\n",
|
||||
parentTypeName.c_str(),
|
||||
typeName.c_str(),
|
||||
record->data.LF_MFUNC_ID.name);
|
||||
|
||||
}
|
||||
else if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_BUILDINFO)
|
||||
{
|
||||
printf("Kind: 'LF_BUILDINFO' Size: %u ID: %u\n", header.size, identifier);
|
||||
|
||||
if (record->data.LF_BUILDINFO.count == 0)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
printf("Strings: '%s'", strings[record->data.LF_BUILDINFO.typeIndices[0] - firstTypeIndex]);
|
||||
|
||||
for (uint32_t i = 1, size = record->data.LF_BUILDINFO.count; i < size; ++i)
|
||||
{
|
||||
const uint32_t stringIndex = record->data.LF_BUILDINFO.typeIndices[i];
|
||||
|
||||
if (stringIndex == 0)
|
||||
{
|
||||
printf(", ''");
|
||||
}
|
||||
else
|
||||
{
|
||||
printf(", '%s'", strings[stringIndex - firstTypeIndex]);
|
||||
}
|
||||
}
|
||||
|
||||
printf("\n\n");
|
||||
}
|
||||
else if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_SUBSTR_LIST)
|
||||
{
|
||||
printf("Kind: 'LF_SUBSTR_LIST' Size: %u ID: %u\n", header.size, identifier);
|
||||
|
||||
if (record->data.LF_SUBSTR_LIST.count == 0)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
printf(" Strings: '%s'", strings[record->data.LF_SUBSTR_LIST.typeIndices[0] - firstTypeIndex]);
|
||||
|
||||
for (uint32_t i = 1, size = record->data.LF_SUBSTR_LIST.count; i < size; ++i)
|
||||
{
|
||||
const uint32_t stringIndex = record->data.LF_SUBSTR_LIST.typeIndices[i];
|
||||
|
||||
if (stringIndex == 0)
|
||||
{
|
||||
printf(", ''");
|
||||
}
|
||||
else
|
||||
{
|
||||
printf(", '%s'", strings[stringIndex - firstTypeIndex]);
|
||||
}
|
||||
}
|
||||
|
||||
printf("\n\n");
|
||||
}
|
||||
else if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_STRING_ID)
|
||||
{
|
||||
printf("Kind: 'LF_STRING_ID' Size: %u ID: %u\n", header.size, identifier);
|
||||
|
||||
printf(" Substring ID: %u\n Name: '%s'\n\n", record->data.LF_STRING_ID.id, record->data.LF_STRING_ID.name);
|
||||
}
|
||||
else if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_UDT_SRC_LINE)
|
||||
{
|
||||
typeName = GetTypeNameIPI(typeTable, record->data.LF_UDT_SRC_LINE.typeIndex);
|
||||
|
||||
const uint32_t stringIndex = record->data.LF_UDT_SRC_LINE.stringIndex;
|
||||
|
||||
printf("Kind: 'LF_UDT_SRC_LINE' Size: %u ID: %u\n", header.size, identifier);
|
||||
|
||||
printf(" Type: '%s'\n Source Path: %s\n Line: %u\n\n",
|
||||
typeName.c_str(),
|
||||
strings[stringIndex - firstTypeIndex],
|
||||
record->data.LF_UDT_SRC_LINE.line);
|
||||
}
|
||||
else if (header.kind == PDB::CodeView::IPI::TypeRecordKind::LF_UDT_MOD_SRC_LINE)
|
||||
{
|
||||
typeName = GetTypeNameIPI(typeTable, record->data.LF_UDT_MOD_SRC_LINE.typeIndex);
|
||||
|
||||
const char* string = namesStream.GetFilename(record->data.LF_UDT_MOD_SRC_LINE.stringIndex);
|
||||
|
||||
printf("Kind: 'LF_UDT_SRC_LINE' Size: %u ID: %u\n", header.size, identifier);
|
||||
|
||||
printf(" Type: '%s'\n Source Path: %s\n Line: %u\n Module Index: %u\n\n",
|
||||
typeName.c_str(),
|
||||
string,
|
||||
record->data.LF_UDT_MOD_SRC_LINE.line,
|
||||
record->data.LF_UDT_MOD_SRC_LINE.moduleIndex);
|
||||
}
|
||||
else
|
||||
{
|
||||
printf("Kind: 0x%X Size: %u ID: %u\n\n", static_cast<uint32_t>(header.kind), header.size, identifier);
|
||||
}
|
||||
|
||||
identifier++;
|
||||
}
|
||||
}
|
||||
268
third_party/raw_pdb/src/Examples/ExampleLines.cpp
vendored
Normal file
268
third_party/raw_pdb/src/Examples/ExampleLines.cpp
vendored
Normal file
@@ -0,0 +1,268 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
#include "Foundation/PDB_PointerUtil.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
#include "PDB_InfoStream.h"
|
||||
|
||||
#include <cstring>
|
||||
|
||||
namespace
|
||||
{
|
||||
struct Section
|
||||
{
|
||||
uint16_t index;
|
||||
uint32_t offset;
|
||||
size_t lineIndex;
|
||||
};
|
||||
|
||||
struct Filename
|
||||
{
|
||||
uint32_t fileChecksumOffset;
|
||||
uint32_t namesFilenameOffset;
|
||||
PDB::CodeView::DBI::ChecksumKind checksumKind;
|
||||
uint8_t checksumSize;
|
||||
uint8_t checksum[32];
|
||||
};
|
||||
|
||||
struct Line
|
||||
{
|
||||
uint32_t lineNumber;
|
||||
uint32_t codeSize;
|
||||
size_t filenameIndex;
|
||||
};
|
||||
}
|
||||
|
||||
void ExampleLines(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream, const PDB::InfoStream& infoStream);
|
||||
void ExampleLines(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream, const PDB::InfoStream& infoStream)
|
||||
{
|
||||
if (!infoStream.HasNamesStream())
|
||||
{
|
||||
printf("PDB has no '/names' stream for looking up filenames for lines, skipping \"Lines\" example.");
|
||||
return;
|
||||
}
|
||||
|
||||
TimedScope total("\nRunning example \"Lines\"");
|
||||
|
||||
// prepare the image section stream first. it is needed for converting section + offset into an RVA
|
||||
TimedScope sectionScope("Reading image section stream");
|
||||
const PDB::ImageSectionStream imageSectionStream = dbiStream.CreateImageSectionStream(rawPdbFile);
|
||||
sectionScope.Done();
|
||||
|
||||
// prepare the module info stream for grabbing function symbols from modules
|
||||
TimedScope moduleScope("Reading module info stream");
|
||||
const PDB::ModuleInfoStream moduleInfoStream = dbiStream.CreateModuleInfoStream(rawPdbFile);
|
||||
moduleScope.Done();
|
||||
|
||||
// prepare names stream for grabbing file paths from lines
|
||||
TimedScope namesScope("Reading names stream");
|
||||
const PDB::NamesStream namesStream = infoStream.CreateNamesStream(rawPdbFile);
|
||||
namesScope.Done();
|
||||
|
||||
// keeping sections and lines separate, as sorting the smaller Section struct is 2x faster in release builds
|
||||
// than having all the fields in one big Line struct and sorting those.
|
||||
std::vector<Section> sections;
|
||||
std::vector<Filename> filenames;
|
||||
std::vector<Line> lines;
|
||||
|
||||
{
|
||||
TimedScope scope("Storing lines from modules");
|
||||
|
||||
const PDB::ArrayView<PDB::ModuleInfoStream::Module> modules = moduleInfoStream.GetModules();
|
||||
|
||||
for (const PDB::ModuleInfoStream::Module& module : modules)
|
||||
{
|
||||
if (!module.HasLineStream())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
const PDB::ModuleLineStream moduleLineStream = module.CreateLineStream(rawPdbFile);
|
||||
|
||||
const size_t moduleFilenamesStartIndex = filenames.size();
|
||||
const PDB::CodeView::DBI::FileChecksumHeader* moduleFileChecksumHeader = nullptr;
|
||||
|
||||
moduleLineStream.ForEachSection([&moduleLineStream, &namesStream, &moduleFileChecksumHeader, §ions, &filenames, &lines](const PDB::CodeView::DBI::LineSection* lineSection)
|
||||
{
|
||||
if (lineSection->header.kind == PDB::CodeView::DBI::DebugSubsectionKind::S_LINES)
|
||||
{
|
||||
moduleLineStream.ForEachLinesBlock(lineSection,
|
||||
[&lineSection, §ions, &filenames, &lines](const PDB::CodeView::DBI::LinesFileBlockHeader* linesBlockHeader, const PDB::CodeView::DBI::Line* blocklines, const PDB::CodeView::DBI::Column* blockColumns)
|
||||
{
|
||||
if (linesBlockHeader->numLines == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
const PDB::CodeView::DBI::Line& firstLine = blocklines[0];
|
||||
|
||||
const uint16_t sectionIndex = lineSection->linesHeader.sectionIndex;
|
||||
const uint32_t sectionOffset = lineSection->linesHeader.sectionOffset;
|
||||
const uint32_t fileChecksumOffset = linesBlockHeader->fileChecksumOffset;
|
||||
|
||||
const size_t filenameIndex = filenames.size();
|
||||
|
||||
// there will be duplicate filenames for any real world pdb.
|
||||
// ideally the filenames would be stored in a map with the filename or checksum as the key.
|
||||
// but that would complicate the logic in this example and therefore just use a vector to make it easier to understand.
|
||||
filenames.push_back({ fileChecksumOffset, 0, PDB::CodeView::DBI::ChecksumKind::None, 0, {0} });
|
||||
|
||||
sections.push_back({ sectionIndex, sectionOffset, lines.size() });
|
||||
|
||||
// initially set code size of first line to 0, will be updated in loop below.
|
||||
lines.push_back({ firstLine.linenumStart, 0, filenameIndex });
|
||||
|
||||
for(uint32_t i = 1, size = linesBlockHeader->numLines; i < size; ++i)
|
||||
{
|
||||
const PDB::CodeView::DBI::Line& line = blocklines[i];
|
||||
|
||||
// calculate code size of previous line by using the current line offset.
|
||||
lines.back().codeSize = line.offset - blocklines[i-1].offset;
|
||||
|
||||
sections.push_back({ sectionIndex, sectionOffset + line.offset, lines.size() });
|
||||
lines.push_back({ line.linenumStart, 0, filenameIndex });
|
||||
}
|
||||
|
||||
// calc code size of last line
|
||||
lines.back().codeSize = lineSection->linesHeader.codeSize - blocklines[linesBlockHeader->numLines-1].offset;
|
||||
|
||||
// columns are optional
|
||||
if (blockColumns == nullptr)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
for (uint32_t i = 0, size = linesBlockHeader->numLines; i < size; ++i)
|
||||
{
|
||||
const PDB::CodeView::DBI::Column& column = blockColumns[i];
|
||||
(void)column;
|
||||
}
|
||||
});
|
||||
}
|
||||
else if (lineSection->header.kind == PDB::CodeView::DBI::DebugSubsectionKind::S_FILECHECKSUMS)
|
||||
{
|
||||
// how to read checksums and their filenames from the Names Stream
|
||||
moduleLineStream.ForEachFileChecksum(lineSection, [&namesStream](const PDB::CodeView::DBI::FileChecksumHeader* fileChecksumHeader)
|
||||
{
|
||||
const char* filename = namesStream.GetFilename(fileChecksumHeader->filenameOffset);
|
||||
(void)filename;
|
||||
});
|
||||
|
||||
// store the checksum header for the module, as there might be more lines after the checksums.
|
||||
// so lines will get their checksum header values assigned after processing all line sections in the module.
|
||||
PDB_ASSERT(moduleFileChecksumHeader == nullptr, "Module File Checksum Header already set");
|
||||
moduleFileChecksumHeader = &lineSection->checksumHeader;
|
||||
}
|
||||
else if (lineSection->header.kind == PDB::CodeView::DBI::DebugSubsectionKind::S_INLINEELINES)
|
||||
{
|
||||
if (lineSection->inlineeHeader.kind == PDB::CodeView::DBI::InlineeSourceLineKind::Signature)
|
||||
{
|
||||
moduleLineStream.ForEachInlineeSourceLine(lineSection, [](const PDB::CodeView::DBI::InlineeSourceLine* inlineeSourceLine)
|
||||
{
|
||||
(void)inlineeSourceLine;
|
||||
|
||||
});
|
||||
}
|
||||
else
|
||||
{
|
||||
moduleLineStream.ForEachInlineeSourceLineEx(lineSection, [](const PDB::CodeView::DBI::InlineeSourceLineEx* inlineeSourceLineEx)
|
||||
{
|
||||
for (uint32_t i = 0; i < inlineeSourceLineEx->extraLines; ++i)
|
||||
{
|
||||
const uint32_t checksumOffset = inlineeSourceLineEx->extrafileChecksumOffsets[i];
|
||||
(void)checksumOffset;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
PDB_ASSERT(false, "Line Section kind 0x%X not handled", static_cast<uint32_t>(lineSection->header.kind));
|
||||
}
|
||||
});
|
||||
|
||||
// assign checksum values for each filename added in this module
|
||||
for (size_t i = moduleFilenamesStartIndex, size = filenames.size(); i < size; ++i)
|
||||
{
|
||||
Filename& filename = filenames[i];
|
||||
|
||||
// look up the filename's checksum header in the module's checksums section
|
||||
const PDB::CodeView::DBI::FileChecksumHeader* checksumHeader = PDB::Pointer::Offset<const PDB::CodeView::DBI::FileChecksumHeader*>(moduleFileChecksumHeader, filename.fileChecksumOffset);
|
||||
|
||||
PDB_ASSERT(checksumHeader->checksumKind >= PDB::CodeView::DBI::ChecksumKind::None &&
|
||||
checksumHeader->checksumKind <= PDB::CodeView::DBI::ChecksumKind::SHA256,
|
||||
"Invalid checksum kind %u", static_cast<uint16_t>(checksumHeader->checksumKind));
|
||||
|
||||
// store checksum values in filname struct
|
||||
filename.namesFilenameOffset = checksumHeader->filenameOffset;
|
||||
filename.checksumKind = checksumHeader->checksumKind;
|
||||
filename.checksumSize = checksumHeader->checksumSize;
|
||||
std::memcpy(filename.checksum, checksumHeader->checksum, checksumHeader->checksumSize);
|
||||
}
|
||||
}
|
||||
|
||||
scope.Done(modules.GetLength());
|
||||
|
||||
TimedScope sortScope("std::sort sections");
|
||||
|
||||
// sort sections, so we can iterate over lines by address order.
|
||||
std::sort(sections.begin(), sections.end(), [](const Section& lhs, const Section& rhs)
|
||||
{
|
||||
if (lhs.index == rhs.index)
|
||||
{
|
||||
return lhs.offset < rhs.offset;
|
||||
}
|
||||
|
||||
return lhs.index < rhs.index;
|
||||
});
|
||||
|
||||
sortScope.Done(sections.size());
|
||||
|
||||
// Disabled by default, as it will print a lot of lines for large PDBs :-)
|
||||
#if 0
|
||||
// DIA2Dump style lines output
|
||||
static const char hexChars[17] = "0123456789ABCDEF";
|
||||
char checksumString[128];
|
||||
|
||||
printf("*** LINES RAW PDB\n");
|
||||
|
||||
const char* prevFilename = nullptr;
|
||||
|
||||
for (const Section& section : sections)
|
||||
{
|
||||
const Line& line = lines[section.lineIndex];
|
||||
const Filename& lineFilename = filenames[line.filenameIndex];
|
||||
|
||||
const char* filename = namesStream.GetFilename(lineFilename.namesFilenameOffset);
|
||||
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(section.index, section.offset);
|
||||
|
||||
// only print filename for a line if it is different from the previous one.
|
||||
if (filename != prevFilename)
|
||||
{
|
||||
for (size_t i = 0, j = 0; i < lineFilename.checksumSize; i++, j+=2)
|
||||
{
|
||||
checksumString[j] = hexChars[lineFilename.checksum[i] >> 4];
|
||||
checksumString[j+1] = hexChars[lineFilename.checksum[i] & 0xF];
|
||||
}
|
||||
|
||||
checksumString[lineFilename.checksumSize * 2] = '\0';
|
||||
|
||||
printf(" line %u at [0x%08X][0x%04X:0x%08X], len = 0x%X %s (0x%02X: %s)\n",
|
||||
line.lineNumber, rva, section.index, section.offset, line.codeSize,
|
||||
filename, static_cast<uint32_t>(lineFilename.checksumKind), checksumString);
|
||||
|
||||
prevFilename = filename;
|
||||
}
|
||||
else
|
||||
{
|
||||
printf(" line %u at [0x%08X][0x%04X:0x%08X], len = 0x%X\n",
|
||||
line.lineNumber, rva, section.index, section.offset, line.codeSize);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
}
|
||||
200
third_party/raw_pdb/src/Examples/ExampleMain.cpp
vendored
Normal file
200
third_party/raw_pdb/src/Examples/ExampleMain.cpp
vendored
Normal file
@@ -0,0 +1,200 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleMemoryMappedFile.h"
|
||||
#include "PDB.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_InfoStream.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
#include "PDB_TPIStream.h"
|
||||
#include "PDB_IPIStream.h"
|
||||
#include "PDB_NamesStream.h"
|
||||
|
||||
namespace
|
||||
{
|
||||
PDB_NO_DISCARD static bool IsError(PDB::ErrorCode errorCode)
|
||||
{
|
||||
switch (errorCode)
|
||||
{
|
||||
case PDB::ErrorCode::Success:
|
||||
return false;
|
||||
|
||||
case PDB::ErrorCode::InvalidSuperBlock:
|
||||
printf("Invalid Superblock\n");
|
||||
return true;
|
||||
|
||||
case PDB::ErrorCode::InvalidFreeBlockMap:
|
||||
printf("Invalid free block map\n");
|
||||
return true;
|
||||
|
||||
case PDB::ErrorCode::InvalidStream:
|
||||
printf("Invalid stream\n");
|
||||
return true;
|
||||
|
||||
case PDB::ErrorCode::InvalidSignature:
|
||||
printf("Invalid stream signature\n");
|
||||
return true;
|
||||
|
||||
case PDB::ErrorCode::InvalidStreamIndex:
|
||||
printf("Invalid stream index\n");
|
||||
return true;
|
||||
|
||||
case PDB::ErrorCode::InvalidDataSize:
|
||||
printf("Invalid data size\n");
|
||||
return true;
|
||||
|
||||
case PDB::ErrorCode::UnknownVersion:
|
||||
printf("Unknown version\n");
|
||||
return true;
|
||||
}
|
||||
|
||||
// only ErrorCode::Success means there wasn't an error, so all other paths have to assume there was an error
|
||||
return true;
|
||||
}
|
||||
|
||||
PDB_NO_DISCARD static bool HasValidDBIStreams(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream)
|
||||
{
|
||||
// check whether the DBI stream offers all sub-streams we need
|
||||
if (IsError(dbiStream.HasValidSymbolRecordStream(rawPdbFile)))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (IsError(dbiStream.HasValidPublicSymbolStream(rawPdbFile)))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (IsError(dbiStream.HasValidGlobalSymbolStream(rawPdbFile)))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (IsError(dbiStream.HasValidSectionContributionStream(rawPdbFile)))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (IsError(dbiStream.HasValidImageSectionStream(rawPdbFile)))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// declare all examples
|
||||
extern void ExamplePDBSize(const PDB::RawFile&, const PDB::DBIStream&);
|
||||
extern void ExampleTPISize(const PDB::TPIStream& tpiStream, const char* outPath);
|
||||
extern void ExampleContributions(const PDB::RawFile&, const PDB::DBIStream&);
|
||||
extern void ExampleSymbols(const PDB::RawFile&, const PDB::DBIStream&);
|
||||
extern void ExampleFunctionSymbols(const PDB::RawFile&, const PDB::DBIStream&);
|
||||
extern void ExampleFunctionVariables(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream, const PDB::TPIStream&);
|
||||
extern void ExampleLines(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream, const PDB::InfoStream& infoStream);
|
||||
extern void ExampleTypes(const PDB::TPIStream&);
|
||||
extern void ExampleIPI(const PDB::RawFile& rawPdbFile, const PDB::InfoStream& infoStream, const PDB::TPIStream& tpiStream, const PDB::IPIStream& ipiStream);
|
||||
|
||||
int main(int argc, char** argv)
|
||||
{
|
||||
if (argc != 2)
|
||||
{
|
||||
printf("Usage: Examples <PDB path>\nError: Incorrect usage\n");
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
printf("Opening PDB file %s\n", argv[1]);
|
||||
|
||||
// try to open the PDB file and check whether all the data we need is available
|
||||
MemoryMappedFile::Handle pdbFile = MemoryMappedFile::Open(argv[1]);
|
||||
if (!pdbFile.baseAddress)
|
||||
{
|
||||
printf("Cannot memory-map file %s\n", argv[1]);
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
if (IsError(PDB::ValidateFile(pdbFile.baseAddress, pdbFile.len)))
|
||||
{
|
||||
MemoryMappedFile::Close(pdbFile);
|
||||
|
||||
return 2;
|
||||
}
|
||||
|
||||
const PDB::RawFile rawPdbFile = PDB::CreateRawFile(pdbFile.baseAddress);
|
||||
if (IsError(PDB::HasValidDBIStream(rawPdbFile)))
|
||||
{
|
||||
MemoryMappedFile::Close(pdbFile);
|
||||
|
||||
return 3;
|
||||
}
|
||||
|
||||
const PDB::InfoStream infoStream(rawPdbFile);
|
||||
if (infoStream.UsesDebugFastLink())
|
||||
{
|
||||
printf("PDB was linked using unsupported option /DEBUG:FASTLINK\n");
|
||||
|
||||
MemoryMappedFile::Close(pdbFile);
|
||||
|
||||
return 4;
|
||||
}
|
||||
|
||||
const auto h = infoStream.GetHeader();
|
||||
printf("Version %u, signature %u, age %u, GUID %08x-%04x-%04x-%02x%02x%02x%02x%02x%02x%02x%02x\n",
|
||||
static_cast<uint32_t>(h->version), h->signature, h->age,
|
||||
h->guid.Data1, h->guid.Data2, h->guid.Data3,
|
||||
h->guid.Data4[0], h->guid.Data4[1], h->guid.Data4[2], h->guid.Data4[3], h->guid.Data4[4], h->guid.Data4[5], h->guid.Data4[6], h->guid.Data4[7]);
|
||||
|
||||
const PDB::DBIStream dbiStream = PDB::CreateDBIStream(rawPdbFile);
|
||||
if (!HasValidDBIStreams(rawPdbFile, dbiStream))
|
||||
{
|
||||
MemoryMappedFile::Close(pdbFile);
|
||||
|
||||
return 5;
|
||||
}
|
||||
|
||||
if (IsError(PDB::HasValidTPIStream(rawPdbFile)))
|
||||
{
|
||||
MemoryMappedFile::Close(pdbFile);
|
||||
|
||||
return 5;
|
||||
}
|
||||
const PDB::TPIStream tpiStream = PDB::CreateTPIStream(rawPdbFile);
|
||||
|
||||
PDB::IPIStream ipiStream;
|
||||
|
||||
// It's perfectly possible that an old PDB does not have an IPI stream.
|
||||
if(infoStream.HasIPIStream())
|
||||
{
|
||||
PDB::ErrorCode error = PDB::HasValidIPIStream(rawPdbFile);
|
||||
|
||||
if (error != PDB::ErrorCode::InvalidStream && IsError(error))
|
||||
{
|
||||
MemoryMappedFile::Close(pdbFile);
|
||||
|
||||
return 5;
|
||||
}
|
||||
|
||||
ipiStream = PDB::CreateIPIStream(rawPdbFile);
|
||||
}
|
||||
|
||||
|
||||
// run all examples
|
||||
ExamplePDBSize(rawPdbFile, dbiStream);
|
||||
ExampleContributions(rawPdbFile, dbiStream);
|
||||
ExampleSymbols(rawPdbFile, dbiStream);
|
||||
ExampleFunctionSymbols(rawPdbFile, dbiStream);
|
||||
ExampleFunctionVariables(rawPdbFile, dbiStream, tpiStream);
|
||||
ExampleLines(rawPdbFile, dbiStream, infoStream);
|
||||
ExampleTypes(tpiStream);
|
||||
ExampleIPI(rawPdbFile, infoStream, tpiStream, ipiStream);
|
||||
// uncomment to dump type sizes to a CSV
|
||||
// ExampleTPISize(tpiStream, "output.csv");
|
||||
|
||||
MemoryMappedFile::Close(pdbFile);
|
||||
|
||||
return 0;
|
||||
}
|
||||
100
third_party/raw_pdb/src/Examples/ExampleMemoryMappedFile.cpp
vendored
Normal file
100
third_party/raw_pdb/src/Examples/ExampleMemoryMappedFile.cpp
vendored
Normal file
@@ -0,0 +1,100 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleMemoryMappedFile.h"
|
||||
|
||||
|
||||
MemoryMappedFile::Handle MemoryMappedFile::Open(const char* path)
|
||||
{
|
||||
#ifdef _WIN32
|
||||
void* file = CreateFileA(path, GENERIC_READ, FILE_SHARE_READ, nullptr, OPEN_EXISTING, FILE_ATTRIBUTE_READONLY, nullptr);
|
||||
|
||||
if (file == INVALID_HANDLE_VALUE)
|
||||
{
|
||||
return Handle { INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE, nullptr, 0 };
|
||||
}
|
||||
|
||||
void* fileMapping = CreateFileMappingW(file, nullptr, PAGE_READONLY, 0, 0, nullptr);
|
||||
|
||||
if (fileMapping == nullptr)
|
||||
{
|
||||
CloseHandle(file);
|
||||
|
||||
return Handle { INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE, nullptr, 0 };
|
||||
}
|
||||
|
||||
void* baseAddress = MapViewOfFile(fileMapping, FILE_MAP_READ, 0, 0, 0);
|
||||
|
||||
if (baseAddress == nullptr)
|
||||
{
|
||||
CloseHandle(fileMapping);
|
||||
CloseHandle(file);
|
||||
|
||||
return Handle { INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE, nullptr, 0 };
|
||||
}
|
||||
|
||||
BY_HANDLE_FILE_INFORMATION fileInformation;
|
||||
const bool getInformationResult = GetFileInformationByHandle(file, &fileInformation);
|
||||
if (!getInformationResult)
|
||||
{
|
||||
UnmapViewOfFile(baseAddress);
|
||||
CloseHandle(fileMapping);
|
||||
CloseHandle(file);
|
||||
|
||||
return Handle { INVALID_HANDLE_VALUE, INVALID_HANDLE_VALUE, nullptr, 0 };
|
||||
}
|
||||
|
||||
const size_t fileSizeHighBytes = static_cast<size_t>(fileInformation.nFileSizeHigh) << 32;
|
||||
const size_t fileSizeLowBytes = fileInformation.nFileSizeLow;
|
||||
const size_t fileSize = fileSizeHighBytes | fileSizeLowBytes;
|
||||
return Handle { file, fileMapping, baseAddress, fileSize };
|
||||
#else
|
||||
struct stat fileSb;
|
||||
|
||||
int file = open(path, O_RDONLY);
|
||||
|
||||
if (file == INVALID_HANDLE_VALUE)
|
||||
{
|
||||
return Handle { INVALID_HANDLE_VALUE, nullptr, 0 };
|
||||
}
|
||||
|
||||
if (fstat(file, &fileSb) == -1)
|
||||
{
|
||||
close(file);
|
||||
|
||||
return Handle { INVALID_HANDLE_VALUE, nullptr, 0 };
|
||||
}
|
||||
|
||||
void* baseAddress = mmap(nullptr, fileSb.st_size, PROT_READ, MAP_PRIVATE, file, 0);
|
||||
|
||||
if (baseAddress == MAP_FAILED)
|
||||
{
|
||||
close(file);
|
||||
|
||||
return Handle { INVALID_HANDLE_VALUE, nullptr, 0 };
|
||||
}
|
||||
|
||||
return Handle { file, baseAddress, static_cast<size_t>(fileSb.st_size) };
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
void MemoryMappedFile::Close(Handle& handle)
|
||||
{
|
||||
#ifdef _WIN32
|
||||
UnmapViewOfFile(handle.baseAddress);
|
||||
CloseHandle(handle.fileMapping);
|
||||
CloseHandle(handle.file);
|
||||
|
||||
handle.file = nullptr;
|
||||
handle.fileMapping = nullptr;
|
||||
#else
|
||||
munmap(handle.baseAddress, handle.len);
|
||||
close(handle.file);
|
||||
|
||||
handle.file = 0;
|
||||
#endif
|
||||
|
||||
handle.baseAddress = nullptr;
|
||||
}
|
||||
29
third_party/raw_pdb/src/Examples/ExampleMemoryMappedFile.h
vendored
Normal file
29
third_party/raw_pdb/src/Examples/ExampleMemoryMappedFile.h
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#ifndef _WIN32
|
||||
#include <sys/mman.h>
|
||||
#include <sys/stat.h>
|
||||
#include <fcntl.h>
|
||||
#include <unistd.h>
|
||||
|
||||
#define INVALID_HANDLE_VALUE ((long)-1)
|
||||
#endif
|
||||
|
||||
namespace MemoryMappedFile
|
||||
{
|
||||
struct Handle
|
||||
{
|
||||
#ifdef _WIN32
|
||||
void* file;
|
||||
void* fileMapping;
|
||||
#else
|
||||
int file;
|
||||
#endif
|
||||
void* baseAddress;
|
||||
size_t len;
|
||||
};
|
||||
|
||||
Handle Open(const char* path);
|
||||
void Close(Handle& handle);
|
||||
}
|
||||
124
third_party/raw_pdb/src/Examples/ExamplePDBSize.cpp
vendored
Normal file
124
third_party/raw_pdb/src/Examples/ExamplePDBSize.cpp
vendored
Normal file
@@ -0,0 +1,124 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
|
||||
|
||||
namespace
|
||||
{
|
||||
struct Stream
|
||||
{
|
||||
std::string name;
|
||||
uint32_t size;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
void ExamplePDBSize(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream);
|
||||
void ExamplePDBSize(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream)
|
||||
{
|
||||
TimedScope total("\nRunning example \"PDBSize\"");
|
||||
|
||||
std::vector<Stream> streams;
|
||||
|
||||
// print show general statistics
|
||||
printf("General\n");
|
||||
printf("-------\n");
|
||||
{
|
||||
const PDB::SuperBlock* superBlock = rawPdbFile.GetSuperBlock();
|
||||
printf("PDB page size (block size): %u\n", superBlock->blockSize);
|
||||
printf("PDB block count: %u\n", superBlock->blockCount);
|
||||
|
||||
const size_t rawSize = static_cast<size_t>(superBlock->blockSize) * static_cast<size_t>(superBlock->blockCount);
|
||||
printf("PDB raw size: %zu MiB (%zu GiB)\n", rawSize >> 20u, rawSize >> 30u);
|
||||
}
|
||||
|
||||
// print the sizes of all known streams
|
||||
printf("\n");
|
||||
printf("Sizes of known streams\n");
|
||||
printf("----------------------\n");
|
||||
{
|
||||
const uint32_t streamCount = rawPdbFile.GetStreamCount();
|
||||
const uint32_t tpiStreamSize = (streamCount > 2u) ? rawPdbFile.GetStreamSize(2u) : 0u;
|
||||
const uint32_t dbiStreamSize = (streamCount > 3u) ? rawPdbFile.GetStreamSize(3u) : 0u;
|
||||
const uint32_t ipiStreamSize = (streamCount > 4u) ? rawPdbFile.GetStreamSize(4u) : 0u;
|
||||
|
||||
printf("TPI stream size: %u KiB (%u MiB)\n", tpiStreamSize >> 10u, tpiStreamSize >> 20u);
|
||||
printf("DBI stream size: %u KiB (%u MiB)\n", dbiStreamSize >> 10u, dbiStreamSize >> 20u);
|
||||
printf("IPI stream size: %u KiB (%u MiB)\n", ipiStreamSize >> 10u, ipiStreamSize >> 20u);
|
||||
|
||||
streams.push_back(Stream { "TPI", tpiStreamSize });
|
||||
streams.push_back(Stream { "DBI", dbiStreamSize });
|
||||
streams.push_back(Stream { "IPI", ipiStreamSize });
|
||||
|
||||
const uint32_t globalSymbolStreamSize = rawPdbFile.GetStreamSize(dbiStream.GetHeader().globalStreamIndex);
|
||||
const uint32_t publicSymbolStreamSize = rawPdbFile.GetStreamSize(dbiStream.GetHeader().publicStreamIndex);
|
||||
const uint32_t symbolRecordStreamSize = rawPdbFile.GetStreamSize(dbiStream.GetHeader().symbolRecordStreamIndex);
|
||||
|
||||
printf("Global symbol stream size: %u KiB (%u MiB)\n", globalSymbolStreamSize >> 10u, globalSymbolStreamSize >> 20u);
|
||||
printf("Public symbol stream size: %u KiB (%u MiB)\n", publicSymbolStreamSize >> 10u, publicSymbolStreamSize >> 20u);
|
||||
printf("Symbol record stream size: %u KiB (%u MiB)\n", symbolRecordStreamSize >> 10u, symbolRecordStreamSize >> 20u);
|
||||
|
||||
streams.emplace_back(Stream { "Global", globalSymbolStreamSize });
|
||||
streams.emplace_back(Stream { "Public", publicSymbolStreamSize });
|
||||
streams.emplace_back(Stream { "Symbol", symbolRecordStreamSize });
|
||||
}
|
||||
|
||||
// print the sizes of all module streams
|
||||
printf("\n");
|
||||
printf("Sizes of module streams\n");
|
||||
printf("-----------------------\n");
|
||||
{
|
||||
const PDB::ModuleInfoStream moduleInfoStream = dbiStream.CreateModuleInfoStream(rawPdbFile);
|
||||
const PDB::ArrayView<PDB::ModuleInfoStream::Module> modules = moduleInfoStream.GetModules();
|
||||
|
||||
for (const PDB::ModuleInfoStream::Module& module : modules)
|
||||
{
|
||||
const PDB::DBI::ModuleInfo* moduleInfo = module.GetInfo();
|
||||
const char* name = module.GetName().Decay();
|
||||
const char* objectName = module.GetObjectName().Decay();
|
||||
|
||||
const uint16_t streamIndex = module.HasSymbolStream() ? moduleInfo->moduleSymbolStreamIndex : 0u;
|
||||
const uint32_t moduleStreamSize = (streamIndex != 0u) ? rawPdbFile.GetStreamSize(streamIndex) : 0u;
|
||||
|
||||
printf("Module %s (%s) stream size: %u KiB (%u MiB)\n", name, objectName, moduleStreamSize >> 10u, moduleStreamSize >> 20u);
|
||||
|
||||
streams.push_back(Stream { name, moduleStreamSize });
|
||||
}
|
||||
}
|
||||
|
||||
// sort the streams by their size
|
||||
std::sort(streams.begin(), streams.end(), [](const Stream& lhs, const Stream& rhs)
|
||||
{
|
||||
return lhs.size > rhs.size;
|
||||
});
|
||||
|
||||
// log the 20 largest stream
|
||||
{
|
||||
printf("\n");
|
||||
printf("Sizes of 20 largest streams:\n");
|
||||
|
||||
const size_t countToShow = std::min<size_t>(20ul, streams.size());
|
||||
for (size_t i = 0u; i < countToShow; ++i)
|
||||
{
|
||||
const Stream& stream = streams[i];
|
||||
printf("%zu: %u KiB (%u MiB) from stream %s\n", i + 1u, stream.size >> 10u, stream.size >> 20u, stream.name.c_str());
|
||||
}
|
||||
}
|
||||
|
||||
// print the raw stream sizes
|
||||
printf("\n");
|
||||
printf("Raw sizes of all streams\n");
|
||||
printf("------------------------\n");
|
||||
{
|
||||
const uint32_t streamCount = rawPdbFile.GetStreamCount();
|
||||
for (uint32_t i = 0u; i < streamCount; ++i)
|
||||
{
|
||||
const uint32_t streamSize = rawPdbFile.GetStreamSize(i);
|
||||
printf("Stream %u size: %u KiB (%u MiB)\n", i, streamSize >> 10u, streamSize >> 20u);
|
||||
}
|
||||
}
|
||||
}
|
||||
238
third_party/raw_pdb/src/Examples/ExampleSymbols.cpp
vendored
Normal file
238
third_party/raw_pdb/src/Examples/ExampleSymbols.cpp
vendored
Normal file
@@ -0,0 +1,238 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
|
||||
|
||||
namespace
|
||||
{
|
||||
// we don't have to store std::string in the symbols, since all the data is memory-mapped anyway.
|
||||
// we do it in this example to ensure that we don't "cheat" when reading the PDB file. memory-mapped data will only
|
||||
// be faulted into the process once it's touched, so actually copying the string data makes us touch the needed data,
|
||||
// giving us a real performance measurement.
|
||||
struct Symbol
|
||||
{
|
||||
std::string name;
|
||||
uint32_t rva;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
void ExampleSymbols(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream);
|
||||
void ExampleSymbols(const PDB::RawFile& rawPdbFile, const PDB::DBIStream& dbiStream)
|
||||
{
|
||||
TimedScope total("\nRunning example \"Symbols\"");
|
||||
|
||||
// in order to keep the example easy to understand, we load the PDB data serially.
|
||||
// note that this can be improved a lot by reading streams concurrently.
|
||||
|
||||
// prepare the image section stream first. it is needed for converting section + offset into an RVA
|
||||
TimedScope sectionScope("Reading image section stream");
|
||||
const PDB::ImageSectionStream imageSectionStream = dbiStream.CreateImageSectionStream(rawPdbFile);
|
||||
sectionScope.Done();
|
||||
|
||||
|
||||
// prepare the module info stream for matching contributions against files
|
||||
TimedScope moduleScope("Reading module info stream");
|
||||
const PDB::ModuleInfoStream moduleInfoStream = dbiStream.CreateModuleInfoStream(rawPdbFile);
|
||||
moduleScope.Done();
|
||||
|
||||
|
||||
// prepare symbol record stream needed by both public and global streams
|
||||
TimedScope symbolStreamScope("Reading symbol record stream");
|
||||
const PDB::CoalescedMSFStream symbolRecordStream = dbiStream.CreateSymbolRecordStream(rawPdbFile);
|
||||
symbolStreamScope.Done();
|
||||
|
||||
std::vector<Symbol> symbols;
|
||||
|
||||
// read public symbols
|
||||
TimedScope publicScope("Reading public symbol stream");
|
||||
const PDB::PublicSymbolStream publicSymbolStream = dbiStream.CreatePublicSymbolStream(rawPdbFile);
|
||||
publicScope.Done();
|
||||
{
|
||||
TimedScope scope("Storing public symbols");
|
||||
|
||||
const PDB::ArrayView<PDB::HashRecord> hashRecords = publicSymbolStream.GetRecords();
|
||||
const size_t count = hashRecords.GetLength();
|
||||
|
||||
symbols.reserve(count);
|
||||
|
||||
for (const PDB::HashRecord& hashRecord : hashRecords)
|
||||
{
|
||||
const PDB::CodeView::DBI::Record* record = publicSymbolStream.GetRecord(symbolRecordStream, hashRecord);
|
||||
if (record->header.kind != PDB::CodeView::DBI::SymbolRecordKind::S_PUB32)
|
||||
{
|
||||
// normally, a PDB only contains S_PUB32 symbols in the public symbol stream, but we have seen PDBs that also store S_CONSTANT as public symbols.
|
||||
// ignore these.
|
||||
continue;
|
||||
}
|
||||
|
||||
const uint32_t rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_PUB32.section, record->data.S_PUB32.offset);
|
||||
if (rva == 0u)
|
||||
{
|
||||
// certain symbols (e.g. control-flow guard symbols) don't have a valid RVA, ignore those
|
||||
continue;
|
||||
}
|
||||
|
||||
symbols.push_back(Symbol { record->data.S_PUB32.name, rva });
|
||||
}
|
||||
|
||||
scope.Done(count);
|
||||
}
|
||||
|
||||
|
||||
// read global symbols
|
||||
TimedScope globalScope("Reading global symbol stream");
|
||||
const PDB::GlobalSymbolStream globalSymbolStream = dbiStream.CreateGlobalSymbolStream(rawPdbFile);
|
||||
globalScope.Done();
|
||||
{
|
||||
TimedScope scope("Storing global symbols");
|
||||
|
||||
const PDB::ArrayView<PDB::HashRecord> hashRecords = globalSymbolStream.GetRecords();
|
||||
const size_t count = hashRecords.GetLength();
|
||||
|
||||
symbols.reserve(symbols.size() + count);
|
||||
|
||||
for (const PDB::HashRecord& hashRecord : hashRecords)
|
||||
{
|
||||
const PDB::CodeView::DBI::Record* record = globalSymbolStream.GetRecord(symbolRecordStream, hashRecord);
|
||||
|
||||
const char* name = nullptr;
|
||||
uint32_t rva = 0u;
|
||||
if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_GDATA32)
|
||||
{
|
||||
name = record->data.S_GDATA32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_GDATA32.section, record->data.S_GDATA32.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_GTHREAD32)
|
||||
{
|
||||
name = record->data.S_GTHREAD32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_GTHREAD32.section, record->data.S_GTHREAD32.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LDATA32)
|
||||
{
|
||||
name = record->data.S_LDATA32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LDATA32.section, record->data.S_LDATA32.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LTHREAD32)
|
||||
{
|
||||
name = record->data.S_LTHREAD32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LTHREAD32.section, record->data.S_LTHREAD32.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_UDT)
|
||||
{
|
||||
name = record->data.S_UDT.name;
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_UDT_ST)
|
||||
{
|
||||
name = record->data.S_UDT_ST.name;
|
||||
}
|
||||
|
||||
if (rva == 0u)
|
||||
{
|
||||
// certain symbols (e.g. control-flow guard symbols) don't have a valid RVA, ignore those
|
||||
continue;
|
||||
}
|
||||
|
||||
symbols.push_back(Symbol { name, rva });
|
||||
}
|
||||
|
||||
scope.Done(count);
|
||||
}
|
||||
|
||||
|
||||
// read module symbols
|
||||
{
|
||||
TimedScope scope("Storing symbols from modules");
|
||||
|
||||
const PDB::ArrayView<PDB::ModuleInfoStream::Module> modules = moduleInfoStream.GetModules();
|
||||
|
||||
for (const PDB::ModuleInfoStream::Module& module : modules)
|
||||
{
|
||||
if (!module.HasSymbolStream())
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
const PDB::ModuleSymbolStream moduleSymbolStream = module.CreateSymbolStream(rawPdbFile);
|
||||
moduleSymbolStream.ForEachSymbol([&symbols, &imageSectionStream](const PDB::CodeView::DBI::Record* record)
|
||||
{
|
||||
const char* name = nullptr;
|
||||
uint32_t rva = 0u;
|
||||
if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_THUNK32)
|
||||
{
|
||||
if (record->data.S_THUNK32.thunk == PDB::CodeView::DBI::ThunkOrdinal::TrampolineIncremental)
|
||||
{
|
||||
// we have never seen incremental linking thunks stored inside a S_THUNK32 symbol, but better be safe than sorry
|
||||
name = "ILT";
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_THUNK32.section, record->data.S_THUNK32.offset);
|
||||
}
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_TRAMPOLINE)
|
||||
{
|
||||
// incremental linking thunks are stored in the linker module
|
||||
name = "ILT";
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_TRAMPOLINE.thunkSection, record->data.S_TRAMPOLINE.thunkOffset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_BLOCK32)
|
||||
{
|
||||
// blocks never store a name and are only stored for indicating whether other symbols are children of this block
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LABEL32)
|
||||
{
|
||||
// labels don't have a name
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LPROC32)
|
||||
{
|
||||
name = record->data.S_LPROC32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LPROC32.section, record->data.S_LPROC32.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_GPROC32)
|
||||
{
|
||||
name = record->data.S_GPROC32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_GPROC32.section, record->data.S_GPROC32.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LPROC32_ID)
|
||||
{
|
||||
name = record->data.S_LPROC32_ID.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LPROC32_ID.section, record->data.S_LPROC32_ID.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_GPROC32_ID)
|
||||
{
|
||||
name = record->data.S_GPROC32_ID.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_GPROC32_ID.section, record->data.S_GPROC32_ID.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_REGREL32)
|
||||
{
|
||||
name = record->data.S_REGREL32.name;
|
||||
// You can only get the address while running the program by checking the register value and adding the offset
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LDATA32)
|
||||
{
|
||||
name = record->data.S_LDATA32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LDATA32.section, record->data.S_LDATA32.offset);
|
||||
}
|
||||
else if (record->header.kind == PDB::CodeView::DBI::SymbolRecordKind::S_LTHREAD32)
|
||||
{
|
||||
name = record->data.S_LTHREAD32.name;
|
||||
rva = imageSectionStream.ConvertSectionOffsetToRVA(record->data.S_LTHREAD32.section, record->data.S_LTHREAD32.offset);
|
||||
}
|
||||
|
||||
if (rva == 0u)
|
||||
{
|
||||
// certain symbols (e.g. control-flow guard symbols) don't have a valid RVA, ignore those
|
||||
return;
|
||||
}
|
||||
|
||||
symbols.push_back(Symbol { name, rva });
|
||||
});
|
||||
}
|
||||
|
||||
scope.Done(modules.GetLength());
|
||||
}
|
||||
|
||||
total.Done(symbols.size());
|
||||
}
|
||||
54
third_party/raw_pdb/src/Examples/ExampleTimedScope.cpp
vendored
Normal file
54
third_party/raw_pdb/src/Examples/ExampleTimedScope.cpp
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTimedScope.h"
|
||||
|
||||
namespace
|
||||
{
|
||||
static unsigned int g_indent = 0u;
|
||||
|
||||
static void PrintIndent(void)
|
||||
{
|
||||
printf("%.*s", g_indent * 2u, "| | | | | | | | ");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
TimedScope::TimedScope(const char* message)
|
||||
: m_begin(std::chrono::high_resolution_clock::now())
|
||||
{
|
||||
PrintIndent();
|
||||
++g_indent;
|
||||
|
||||
printf("%s\n", message);
|
||||
}
|
||||
|
||||
|
||||
void TimedScope::Done(void) const
|
||||
{
|
||||
--g_indent;
|
||||
PrintIndent();
|
||||
|
||||
const double milliSeconds = ReadMilliseconds();
|
||||
printf("---> done in %.3fms\n", milliSeconds);
|
||||
}
|
||||
|
||||
|
||||
void TimedScope::Done(size_t count) const
|
||||
{
|
||||
--g_indent;
|
||||
PrintIndent();
|
||||
|
||||
const double milliSeconds = ReadMilliseconds();
|
||||
printf("---> done in %.3fms (%zu elements)\n", milliSeconds, count);
|
||||
}
|
||||
|
||||
|
||||
double TimedScope::ReadMilliseconds(void) const
|
||||
{
|
||||
const std::chrono::high_resolution_clock::time_point now = std::chrono::high_resolution_clock::now();
|
||||
const std::chrono::duration<double> seconds = now - m_begin;
|
||||
|
||||
return seconds.count() * 1000.0;
|
||||
}
|
||||
22
third_party/raw_pdb/src/Examples/ExampleTimedScope.h
vendored
Normal file
22
third_party/raw_pdb/src/Examples/ExampleTimedScope.h
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Foundation/PDB_Macros.h"
|
||||
#include <chrono>
|
||||
|
||||
|
||||
class TimedScope
|
||||
{
|
||||
public:
|
||||
explicit TimedScope(const char* message);
|
||||
|
||||
void Done(void) const;
|
||||
void Done(size_t count) const;
|
||||
|
||||
private:
|
||||
double ReadMilliseconds(void) const;
|
||||
|
||||
const std::chrono::high_resolution_clock::time_point m_begin;
|
||||
|
||||
PDB_DISABLE_COPY_MOVE(TimedScope);
|
||||
};
|
||||
41
third_party/raw_pdb/src/Examples/ExampleTypeTable.cpp
vendored
Normal file
41
third_party/raw_pdb/src/Examples/ExampleTypeTable.cpp
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
#include "ExampleTypeTable.h"
|
||||
#include "Foundation/PDB_Memory.h"
|
||||
|
||||
TypeTable::TypeTable(const PDB::TPIStream& tpiStream) PDB_NO_EXCEPT
|
||||
: typeIndexBegin(tpiStream.GetFirstTypeIndex()), typeIndexEnd(tpiStream.GetLastTypeIndex()),
|
||||
m_recordCount(tpiStream.GetTypeRecordCount())
|
||||
{
|
||||
// Create coalesced stream from TPI stream, so the records can be referenced directly using pointers.
|
||||
const PDB::DirectMSFStream& directStream = tpiStream.GetDirectMSFStream();
|
||||
m_stream = PDB::CoalescedMSFStream(directStream, directStream.GetSize(), 0);
|
||||
|
||||
// types in the TPI stream are accessed by their index from other streams.
|
||||
// however, the index is not stored with types in the TPI stream directly, but has to be built while walking the stream.
|
||||
// similarly, because types are variable-length records, there are no direct offsets to access individual types.
|
||||
// we therefore walk the TPI stream once, and store pointers to the records for trivial O(1) array lookup by index later.
|
||||
m_records = PDB_NEW_ARRAY(const PDB::CodeView::TPI::Record*, m_recordCount);
|
||||
|
||||
// parse the CodeView records
|
||||
uint32_t typeIndex = 0u;
|
||||
|
||||
tpiStream.ForEachTypeRecordHeaderAndOffset([this, &typeIndex](const PDB::CodeView::TPI::RecordHeader& header, size_t offset)
|
||||
{
|
||||
// The header includes the record kind and size, which can be stored along with offset
|
||||
// to allow for lazy loading of the types on-demand directly from the TPIStream::GetDirectMSFStream()
|
||||
// using DirectMSFStream::ReadAtOffset(...). Thus not needing a CoalescedMSFStream to look up the types.
|
||||
(void)header;
|
||||
|
||||
const PDB::CodeView::TPI::Record* record = m_stream.GetDataAtOffset<const PDB::CodeView::TPI::Record>(offset);
|
||||
m_records[typeIndex] = record;
|
||||
++typeIndex;
|
||||
});
|
||||
}
|
||||
|
||||
TypeTable::~TypeTable() PDB_NO_EXCEPT
|
||||
{
|
||||
PDB_DELETE_ARRAY(m_records);
|
||||
}
|
||||
49
third_party/raw_pdb/src/Examples/ExampleTypeTable.h
vendored
Normal file
49
third_party/raw_pdb/src/Examples/ExampleTypeTable.h
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
#pragma once
|
||||
|
||||
#include "PDB_TPIStream.h"
|
||||
#include "PDB_CoalescedMSFStream.h"
|
||||
|
||||
class TypeTable
|
||||
{
|
||||
public:
|
||||
explicit TypeTable(const PDB::TPIStream& tpiStream) PDB_NO_EXCEPT;
|
||||
~TypeTable() PDB_NO_EXCEPT;
|
||||
|
||||
// Returns the index of the first type, which is not necessarily zero.
|
||||
PDB_NO_DISCARD inline uint32_t GetFirstTypeIndex(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return typeIndexBegin;
|
||||
}
|
||||
|
||||
// Returns the index of the last type.
|
||||
PDB_NO_DISCARD inline uint32_t GetLastTypeIndex(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return typeIndexEnd;
|
||||
}
|
||||
|
||||
PDB_NO_DISCARD inline const PDB::CodeView::TPI::Record* GetTypeRecord(uint32_t typeIndex) const PDB_NO_EXCEPT
|
||||
{
|
||||
if (typeIndex < typeIndexBegin || typeIndex > typeIndexEnd)
|
||||
return nullptr;
|
||||
|
||||
return m_records[typeIndex - typeIndexBegin];
|
||||
}
|
||||
|
||||
// Returns a view of all type records.
|
||||
// Records identified by a type index can be accessed via "allRecords[typeIndex - firstTypeIndex]".
|
||||
PDB_NO_DISCARD inline PDB::ArrayView<const PDB::CodeView::TPI::Record*> GetTypeRecords(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return PDB::ArrayView<const PDB::CodeView::TPI::Record*>(m_records, m_recordCount);
|
||||
}
|
||||
|
||||
private:
|
||||
uint32_t typeIndexBegin;
|
||||
uint32_t typeIndexEnd;
|
||||
|
||||
size_t m_recordCount;
|
||||
const PDB::CodeView::TPI::Record **m_records;
|
||||
|
||||
PDB::CoalescedMSFStream m_stream;
|
||||
|
||||
PDB_DISABLE_COPY(TypeTable);
|
||||
};
|
||||
1418
third_party/raw_pdb/src/Examples/ExampleTypes.cpp
vendored
Normal file
1418
third_party/raw_pdb/src/Examples/ExampleTypes.cpp
vendored
Normal file
File diff suppressed because it is too large
Load Diff
4
third_party/raw_pdb/src/Examples/Examples_PCH.cpp
vendored
Normal file
4
third_party/raw_pdb/src/Examples/Examples_PCH.cpp
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "Examples_PCH.h"
|
||||
53
third_party/raw_pdb/src/Examples/Examples_PCH.h
vendored
Normal file
53
third_party/raw_pdb/src/Examples/Examples_PCH.h
vendored
Normal file
@@ -0,0 +1,53 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Foundation/PDB_Warnings.h"
|
||||
|
||||
// The following clang warnings must be disabled for the examples to build with 0 warnings
|
||||
#if PDB_COMPILER_CLANG
|
||||
# pragma clang diagnostic ignored "-Wformat-nonliteral" // format string is not a string literal
|
||||
# pragma clang diagnostic ignored "-Wswitch-default" // switch' missing 'default' label
|
||||
# pragma clang diagnostic ignored "-Wcast-align" // increases required alignment from X to Y
|
||||
# pragma clang diagnostic ignored "-Wold-style-cast" // use of old-style cast
|
||||
#endif
|
||||
|
||||
#if PDB_COMPILER_MSVC
|
||||
# pragma warning(push, 0)
|
||||
#elif PDB_COMPILER_CLANG
|
||||
# pragma clang diagnostic push
|
||||
#endif
|
||||
|
||||
#if PDB_COMPILER_MSVC
|
||||
// we compile without exceptions
|
||||
# define _ALLOW_RTCc_IN_STL
|
||||
|
||||
// triggered by Windows.h
|
||||
# pragma warning (disable : 4668)
|
||||
|
||||
// triggered by xlocale in VS 2017
|
||||
# pragma warning (disable : 4625) // copy constructor was implicitly defined as deleted
|
||||
# pragma warning (disable : 4626) // assignment operator was implicitly defined as deleted
|
||||
# pragma warning (disable : 5026) // move constructor was implicitly defined as deleted
|
||||
# pragma warning (disable : 5027) // move assignment operator was implicitly defined as deleted
|
||||
# pragma warning (disable : 4774) // format string expected in argument 1 is not a string literal
|
||||
#endif
|
||||
|
||||
#ifdef _WIN32
|
||||
# define NOMINMAX
|
||||
# include <Windows.h>
|
||||
# undef cdecl
|
||||
#endif
|
||||
# include <vector>
|
||||
# include <unordered_set>
|
||||
# include <chrono>
|
||||
# include <string>
|
||||
# include <algorithm>
|
||||
# include <cstdarg>
|
||||
|
||||
#if PDB_COMPILER_MSVC
|
||||
# pragma warning(pop)
|
||||
#elif PDB_COMPILER_CLANG
|
||||
# pragma clang diagnostic pop
|
||||
#endif
|
||||
68
third_party/raw_pdb/src/Foundation/PDB_ArrayView.h
vendored
Normal file
68
third_party/raw_pdb/src/Foundation/PDB_ArrayView.h
vendored
Normal file
@@ -0,0 +1,68 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Macros.h"
|
||||
#include "PDB_Assert.h"
|
||||
|
||||
|
||||
namespace PDB
|
||||
{
|
||||
// A read-only view into arrays of any type and length.
|
||||
template <typename T>
|
||||
class PDB_NO_DISCARD ArrayView
|
||||
{
|
||||
public:
|
||||
// Constructs an array view from a C array with explicit length.
|
||||
inline constexpr explicit ArrayView(const T* const array, size_t length) PDB_NO_EXCEPT
|
||||
: m_data(array)
|
||||
, m_length(length)
|
||||
{
|
||||
}
|
||||
|
||||
PDB_DEFAULT_COPY_CONSTRUCTOR(ArrayView);
|
||||
PDB_DEFAULT_MOVE_CONSTRUCTOR(ArrayView);
|
||||
|
||||
// Provides read-only access to the underlying array.
|
||||
PDB_NO_DISCARD inline constexpr const T* Decay(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return m_data;
|
||||
}
|
||||
|
||||
// Returns the length of the view.
|
||||
PDB_NO_DISCARD inline constexpr size_t GetLength(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return m_length;
|
||||
}
|
||||
|
||||
// Returns the i-th element.
|
||||
PDB_NO_DISCARD inline const T& operator[](size_t i) const PDB_NO_EXCEPT
|
||||
{
|
||||
PDB_ASSERT(i < GetLength(), "Index %zu out of bounds [0, %zu).", i, GetLength());
|
||||
return m_data[i];
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// Range-based for-loop support
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
PDB_NO_DISCARD inline const T* begin(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return m_data;
|
||||
}
|
||||
|
||||
PDB_NO_DISCARD inline const T* end(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return m_data + m_length;
|
||||
}
|
||||
|
||||
private:
|
||||
const T* const m_data;
|
||||
const size_t m_length;
|
||||
|
||||
PDB_DISABLE_MOVE_ASSIGNMENT(ArrayView);
|
||||
PDB_DISABLE_COPY_ASSIGNMENT(ArrayView);
|
||||
};
|
||||
}
|
||||
31
third_party/raw_pdb/src/Foundation/PDB_Assert.h
vendored
Normal file
31
third_party/raw_pdb/src/Foundation/PDB_Assert.h
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Macros.h"
|
||||
#include "PDB_Log.h"
|
||||
|
||||
|
||||
PDB_PUSH_WARNING_CLANG
|
||||
PDB_DISABLE_WARNING_CLANG("-Wgnu-zero-variadic-macro-arguments")
|
||||
PDB_DISABLE_WARNING_CLANG("-Wreserved-identifier")
|
||||
|
||||
#if PDB_COMPILER_MSVC
|
||||
extern "C" void __cdecl __debugbreak(void);
|
||||
# pragma intrinsic(__debugbreak)
|
||||
#elif defined(__has_builtin) && __has_builtin(__builtin_debugtrap)
|
||||
# define __debugbreak() __builtin_debugtrap()
|
||||
#else
|
||||
# include <signal.h>
|
||||
# define __debugbreak() raise(SIGTRAP)
|
||||
#endif
|
||||
|
||||
|
||||
#ifdef _DEBUG
|
||||
# define PDB_ASSERT(_condition, _msg, ...) (_condition) ? (void)true : (PDB_LOG_ERROR(_msg, ##__VA_ARGS__), __debugbreak())
|
||||
#else
|
||||
# define PDB_ASSERT(_condition, _msg, ...) PDB_NOOP(_condition, _msg, ##__VA_ARGS__)
|
||||
#endif
|
||||
|
||||
PDB_POP_WARNING_CLANG
|
||||
23
third_party/raw_pdb/src/Foundation/PDB_BitOperators.h
vendored
Normal file
23
third_party/raw_pdb/src/Foundation/PDB_BitOperators.h
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Macros.h"
|
||||
|
||||
|
||||
#define PDB_DEFINE_BIT_OPERATORS(_type) \
|
||||
PDB_NO_DISCARD inline constexpr _type operator|(_type lhs, _type rhs) PDB_NO_EXCEPT \
|
||||
{ \
|
||||
return static_cast<_type>(PDB_AS_UNDERLYING(lhs) | PDB_AS_UNDERLYING(rhs)); \
|
||||
} \
|
||||
\
|
||||
PDB_NO_DISCARD inline constexpr _type operator&(_type lhs, _type rhs) PDB_NO_EXCEPT \
|
||||
{ \
|
||||
return static_cast<_type>(PDB_AS_UNDERLYING(lhs) & PDB_AS_UNDERLYING(rhs)); \
|
||||
} \
|
||||
\
|
||||
PDB_NO_DISCARD inline constexpr _type operator~(_type value) PDB_NO_EXCEPT \
|
||||
{ \
|
||||
return static_cast<_type>(~PDB_AS_UNDERLYING(value)); \
|
||||
}
|
||||
73
third_party/raw_pdb/src/Foundation/PDB_BitUtil.h
vendored
Normal file
73
third_party/raw_pdb/src/Foundation/PDB_BitUtil.h
vendored
Normal file
@@ -0,0 +1,73 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Assert.h"
|
||||
|
||||
#ifdef _WIN32
|
||||
PDB_PUSH_WARNING_CLANG
|
||||
PDB_DISABLE_WARNING_CLANG("-Wreserved-identifier")
|
||||
|
||||
extern "C" unsigned char _BitScanForward(unsigned long* _Index, unsigned long _Mask);
|
||||
|
||||
PDB_POP_WARNING_CLANG
|
||||
|
||||
# if PDB_COMPILER_MSVC
|
||||
# pragma intrinsic(_BitScanForward)
|
||||
# endif
|
||||
#endif
|
||||
|
||||
|
||||
namespace PDB
|
||||
{
|
||||
namespace BitUtil
|
||||
{
|
||||
// Returns whether the given unsigned value is a power of two.
|
||||
template <typename T>
|
||||
PDB_NO_DISCARD inline constexpr bool IsPowerOfTwo(T value) PDB_NO_EXCEPT
|
||||
{
|
||||
PDB_ASSERT(value != 0u, "Invalid value.");
|
||||
|
||||
return (value & (value - 1u)) == 0u;
|
||||
}
|
||||
|
||||
|
||||
// Rounds the given unsigned value up to the next multiple.
|
||||
template <typename T>
|
||||
PDB_NO_DISCARD inline constexpr T RoundUpToMultiple(T numToRound, T multipleOf) PDB_NO_EXCEPT
|
||||
{
|
||||
PDB_ASSERT(IsPowerOfTwo(multipleOf), "Multiple must be a power-of-two.");
|
||||
|
||||
return (numToRound + (multipleOf - 1u)) & ~(multipleOf - 1u);
|
||||
}
|
||||
|
||||
|
||||
// Finds the position of the first set bit in the given value starting from the LSB, e.g. FindFirstSetBit(0b00000010) == 1.
|
||||
// This operation is also known as CTZ (Count Trailing Zeros).
|
||||
template <typename T>
|
||||
PDB_NO_DISCARD inline uint32_t FindFirstSetBit(T value) PDB_NO_EXCEPT;
|
||||
|
||||
template <>
|
||||
PDB_NO_DISCARD inline uint32_t FindFirstSetBit(uint32_t value) PDB_NO_EXCEPT
|
||||
{
|
||||
PDB_ASSERT(value != 0u, "Invalid value.");
|
||||
|
||||
#ifdef _WIN32
|
||||
unsigned long result = 0ul;
|
||||
|
||||
_BitScanForward(&result, value);
|
||||
#else
|
||||
unsigned int result = 0u;
|
||||
|
||||
result = static_cast<unsigned int>(__builtin_ffs(static_cast<int>(value)));
|
||||
if (result)
|
||||
{
|
||||
--result;
|
||||
}
|
||||
#endif
|
||||
|
||||
return result;
|
||||
}
|
||||
}
|
||||
}
|
||||
10
third_party/raw_pdb/src/Foundation/PDB_CRT.h
vendored
Normal file
10
third_party/raw_pdb/src/Foundation/PDB_CRT.h
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
// Original raw_pdb forward-declares CRT functions to avoid pulling in headers,
|
||||
// but this conflicts with MinGW's headers when compiled alongside Qt.
|
||||
// Include the real headers instead.
|
||||
#include <cstdio>
|
||||
#include <cstring>
|
||||
9
third_party/raw_pdb/src/Foundation/PDB_Forward.h
vendored
Normal file
9
third_party/raw_pdb/src/Foundation/PDB_Forward.h
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
|
||||
// See Jonathan Mueller's blog for replacing std::move and std::forward:
|
||||
// https://foonathan.net/2021/09/move-forward/
|
||||
#define PDB_FORWARD(...) static_cast<decltype(__VA_ARGS__)&&>(__VA_ARGS__)
|
||||
15
third_party/raw_pdb/src/Foundation/PDB_Log.h
vendored
Normal file
15
third_party/raw_pdb/src/Foundation/PDB_Log.h
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Macros.h"
|
||||
#include "PDB_CRT.h"
|
||||
|
||||
|
||||
PDB_PUSH_WARNING_CLANG
|
||||
PDB_DISABLE_WARNING_CLANG("-Wgnu-zero-variadic-macro-arguments")
|
||||
|
||||
#define PDB_LOG_ERROR(_format, ...) printf(_format, ##__VA_ARGS__)
|
||||
|
||||
PDB_POP_WARNING_CLANG
|
||||
126
third_party/raw_pdb/src/Foundation/PDB_Macros.h
vendored
Normal file
126
third_party/raw_pdb/src/Foundation/PDB_Macros.h
vendored
Normal file
@@ -0,0 +1,126 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Platform.h"
|
||||
#include "PDB_TypeTraits.h"
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ATTRIBUTES
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
// Indicates to the compiler that the return value of a function or class should not be ignored.
|
||||
#if PDB_CPP_17
|
||||
# define PDB_NO_DISCARD [[nodiscard]]
|
||||
#else
|
||||
# define PDB_NO_DISCARD
|
||||
#endif
|
||||
|
||||
// Indicates to the compiler that a function does not throw an exception.
|
||||
#define PDB_NO_EXCEPT noexcept
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// SPECIAL MEMBER FUNCTIONS
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
// Default special member functions.
|
||||
#define PDB_DEFAULT_COPY_CONSTRUCTOR(_name) _name(const _name&) PDB_NO_EXCEPT = default
|
||||
#define PDB_DEFAULT_COPY_ASSIGNMENT(_name) _name& operator=(const _name&) PDB_NO_EXCEPT = default
|
||||
#define PDB_DEFAULT_MOVE_CONSTRUCTOR(_name) _name(_name&&) PDB_NO_EXCEPT = default
|
||||
#define PDB_DEFAULT_MOVE_ASSIGNMENT(_name) _name& operator=(_name&&) PDB_NO_EXCEPT = default
|
||||
|
||||
// Default copy member functions.
|
||||
#define PDB_DEFAULT_COPY(_name) PDB_DEFAULT_COPY_CONSTRUCTOR(_name); PDB_DEFAULT_COPY_ASSIGNMENT(_name)
|
||||
|
||||
// Default move member functions.
|
||||
#define PDB_DEFAULT_MOVE(_name) PDB_DEFAULT_MOVE_CONSTRUCTOR(_name); PDB_DEFAULT_MOVE_ASSIGNMENT(_name)
|
||||
|
||||
// Single macro to default all copy and move member functions.
|
||||
#define PDB_DEFAULT_COPY_MOVE(_name) PDB_DEFAULT_COPY(_name); PDB_DEFAULT_MOVE(_name)
|
||||
|
||||
// Disable special member functions.
|
||||
#define PDB_DISABLE_COPY_CONSTRUCTOR(_name) _name(const _name&) PDB_NO_EXCEPT = delete
|
||||
#define PDB_DISABLE_COPY_ASSIGNMENT(_name) _name& operator=(const _name&) PDB_NO_EXCEPT = delete
|
||||
#define PDB_DISABLE_MOVE_CONSTRUCTOR(_name) _name(_name&&) PDB_NO_EXCEPT = delete
|
||||
#define PDB_DISABLE_MOVE_ASSIGNMENT(_name) _name& operator=(_name&&) PDB_NO_EXCEPT = delete
|
||||
|
||||
// Disable copy member functions.
|
||||
#define PDB_DISABLE_COPY(_name) PDB_DISABLE_COPY_CONSTRUCTOR(_name); PDB_DISABLE_COPY_ASSIGNMENT(_name)
|
||||
|
||||
// Disable move member functions.
|
||||
#define PDB_DISABLE_MOVE(_name) PDB_DISABLE_MOVE_CONSTRUCTOR(_name); PDB_DISABLE_MOVE_ASSIGNMENT(_name)
|
||||
|
||||
// Single macro to disable all copy and move member functions.
|
||||
#define PDB_DISABLE_COPY_MOVE(_name) PDB_DISABLE_COPY(_name); PDB_DISABLE_MOVE(_name)
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// COMPILER WARNINGS
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
#if PDB_COMPILER_MSVC
|
||||
# define PDB_PRAGMA(_x) __pragma(_x)
|
||||
|
||||
# define PDB_PUSH_WARNING_MSVC PDB_PRAGMA(warning(push))
|
||||
# define PDB_SUPPRESS_WARNING_MSVC(_number) PDB_PRAGMA(warning(suppress : _number))
|
||||
# define PDB_DISABLE_WARNING_MSVC(_number) PDB_PRAGMA(warning(disable : _number))
|
||||
# define PDB_POP_WARNING_MSVC PDB_PRAGMA(warning(pop))
|
||||
|
||||
# define PDB_PUSH_WARNING_CLANG
|
||||
# define PDB_DISABLE_WARNING_CLANG(_diagnostic)
|
||||
# define PDB_POP_WARNING_CLANG
|
||||
#elif PDB_COMPILER_CLANG
|
||||
# define PDB_PRAGMA(_x) _Pragma(#_x)
|
||||
|
||||
# define PDB_PUSH_WARNING_MSVC
|
||||
# define PDB_SUPPRESS_WARNING_MSVC(_number)
|
||||
# define PDB_DISABLE_WARNING_MSVC(_number)
|
||||
# define PDB_POP_WARNING_MSVC
|
||||
|
||||
# define PDB_PUSH_WARNING_CLANG PDB_PRAGMA(clang diagnostic push)
|
||||
# define PDB_DISABLE_WARNING_CLANG(_diagnostic) PDB_PRAGMA(clang diagnostic ignored _diagnostic)
|
||||
# define PDB_POP_WARNING_CLANG PDB_PRAGMA(clang diagnostic pop)
|
||||
#elif PDB_COMPILER_GCC
|
||||
# define PDB_PRAGMA(_x) _Pragma(#_x)
|
||||
|
||||
# define PDB_PUSH_WARNING_MSVC
|
||||
# define PDB_SUPPRESS_WARNING_MSVC(_number)
|
||||
# define PDB_DISABLE_WARNING_MSVC(_number)
|
||||
# define PDB_POP_WARNING_MSVC
|
||||
|
||||
# define PDB_PUSH_WARNING_CLANG
|
||||
# define PDB_DISABLE_WARNING_CLANG(_diagnostic)
|
||||
# define PDB_POP_WARNING_CLANG
|
||||
#endif
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// MISCELLANEOUS
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
|
||||
// Trick to make other macros require a semicolon at the end.
|
||||
#define PDB_REQUIRE_SEMICOLON static_assert(true, "")
|
||||
|
||||
// Defines a C-like flexible array member.
|
||||
#define PDB_FLEXIBLE_ARRAY_MEMBER(_type, _name) \
|
||||
PDB_PUSH_WARNING_MSVC \
|
||||
PDB_PUSH_WARNING_CLANG \
|
||||
PDB_DISABLE_WARNING_MSVC(4200) \
|
||||
PDB_DISABLE_WARNING_CLANG("-Wzero-length-array") \
|
||||
_type _name[0]; \
|
||||
PDB_POP_WARNING_MSVC \
|
||||
PDB_POP_WARNING_CLANG \
|
||||
PDB_REQUIRE_SEMICOLON
|
||||
|
||||
// Casts any value to the value of the underlying type.
|
||||
#define PDB_AS_UNDERLYING(_value) static_cast<typename PDB::underlying_type<decltype(_value)>::type>(_value)
|
||||
|
||||
// Signals to the compiler that a function should be ignored, but have its argument list parsed (and "used", so as to not generate "unused variable" warnings).
|
||||
#if PDB_COMPILER_MSVC
|
||||
# define PDB_NOOP __noop
|
||||
#else
|
||||
# define PDB_NOOP(...) (void)sizeof(__VA_ARGS__)
|
||||
#endif
|
||||
11
third_party/raw_pdb/src/Foundation/PDB_Memory.h
vendored
Normal file
11
third_party/raw_pdb/src/Foundation/PDB_Memory.h
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
|
||||
#define PDB_NEW(_type) new _type
|
||||
#define PDB_NEW_ARRAY(_type, _length) new _type[_length]
|
||||
|
||||
#define PDB_DELETE(_ptr) delete _ptr
|
||||
#define PDB_DELETE_ARRAY(_ptr) delete[] _ptr
|
||||
11
third_party/raw_pdb/src/Foundation/PDB_Move.h
vendored
Normal file
11
third_party/raw_pdb/src/Foundation/PDB_Move.h
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_TypeTraits.h"
|
||||
|
||||
|
||||
// See Jonathan Mueller's blog for replacing std::move and std::forward:
|
||||
// https://foonathan.net/2020/09/move-forward/
|
||||
#define PDB_MOVE(...) static_cast<PDB::remove_reference<decltype(__VA_ARGS__)>::type&&>(__VA_ARGS__)
|
||||
45
third_party/raw_pdb/src/Foundation/PDB_Platform.h
vendored
Normal file
45
third_party/raw_pdb/src/Foundation/PDB_Platform.h
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
|
||||
// determine the compiler/toolchain used
|
||||
#if defined(__clang__)
|
||||
# define PDB_COMPILER_MSVC 0
|
||||
# define PDB_COMPILER_CLANG 1
|
||||
# define PDB_COMPILER_GCC 0
|
||||
#elif defined(_MSC_VER)
|
||||
# define PDB_COMPILER_MSVC 1
|
||||
# define PDB_COMPILER_CLANG 0
|
||||
# define PDB_COMPILER_GCC 0
|
||||
#elif defined(__GNUC__)
|
||||
# define PDB_COMPILER_MSVC 0
|
||||
# define PDB_COMPILER_CLANG 0
|
||||
# define PDB_COMPILER_GCC 1
|
||||
#else
|
||||
# error("Unknown compiler.");
|
||||
#endif
|
||||
|
||||
// check whether C++17 is available
|
||||
#if __cplusplus >= 201703L
|
||||
# define PDB_CPP_17 1
|
||||
#else
|
||||
# define PDB_CPP_17 0
|
||||
#endif
|
||||
|
||||
// define used standard types
|
||||
typedef decltype(sizeof(0)) size_t;
|
||||
static_assert(sizeof(sizeof(0)) == sizeof(size_t), "Wrong size.");
|
||||
|
||||
typedef int int32_t;
|
||||
static_assert(sizeof(int32_t) == 4u, "Wrong size.");
|
||||
|
||||
typedef unsigned char uint8_t;
|
||||
static_assert(sizeof(uint8_t) == 1u, "Wrong size.");
|
||||
|
||||
typedef unsigned short uint16_t;
|
||||
static_assert(sizeof(uint16_t) == 2u, "Wrong size.");
|
||||
|
||||
typedef unsigned int uint32_t;
|
||||
static_assert(sizeof(uint32_t) == 4u, "Wrong size.");
|
||||
33
third_party/raw_pdb/src/Foundation/PDB_PointerUtil.h
vendored
Normal file
33
third_party/raw_pdb/src/Foundation/PDB_PointerUtil.h
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Macros.h"
|
||||
#include "PDB_TypeTraits.h"
|
||||
|
||||
|
||||
namespace PDB
|
||||
{
|
||||
namespace Pointer
|
||||
{
|
||||
// Offsets any pointer by a given number of bytes.
|
||||
template <typename T, typename U, typename V>
|
||||
PDB_NO_DISCARD inline T Offset(U* anyPointer, V howManyBytes) PDB_NO_EXCEPT
|
||||
{
|
||||
static_assert(PDB::is_pointer<T>::value == true, "Type T must be a pointer type.");
|
||||
|
||||
union
|
||||
{
|
||||
T as_T;
|
||||
U* as_U_ptr;
|
||||
char* as_char_ptr;
|
||||
};
|
||||
|
||||
as_U_ptr = anyPointer;
|
||||
as_char_ptr += howManyBytes;
|
||||
|
||||
return as_T;
|
||||
}
|
||||
}
|
||||
}
|
||||
65
third_party/raw_pdb/src/Foundation/PDB_TypeTraits.h
vendored
Normal file
65
third_party/raw_pdb/src/Foundation/PDB_TypeTraits.h
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
|
||||
// provide our own type traits to avoid pulling in unnecessary includes
|
||||
namespace PDB
|
||||
{
|
||||
template <class T>
|
||||
struct is_pointer
|
||||
{
|
||||
static constexpr bool value = false;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
struct is_pointer<T*>
|
||||
{
|
||||
static constexpr bool value = true;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
struct is_pointer<T* const>
|
||||
{
|
||||
static constexpr bool value = true;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
struct is_pointer<T* volatile>
|
||||
{
|
||||
static constexpr bool value = true;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
struct is_pointer<T* const volatile>
|
||||
{
|
||||
static constexpr bool value = true;
|
||||
};
|
||||
|
||||
|
||||
template <class T>
|
||||
struct remove_reference
|
||||
{
|
||||
using type = T;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
struct remove_reference<T&>
|
||||
{
|
||||
using type = T;
|
||||
};
|
||||
|
||||
template <class T>
|
||||
struct remove_reference<T&&>
|
||||
{
|
||||
using type = T;
|
||||
};
|
||||
|
||||
|
||||
template <class T>
|
||||
struct underlying_type
|
||||
{
|
||||
using type = __underlying_type(T);
|
||||
};
|
||||
}
|
||||
45
third_party/raw_pdb/src/Foundation/PDB_Warnings.h
vendored
Normal file
45
third_party/raw_pdb/src/Foundation/PDB_Warnings.h
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "PDB_Platform.h"
|
||||
|
||||
#if PDB_COMPILER_MSVC
|
||||
// some warnings were introduced with different versions of Visual Studio, so we disable this warning instead of using a bunch of #if/#endif
|
||||
# pragma warning (disable : 4619) // there is no warning number N
|
||||
|
||||
// we compile with exceptions disabled
|
||||
# pragma warning (disable : 4530) // C++ exception handler used, but unwind semantics are not enabled.Specify / EHsc
|
||||
# pragma warning (disable : 4577) // 'noexcept' used with no exception handling mode specified; termination on exception is not guaranteed. Specify /EHsc
|
||||
|
||||
// ignore purely informational warnings
|
||||
# pragma warning (disable : 4514) // unreferenced inline function has been removed
|
||||
# pragma warning (disable : 4710) // function not inlined
|
||||
# pragma warning (disable : 4711) // function selected for automatic inline expansion
|
||||
# pragma warning (disable : 4820) // 'N' bytes padding added after data member 'm_member'
|
||||
# pragma warning (disable : 5045) // Compiler will insert Spectre mitigation for memory load if /Qspectre switch specified
|
||||
#elif PDB_COMPILER_CLANG
|
||||
// turn on absolutely all available Clang warnings
|
||||
# pragma clang diagnostic warning "-Wall"
|
||||
# pragma clang diagnostic warning "-Wextra"
|
||||
# pragma clang diagnostic warning "-Weverything"
|
||||
# pragma clang diagnostic warning "-Wpedantic"
|
||||
|
||||
// these warnings contradict -Weverything
|
||||
# pragma clang diagnostic ignored "-Wc++98-compat"
|
||||
# pragma clang diagnostic ignored "-Wc++98-compat-pedantic"
|
||||
|
||||
// this warning is triggered for templates which are explicitly instantiated.
|
||||
// forgetting to instantiate the template would trigger a linker error anyway, so we disable this warning.
|
||||
# pragma clang diagnostic ignored "-Wundefined-func-template"
|
||||
|
||||
// we don't strive for C++20 compatibility
|
||||
# pragma clang diagnostic ignored "-Wc++20-compat"
|
||||
|
||||
// some structures will have to be padded
|
||||
# pragma clang diagnostic ignored "-Wpadded"
|
||||
|
||||
// it's impossible to write C++ code using raw pointers without triggering this warning
|
||||
# pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
|
||||
#endif
|
||||
55
third_party/raw_pdb/src/PDB.cpp
vendored
Normal file
55
third_party/raw_pdb/src/PDB.cpp
vendored
Normal file
@@ -0,0 +1,55 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "PDB_PCH.h"
|
||||
#include "PDB.h"
|
||||
#include "PDB_Types.h"
|
||||
#include "PDB_Util.h"
|
||||
#include "PDB_RawFile.h"
|
||||
#include "Foundation/PDB_PointerUtil.h"
|
||||
#include "Foundation/PDB_CRT.h"
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ErrorCode PDB::ValidateFile(const void* data, size_t size) PDB_NO_EXCEPT
|
||||
{
|
||||
// validate whether there is enough size for the super block
|
||||
if (size < sizeof(SuperBlock))
|
||||
{
|
||||
return ErrorCode::InvalidDataSize;
|
||||
}
|
||||
// validate the super block
|
||||
const SuperBlock* superBlock = Pointer::Offset<const SuperBlock*>(data, 0u);
|
||||
{
|
||||
// validate header magic
|
||||
if (memcmp(superBlock->fileMagic, SuperBlock::MAGIC, sizeof(SuperBlock::MAGIC)) != 0)
|
||||
{
|
||||
return ErrorCode::InvalidSuperBlock;
|
||||
}
|
||||
|
||||
// validate whether enough size is provided for the PDB file
|
||||
// blockCount * blockSize is the size of the PDB file on disk
|
||||
if (size < superBlock->blockCount * superBlock->blockSize)
|
||||
{
|
||||
return ErrorCode::InvalidDataSize;
|
||||
}
|
||||
|
||||
// validate free block map.
|
||||
// the free block map should always reside at either index 1 or 2.
|
||||
if (superBlock->freeBlockMapIndex != 1u && superBlock->freeBlockMapIndex != 2u)
|
||||
{
|
||||
return ErrorCode::InvalidFreeBlockMap;
|
||||
}
|
||||
}
|
||||
|
||||
return ErrorCode::Success;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::RawFile PDB::CreateRawFile(const void* data) PDB_NO_EXCEPT
|
||||
{
|
||||
return RawFile(data);
|
||||
}
|
||||
21
third_party/raw_pdb/src/PDB.h
vendored
Normal file
21
third_party/raw_pdb/src/PDB.h
vendored
Normal file
@@ -0,0 +1,21 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Foundation/PDB_Macros.h"
|
||||
#include "PDB_ErrorCodes.h"
|
||||
|
||||
|
||||
// https://llvm.org/docs/PDB/index.html
|
||||
namespace PDB
|
||||
{
|
||||
class RawFile;
|
||||
|
||||
|
||||
// Validates whether a PDB file is valid.
|
||||
PDB_NO_DISCARD ErrorCode ValidateFile(const void* data, size_t size) PDB_NO_EXCEPT;
|
||||
|
||||
// Creates a raw PDB file that must have been validated.
|
||||
PDB_NO_DISCARD RawFile CreateRawFile(const void* data) PDB_NO_EXCEPT;
|
||||
}
|
||||
169
third_party/raw_pdb/src/PDB_CoalescedMSFStream.cpp
vendored
Normal file
169
third_party/raw_pdb/src/PDB_CoalescedMSFStream.cpp
vendored
Normal file
@@ -0,0 +1,169 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "PDB_PCH.h"
|
||||
#include "PDB_CoalescedMSFStream.h"
|
||||
#include "PDB_Util.h"
|
||||
#include "PDB_DirectMSFStream.h"
|
||||
#include "Foundation/PDB_PointerUtil.h"
|
||||
#include "Foundation/PDB_Memory.h"
|
||||
#include "Foundation/PDB_CRT.h"
|
||||
|
||||
|
||||
namespace
|
||||
{
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static bool AreBlockIndicesContiguous(const uint32_t* blockIndices, uint32_t blockSize, uint32_t streamSize) PDB_NO_EXCEPT
|
||||
{
|
||||
const uint32_t blockCount = PDB::ConvertSizeToBlockCount(streamSize, blockSize);
|
||||
|
||||
// start with the first index, checking if all following indices are contiguous (N, N+1, N+2, ...)
|
||||
uint32_t expectedIndex = blockIndices[0];
|
||||
for (uint32_t i = 1u; i < blockCount; ++i)
|
||||
{
|
||||
++expectedIndex;
|
||||
if (blockIndices[i] != expectedIndex)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::CoalescedMSFStream::CoalescedMSFStream(void) PDB_NO_EXCEPT
|
||||
: m_ownedData(nullptr)
|
||||
, m_data(nullptr)
|
||||
, m_size(0u)
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::CoalescedMSFStream::CoalescedMSFStream(CoalescedMSFStream&& other) PDB_NO_EXCEPT
|
||||
: m_ownedData(PDB_MOVE(other.m_ownedData))
|
||||
, m_data(PDB_MOVE(other.m_data))
|
||||
, m_size(PDB_MOVE(other.m_size))
|
||||
{
|
||||
other.m_ownedData = nullptr;
|
||||
other.m_data = nullptr;
|
||||
other.m_size = 0u;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::CoalescedMSFStream& PDB::CoalescedMSFStream::operator=(CoalescedMSFStream&& other) PDB_NO_EXCEPT
|
||||
{
|
||||
if (this != &other)
|
||||
{
|
||||
PDB_DELETE_ARRAY(m_ownedData);
|
||||
|
||||
m_ownedData = PDB_MOVE(other.m_ownedData);
|
||||
m_data = PDB_MOVE(other.m_data);
|
||||
m_size = PDB_MOVE(other.m_size);
|
||||
|
||||
other.m_ownedData = nullptr;
|
||||
other.m_data = nullptr;
|
||||
other.m_size = 0u;
|
||||
}
|
||||
|
||||
return *this;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::CoalescedMSFStream::CoalescedMSFStream(const void* data, uint32_t blockSize, const uint32_t* blockIndices, uint32_t streamSize) PDB_NO_EXCEPT
|
||||
: m_ownedData(nullptr)
|
||||
, m_data(nullptr)
|
||||
, m_size(streamSize)
|
||||
{
|
||||
if (AreBlockIndicesContiguous(blockIndices, blockSize, streamSize))
|
||||
{
|
||||
// fast path, all block indices are contiguous, so we don't have to copy any data at all.
|
||||
// instead, we directly point into the memory-mapped file at the correct offset.
|
||||
const uint32_t index = blockIndices[0];
|
||||
const size_t fileOffset = PDB::ConvertBlockIndexToFileOffset(index, blockSize);
|
||||
m_data = Pointer::Offset<const Byte*>(data, fileOffset);
|
||||
}
|
||||
else
|
||||
{
|
||||
// slower path, we need to copy disjunct blocks into our own data array, block by block
|
||||
m_ownedData = PDB_NEW_ARRAY(Byte, streamSize);
|
||||
m_data = m_ownedData;
|
||||
|
||||
Byte* destination = m_ownedData;
|
||||
|
||||
// copy full blocks first
|
||||
const uint32_t fullBlockCount = streamSize / blockSize;
|
||||
for (uint32_t i = 0u; i < fullBlockCount; ++i)
|
||||
{
|
||||
const uint32_t index = blockIndices[i];
|
||||
|
||||
// read one single block at the correct offset in the stream
|
||||
const size_t fileOffset = PDB::ConvertBlockIndexToFileOffset(index, blockSize);
|
||||
const void* sourceData = Pointer::Offset<const void*>(data, fileOffset);
|
||||
memcpy(destination, sourceData, blockSize);
|
||||
|
||||
destination += blockSize;
|
||||
}
|
||||
|
||||
// account for non-full blocks
|
||||
const uint32_t remainingBytes = streamSize - (fullBlockCount * blockSize);
|
||||
if (remainingBytes != 0u)
|
||||
{
|
||||
const uint32_t index = blockIndices[fullBlockCount];
|
||||
|
||||
// read remaining bytes at correct offset in the stream
|
||||
const size_t fileOffset = PDB::ConvertBlockIndexToFileOffset(index, blockSize);
|
||||
const void* sourceData = Pointer::Offset<const void*>(data, fileOffset);
|
||||
memcpy(destination, sourceData, remainingBytes);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::CoalescedMSFStream::CoalescedMSFStream(const DirectMSFStream& directStream, uint32_t size, uint32_t offset) PDB_NO_EXCEPT
|
||||
: m_ownedData(nullptr)
|
||||
, m_data(nullptr)
|
||||
, m_size(size)
|
||||
{
|
||||
const DirectMSFStream::IndexAndOffset indexAndOffset = directStream.GetBlockIndexForOffset(offset);
|
||||
|
||||
// Note: we need to add the offset within the block to the size of the stream to determine if the block
|
||||
// indices are contiguous. This is needed to deal with the case where reading the requested number of bytes
|
||||
// from the specified offset would cross a block boundary. For example, if the offset within the block is
|
||||
// 64 and we want to read 4096 bytes with a block size of 4096, we need to consider *two* block indices,
|
||||
// not *one*, even though 4096 / 4096 = 1.
|
||||
if (AreBlockIndicesContiguous(directStream.GetBlockIndices() + indexAndOffset.index, directStream.GetBlockSize(), indexAndOffset.offsetWithinBlock + size))
|
||||
{
|
||||
// fast path, all block indices inside the direct stream from (data + offset) to (data + offset + size) are contiguous
|
||||
const size_t offsetWithinData = directStream.GetDataOffsetForIndexAndOffset(indexAndOffset);
|
||||
m_data = Pointer::Offset<const Byte*>(directStream.GetData(), offsetWithinData);
|
||||
}
|
||||
else
|
||||
{
|
||||
// slower path, we need to copy from disjunct blocks, which is performed by the direct stream
|
||||
m_ownedData = PDB_NEW_ARRAY(Byte, size);
|
||||
m_data = m_ownedData;
|
||||
|
||||
directStream.ReadAtOffset(m_ownedData, size, offset);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::CoalescedMSFStream::~CoalescedMSFStream(void) PDB_NO_EXCEPT
|
||||
{
|
||||
PDB_DELETE_ARRAY(m_ownedData);
|
||||
}
|
||||
71
third_party/raw_pdb/src/PDB_CoalescedMSFStream.h
vendored
Normal file
71
third_party/raw_pdb/src/PDB_CoalescedMSFStream.h
vendored
Normal file
@@ -0,0 +1,71 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Foundation/PDB_Assert.h"
|
||||
#include "Foundation/PDB_Macros.h"
|
||||
#include "PDB_Types.h"
|
||||
|
||||
// https://llvm.org/docs/PDB/index.html#the-msf-container
|
||||
// https://llvm.org/docs/PDB/MsfFile.html
|
||||
namespace PDB
|
||||
{
|
||||
class PDB_NO_DISCARD DirectMSFStream;
|
||||
|
||||
|
||||
// provides access to a coalesced version of an MSF stream.
|
||||
// inherently thread-safe, the stream doesn't carry any internal offset or similar.
|
||||
// coalesces all blocks into a contiguous stream of data upon construction.
|
||||
// very fast individual reads, useful when almost all data of a stream is needed anyway.
|
||||
class PDB_NO_DISCARD CoalescedMSFStream
|
||||
{
|
||||
public:
|
||||
CoalescedMSFStream(void) PDB_NO_EXCEPT;
|
||||
CoalescedMSFStream(CoalescedMSFStream&& other) PDB_NO_EXCEPT;
|
||||
CoalescedMSFStream& operator=(CoalescedMSFStream&& other) PDB_NO_EXCEPT;
|
||||
|
||||
explicit CoalescedMSFStream(const void* data, uint32_t blockSize, const uint32_t* blockIndices, uint32_t streamSize) PDB_NO_EXCEPT;
|
||||
|
||||
// Creates a coalesced stream from a direct stream at any offset.
|
||||
explicit CoalescedMSFStream(const DirectMSFStream& directStream, uint32_t size, uint32_t offset) PDB_NO_EXCEPT;
|
||||
|
||||
~CoalescedMSFStream(void) PDB_NO_EXCEPT;
|
||||
|
||||
// Returns the size of the stream.
|
||||
PDB_NO_DISCARD inline size_t GetSize(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return m_size;
|
||||
}
|
||||
|
||||
// Provides read-only access to the data.
|
||||
template <typename T>
|
||||
PDB_NO_DISCARD inline const T* GetDataAtOffset(size_t offset) const PDB_NO_EXCEPT
|
||||
{
|
||||
return reinterpret_cast<const T*>(m_data + offset);
|
||||
}
|
||||
|
||||
template <typename T>
|
||||
PDB_NO_DISCARD inline size_t GetPointerOffset(const T* pointer) const PDB_NO_EXCEPT
|
||||
{
|
||||
const Byte* bytePointer = reinterpret_cast<const Byte*>(pointer);
|
||||
const Byte* dataEnd = m_data + m_size;
|
||||
|
||||
PDB_ASSERT(bytePointer >= m_data && bytePointer <= dataEnd, "Pointer 0x%p not within stream range [0x%p:0x%p]",
|
||||
static_cast<const void*>(bytePointer), static_cast<const void*>(m_data), static_cast<const void*>(dataEnd));
|
||||
|
||||
return static_cast<size_t>(bytePointer - m_data);
|
||||
}
|
||||
|
||||
private:
|
||||
// contiguous, coalesced data, can be null
|
||||
Byte* m_ownedData;
|
||||
|
||||
// either points to the owned data that has been copied from disjunct blocks, or points to the
|
||||
// memory-mapped data directly in case all stream blocks are contiguous.
|
||||
const Byte* m_data;
|
||||
size_t m_size;
|
||||
|
||||
PDB_DISABLE_COPY(CoalescedMSFStream);
|
||||
};
|
||||
}
|
||||
335
third_party/raw_pdb/src/PDB_DBIStream.cpp
vendored
Normal file
335
third_party/raw_pdb/src/PDB_DBIStream.cpp
vendored
Normal file
@@ -0,0 +1,335 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "PDB_PCH.h"
|
||||
#include "PDB_DBIStream.h"
|
||||
#include "PDB_RawFile.h"
|
||||
|
||||
|
||||
namespace
|
||||
{
|
||||
// the DBI stream always resides at index 3
|
||||
static constexpr const uint32_t DBIStreamIndex = 3u;
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline uint32_t GetModuleInfoSubstreamOffset(const PDB::DBI::StreamHeader& /* dbiHeader */) PDB_NO_EXCEPT
|
||||
{
|
||||
return sizeof(PDB::DBI::StreamHeader);
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline uint32_t GetSectionContributionSubstreamOffset(const PDB::DBI::StreamHeader& dbiHeader) PDB_NO_EXCEPT
|
||||
{
|
||||
return GetModuleInfoSubstreamOffset(dbiHeader) + dbiHeader.moduleInfoSize;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline uint32_t GetSectionMapSubstreamOffset(const PDB::DBI::StreamHeader& dbiHeader) PDB_NO_EXCEPT
|
||||
{
|
||||
return GetSectionContributionSubstreamOffset(dbiHeader) + dbiHeader.sectionContributionSize;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline uint32_t GetSourceInfoSubstreamOffset(const PDB::DBI::StreamHeader& dbiHeader) PDB_NO_EXCEPT
|
||||
{
|
||||
return GetSectionMapSubstreamOffset(dbiHeader) + dbiHeader.sectionMapSize;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline uint32_t GetTypeServerMapSubstreamOffset(const PDB::DBI::StreamHeader& dbiHeader) PDB_NO_EXCEPT
|
||||
{
|
||||
return GetSourceInfoSubstreamOffset(dbiHeader) + dbiHeader.sourceInfoSize;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline uint32_t GetECSubstreamOffset(const PDB::DBI::StreamHeader& dbiHeader) PDB_NO_EXCEPT
|
||||
{
|
||||
return GetTypeServerMapSubstreamOffset(dbiHeader) + dbiHeader.typeServerMapSize;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline uint32_t GetDebugHeaderSubstreamOffset(const PDB::DBI::StreamHeader& dbiHeader) PDB_NO_EXCEPT
|
||||
{
|
||||
return GetECSubstreamOffset(dbiHeader) + dbiHeader.ecSize;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD static inline bool HasDebugHeaderSubstream(const PDB::DBI::StreamHeader& dbiHeader) PDB_NO_EXCEPT
|
||||
{
|
||||
return dbiHeader.optionalDebugHeaderSize != 0u;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::DBIStream::DBIStream(void) PDB_NO_EXCEPT
|
||||
: m_header()
|
||||
, m_stream()
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB::DBIStream::DBIStream(const RawFile& file, const DBI::StreamHeader& header) PDB_NO_EXCEPT
|
||||
: m_header(header)
|
||||
, m_stream(file.CreateMSFStream<DirectMSFStream>(DBIStreamIndex))
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ErrorCode PDB::HasValidDBIStream(const RawFile& file) PDB_NO_EXCEPT
|
||||
{
|
||||
DirectMSFStream stream = file.CreateMSFStream<DirectMSFStream>(DBIStreamIndex);
|
||||
if (stream.GetSize() < sizeof(DBI::StreamHeader))
|
||||
{
|
||||
return ErrorCode::InvalidStream;
|
||||
}
|
||||
|
||||
const DBI::StreamHeader header = stream.ReadAtOffset<DBI::StreamHeader>(0u);
|
||||
if (header.signature != DBI::StreamHeader::Signature)
|
||||
{
|
||||
return ErrorCode::InvalidSignature;
|
||||
}
|
||||
else if (header.version != DBI::StreamHeader::Version::V70)
|
||||
{
|
||||
return ErrorCode::UnknownVersion;
|
||||
}
|
||||
|
||||
return ErrorCode::Success;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::DBIStream PDB::CreateDBIStream(const RawFile& file) PDB_NO_EXCEPT
|
||||
{
|
||||
DirectMSFStream stream = file.CreateMSFStream<DirectMSFStream>(DBIStreamIndex);
|
||||
const DBI::StreamHeader header = stream.ReadAtOffset<DBI::StreamHeader>(0u);
|
||||
|
||||
return DBIStream { file, header };
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ErrorCode PDB::DBIStream::HasValidSymbolRecordStream(const RawFile& /* file */) const PDB_NO_EXCEPT
|
||||
{
|
||||
return (m_header.symbolRecordStreamIndex != PDB::NilStreamIndex) ? ErrorCode::Success : ErrorCode::InvalidStreamIndex;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ErrorCode PDB::DBIStream::HasValidImageSectionStream(const RawFile& /* file */) const PDB_NO_EXCEPT
|
||||
{
|
||||
// the debug header stream is optional. if it's not there, we can't get the image section stream either.
|
||||
if (!HasDebugHeaderSubstream(m_header))
|
||||
{
|
||||
return ErrorCode::InvalidStreamIndex;
|
||||
}
|
||||
|
||||
// find the debug header sub-stream
|
||||
const uint32_t debugHeaderOffset = GetDebugHeaderSubstreamOffset(m_header);
|
||||
|
||||
// validate that we have enough data to read the debug header
|
||||
// (the header field optionalDebugHeaderSize might claim there's a debug header,
|
||||
// but the stream might not have enough data - this happens with some .ni.pdb files)
|
||||
if (debugHeaderOffset + sizeof(DBI::DebugHeader) > m_stream.GetSize())
|
||||
{
|
||||
return ErrorCode::InvalidStream;
|
||||
}
|
||||
|
||||
const DBI::DebugHeader& debugHeader = m_stream.ReadAtOffset<DBI::DebugHeader>(debugHeaderOffset);
|
||||
|
||||
if (debugHeader.sectionHeaderStreamIndex == DBI::DebugHeader::InvalidStreamIndex)
|
||||
{
|
||||
return ErrorCode::InvalidStreamIndex;
|
||||
}
|
||||
|
||||
return ErrorCode::Success;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ErrorCode PDB::DBIStream::HasValidPublicSymbolStream(const RawFile& file) const PDB_NO_EXCEPT
|
||||
{
|
||||
if (m_header.publicStreamIndex == PDB::NilStreamIndex)
|
||||
{
|
||||
return ErrorCode::InvalidStreamIndex;
|
||||
}
|
||||
|
||||
DirectMSFStream publicStream = file.CreateMSFStream<DirectMSFStream>(m_header.publicStreamIndex);
|
||||
|
||||
// the public symbol stream always begins with a header, we are not interested in that.
|
||||
// following the public symbol stream header is a hash table header.
|
||||
const HashTableHeader hashHeader = publicStream.ReadAtOffset<HashTableHeader>(sizeof(PublicStreamHeader));
|
||||
if (hashHeader.signature != HashTableHeader::Signature)
|
||||
{
|
||||
return ErrorCode::InvalidSignature;
|
||||
}
|
||||
else if (hashHeader.version != HashTableHeader::Version)
|
||||
{
|
||||
return ErrorCode::UnknownVersion;
|
||||
}
|
||||
|
||||
return ErrorCode::Success;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ErrorCode PDB::DBIStream::HasValidGlobalSymbolStream(const RawFile& file) const PDB_NO_EXCEPT
|
||||
{
|
||||
if (m_header.globalStreamIndex == PDB::NilStreamIndex)
|
||||
{
|
||||
return ErrorCode::InvalidStreamIndex;
|
||||
}
|
||||
|
||||
DirectMSFStream globalStream = file.CreateMSFStream<DirectMSFStream>(m_header.globalStreamIndex);
|
||||
|
||||
// the global symbol stream starts with a hash table header
|
||||
const HashTableHeader hashHeader = globalStream.ReadAtOffset<HashTableHeader>(0u);
|
||||
if (hashHeader.signature != HashTableHeader::Signature)
|
||||
{
|
||||
return ErrorCode::InvalidSignature;
|
||||
}
|
||||
else if (hashHeader.version != HashTableHeader::Version)
|
||||
{
|
||||
return ErrorCode::UnknownVersion;
|
||||
}
|
||||
|
||||
return ErrorCode::Success;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ErrorCode PDB::DBIStream::HasValidSectionContributionStream(const RawFile& /* file */) const PDB_NO_EXCEPT
|
||||
{
|
||||
if (m_header.sectionContributionSize < sizeof(DBI::SectionContribution::Version))
|
||||
{
|
||||
return ErrorCode::InvalidStream;
|
||||
}
|
||||
|
||||
// find the section contribution sub-stream
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#section-contribution-substream
|
||||
const uint32_t streamOffset = GetSectionContributionSubstreamOffset(m_header);
|
||||
|
||||
const DBI::SectionContribution::Version version = m_stream.ReadAtOffset<DBI::SectionContribution::Version>(streamOffset);
|
||||
if (version != DBI::SectionContribution::Version::Ver60)
|
||||
{
|
||||
return ErrorCode::UnknownVersion;
|
||||
}
|
||||
|
||||
return ErrorCode::Success;
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::CoalescedMSFStream PDB::DBIStream::CreateSymbolRecordStream(const RawFile& file) const PDB_NO_EXCEPT
|
||||
{
|
||||
// the symbol record stream holds the actual CodeView data of the symbols
|
||||
return file.CreateMSFStream<CoalescedMSFStream>(m_header.symbolRecordStreamIndex);
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ImageSectionStream PDB::DBIStream::CreateImageSectionStream(const RawFile& file) const PDB_NO_EXCEPT
|
||||
{
|
||||
// find the debug header sub-stream
|
||||
const uint32_t debugHeaderOffset = GetDebugHeaderSubstreamOffset(m_header);
|
||||
const DBI::DebugHeader& debugHeader = m_stream.ReadAtOffset<DBI::DebugHeader>(debugHeaderOffset);
|
||||
|
||||
// from there, grab the section header stream
|
||||
return ImageSectionStream(file, debugHeader.sectionHeaderStreamIndex);
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::PublicSymbolStream PDB::DBIStream::CreatePublicSymbolStream(const RawFile& file) const PDB_NO_EXCEPT
|
||||
{
|
||||
DirectMSFStream publicStream = file.CreateMSFStream<DirectMSFStream>(m_header.publicStreamIndex);
|
||||
|
||||
// the public symbol stream always begins with a header, we are not interested in that.
|
||||
// following the public symbol stream header is a hash table header.
|
||||
// we use this to work out how many symbol records are referenced by the public symbol stream.
|
||||
const HashTableHeader hashHeader = publicStream.ReadAtOffset<HashTableHeader>(sizeof(PublicStreamHeader));
|
||||
const uint32_t recordCount = hashHeader.size / sizeof(HashRecord);
|
||||
|
||||
return PublicSymbolStream(file, m_header.publicStreamIndex, recordCount);
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::GlobalSymbolStream PDB::DBIStream::CreateGlobalSymbolStream(const RawFile& file) const PDB_NO_EXCEPT
|
||||
{
|
||||
DirectMSFStream globalStream = file.CreateMSFStream<DirectMSFStream>(m_header.globalStreamIndex);
|
||||
|
||||
// the global symbol stream starts with a hash table header.
|
||||
// we use this to work out how many symbol records are referenced by the global symbol stream.
|
||||
const HashTableHeader hashHeader = globalStream.ReadAtOffset<HashTableHeader>(0u);
|
||||
const uint32_t recordCount = hashHeader.size / sizeof(HashRecord);
|
||||
|
||||
return GlobalSymbolStream(file, m_header.globalStreamIndex, recordCount);
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::SourceFileStream PDB::DBIStream::CreateSourceFileStream(const RawFile& /* file */) const PDB_NO_EXCEPT
|
||||
{
|
||||
// find the source info sub-stream
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#file-info-substream
|
||||
const uint32_t streamOffset = GetSourceInfoSubstreamOffset(m_header);
|
||||
|
||||
return SourceFileStream(m_stream, m_header.sourceInfoSize, streamOffset);
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::SectionContributionStream PDB::DBIStream::CreateSectionContributionStream(const RawFile& /* file */) const PDB_NO_EXCEPT
|
||||
{
|
||||
// find the section contribution sub-stream
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#section-contribution-substream
|
||||
const uint32_t streamOffset = GetSectionContributionSubstreamOffset(m_header);
|
||||
|
||||
return SectionContributionStream(m_stream, m_header.sectionContributionSize - sizeof(DBI::SectionContribution::Version), streamOffset + sizeof(DBI::SectionContribution::Version));
|
||||
}
|
||||
|
||||
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
// ------------------------------------------------------------------------------------------------
|
||||
PDB_NO_DISCARD PDB::ModuleInfoStream PDB::DBIStream::CreateModuleInfoStream(const RawFile& /* file */) const PDB_NO_EXCEPT
|
||||
{
|
||||
// find the module info sub-stream
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#module-info-substream
|
||||
const uint32_t streamOffset = GetModuleInfoSubstreamOffset(m_header);
|
||||
|
||||
return ModuleInfoStream(m_stream, m_header.moduleInfoSize, streamOffset);
|
||||
}
|
||||
65
third_party/raw_pdb/src/PDB_DBIStream.h
vendored
Normal file
65
third_party/raw_pdb/src/PDB_DBIStream.h
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Foundation/PDB_Macros.h"
|
||||
#include "PDB_ErrorCodes.h"
|
||||
#include "PDB_DBITypes.h"
|
||||
#include "PDB_CoalescedMSFStream.h"
|
||||
#include "PDB_DirectMSFStream.h"
|
||||
#include "PDB_ImageSectionStream.h"
|
||||
#include "PDB_PublicSymbolStream.h"
|
||||
#include "PDB_GlobalSymbolStream.h"
|
||||
#include "PDB_SourceFileStream.h"
|
||||
#include "PDB_SectionContributionStream.h"
|
||||
#include "PDB_ModuleInfoStream.h"
|
||||
|
||||
|
||||
// PDB DBI Stream
|
||||
// https://llvm.org/docs/PDB/DbiStream.html
|
||||
namespace PDB
|
||||
{
|
||||
class RawFile;
|
||||
|
||||
|
||||
class PDB_NO_DISCARD DBIStream
|
||||
{
|
||||
public:
|
||||
DBIStream(void) PDB_NO_EXCEPT;
|
||||
explicit DBIStream(const RawFile& file, const DBI::StreamHeader& header) PDB_NO_EXCEPT;
|
||||
|
||||
PDB_DEFAULT_MOVE(DBIStream);
|
||||
|
||||
PDB_NO_DISCARD ErrorCode HasValidSymbolRecordStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD ErrorCode HasValidImageSectionStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD ErrorCode HasValidPublicSymbolStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD ErrorCode HasValidGlobalSymbolStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD ErrorCode HasValidSectionContributionStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
|
||||
PDB_NO_DISCARD CoalescedMSFStream CreateSymbolRecordStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD ImageSectionStream CreateImageSectionStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD PublicSymbolStream CreatePublicSymbolStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD GlobalSymbolStream CreateGlobalSymbolStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD SourceFileStream CreateSourceFileStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD SectionContributionStream CreateSectionContributionStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
PDB_NO_DISCARD ModuleInfoStream CreateModuleInfoStream(const RawFile& file) const PDB_NO_EXCEPT;
|
||||
|
||||
PDB_NO_DISCARD const DBI::StreamHeader& GetHeader(void) const PDB_NO_EXCEPT
|
||||
{
|
||||
return m_header;
|
||||
}
|
||||
|
||||
private:
|
||||
DBI::StreamHeader m_header;
|
||||
DirectMSFStream m_stream;
|
||||
|
||||
PDB_DISABLE_COPY(DBIStream);
|
||||
};
|
||||
|
||||
// Returns whether the given raw file provides a valid DBI stream.
|
||||
PDB_NO_DISCARD ErrorCode HasValidDBIStream(const RawFile& file) PDB_NO_EXCEPT;
|
||||
|
||||
// Creates the DBI stream from a raw file.
|
||||
PDB_NO_DISCARD DBIStream CreateDBIStream(const RawFile& file) PDB_NO_EXCEPT;
|
||||
}
|
||||
9
third_party/raw_pdb/src/PDB_DBITypes.cpp
vendored
Normal file
9
third_party/raw_pdb/src/PDB_DBITypes.cpp
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#include "PDB_PCH.h"
|
||||
#include "PDB_DBITypes.h"
|
||||
|
||||
|
||||
const uint32_t PDB::DBI::StreamHeader::Signature = 0xffffffffu;
|
||||
const uint16_t PDB::DBI::DebugHeader::InvalidStreamIndex = 0xFFFFu;
|
||||
928
third_party/raw_pdb/src/PDB_DBITypes.h
vendored
Normal file
928
third_party/raw_pdb/src/PDB_DBITypes.h
vendored
Normal file
@@ -0,0 +1,928 @@
|
||||
// Copyright 2011-2022, Molecular Matters GmbH <office@molecular-matters.com>
|
||||
// See LICENSE.txt for licensing details (2-clause BSD License: https://opensource.org/licenses/BSD-2-Clause)
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Foundation/PDB_Macros.h"
|
||||
#include "Foundation/PDB_BitOperators.h"
|
||||
|
||||
|
||||
namespace PDB
|
||||
{
|
||||
namespace DBI
|
||||
{
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#stream-header
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/PDB/dbi/dbi.h#L124
|
||||
struct StreamHeader
|
||||
{
|
||||
static const uint32_t Signature;
|
||||
|
||||
enum class PDB_NO_DISCARD Version : uint32_t
|
||||
{
|
||||
VC41 = 930803u,
|
||||
V50 = 19960307u,
|
||||
V60 = 19970606u,
|
||||
V70 = 19990903u,
|
||||
V110 = 20091201u
|
||||
};
|
||||
|
||||
uint32_t signature;
|
||||
Version version;
|
||||
uint32_t age;
|
||||
uint16_t globalStreamIndex; // index of the global symbol stream
|
||||
uint16_t toolchain;
|
||||
uint16_t publicStreamIndex; // index of the public symbol stream
|
||||
uint16_t pdbDllVersion;
|
||||
uint16_t symbolRecordStreamIndex; // index of the symbol record stream
|
||||
uint16_t pdbDllRbld;
|
||||
uint32_t moduleInfoSize;
|
||||
uint32_t sectionContributionSize;
|
||||
uint32_t sectionMapSize;
|
||||
uint32_t sourceInfoSize;
|
||||
uint32_t typeServerMapSize;
|
||||
uint32_t mfcTypeServerIndex;
|
||||
uint32_t optionalDebugHeaderSize;
|
||||
uint32_t ecSize;
|
||||
uint16_t flags;
|
||||
uint16_t machine;
|
||||
uint32_t padding;
|
||||
};
|
||||
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#optional-debug-header-stream
|
||||
struct DebugHeader
|
||||
{
|
||||
static const uint16_t InvalidStreamIndex;
|
||||
|
||||
uint16_t fpoDataStreamIndex; // IMAGE_DEBUG_TYPE_FPO
|
||||
uint16_t exceptionDataStreamIndex; // IMAGE_DEBUG_TYPE_EXCEPTION
|
||||
uint16_t fixupDataStreamIndex; // IMAGE_DEBUG_TYPE_FIXUP
|
||||
uint16_t omapToSrcDataStreamIndex; // IMAGE_DEBUG_TYPE_OMAP_TO_SRC
|
||||
uint16_t omapFromSrcDataStreamIndex; // IMAGE_DEBUG_TYPE_OMAP_FROM_SRC
|
||||
uint16_t sectionHeaderStreamIndex; // a dump of all section headers (IMAGE_SECTION_HEADER) from the original executable
|
||||
uint16_t tokenDataStreamIndex;
|
||||
uint16_t xdataStreamIndex;
|
||||
uint16_t pdataStreamIndex;
|
||||
uint16_t newFpoDataStreamIndex;
|
||||
uint16_t originalSectionHeaderDataStreamIndex;
|
||||
};
|
||||
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#section-contribution-substream
|
||||
struct SectionContribution
|
||||
{
|
||||
enum class PDB_NO_DISCARD Version : uint32_t
|
||||
{
|
||||
Ver60 = 0xeffe0000u + 19970605u,
|
||||
V2 = 0xeffe0000u + 20140516u
|
||||
};
|
||||
|
||||
uint16_t section;
|
||||
uint16_t padding;
|
||||
uint32_t offset;
|
||||
uint32_t size;
|
||||
uint32_t characteristics;
|
||||
uint16_t moduleIndex;
|
||||
uint16_t padding2;
|
||||
uint32_t dataCrc;
|
||||
uint32_t relocationCrc;
|
||||
};
|
||||
|
||||
// https://llvm.org/docs/PDB/DbiStream.html#module-info-substream
|
||||
struct ModuleInfo
|
||||
{
|
||||
uint32_t unused;
|
||||
SectionContribution sectionContribution;
|
||||
uint16_t flags;
|
||||
uint16_t moduleSymbolStreamIndex;
|
||||
uint32_t symbolSize;
|
||||
uint32_t c11Size;
|
||||
uint32_t c13Size;
|
||||
uint16_t sourceFileCount;
|
||||
uint16_t padding;
|
||||
uint32_t unused2;
|
||||
uint32_t sourceFileNameIndex;
|
||||
uint32_t pdbFilePathNameIndex;
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
namespace CodeView
|
||||
{
|
||||
namespace DBI
|
||||
{
|
||||
// code view type records that can appear in a DBI stream.
|
||||
// this list is not exhaustive, but only contains what we need so far.
|
||||
// https://llvm.org/docs/PDB/CodeViewSymbols.html
|
||||
// https://llvm.org/docs/PDB/TpiStream.html#tpi-vs-ipi-stream
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L2735
|
||||
enum class PDB_NO_DISCARD SymbolRecordKind : uint16_t
|
||||
{
|
||||
S_END = 0x0006u, // block, procedure, "with" or thunk end
|
||||
S_SKIP = 0x0007u, // Reserve symbol space in $$Symbols table
|
||||
S_FRAMEPROC = 0x1012u, // extra frame and proc information
|
||||
S_ANNOTATION = 0x1019u, // annotation string literals ("__annotation" intrinsic, e.g. via NT_ASSERT)
|
||||
S_OBJNAME = 0x1101u, // full path to the original compiled .obj. can point to remote locations and temporary files, not necessarily the file that was linked into the executable
|
||||
S_THUNK32 = 0x1102u, // thunk start
|
||||
S_BLOCK32 = 0x1103u, // block start
|
||||
S_LABEL32 = 0x1105u, // code label
|
||||
S_REGISTER = 0x1106u, // register variable
|
||||
S_CONSTANT = 0x1107u, // constant symbol
|
||||
S_BPREL32 = 0x110Bu, // BP-relative address (almost like S_REGREL32)
|
||||
S_LDATA32 = 0x110Cu, // (static) local data
|
||||
S_GDATA32 = 0x110Du, // global data
|
||||
S_PUB32 = 0x110Eu, // public symbol
|
||||
S_LPROC32 = 0x110Fu, // local procedure start
|
||||
S_GPROC32 = 0x1110u, // global procedure start
|
||||
S_REGREL32 = 0x1111u, // register relative address
|
||||
S_LTHREAD32 = 0x1112u, // (static) thread-local data
|
||||
S_GTHREAD32 = 0x1113u, // global thread-local data
|
||||
S_UNAMESPACE = 0x1124u, // using namespace
|
||||
S_PROCREF = 0x1125u, // reference to function in any compiland
|
||||
S_LPROCREF = 0x1127u, // local reference to function in any compiland
|
||||
S_TRAMPOLINE = 0x112Cu, // incremental linking trampoline
|
||||
S_SEPCODE = 0x1132u, // separated code (from the compiler)
|
||||
S_SECTION = 0x1136u, // a COFF section in an executable
|
||||
S_COFFGROUP = 0x1137u, // original COFF group before it was merged into executable sections by the linker, e.g. .CRT$XCU, .rdata, .bss, .lpp_prepatch_hooks
|
||||
S_CALLSITEINFO = 0x1139u, // Indirect call site information
|
||||
S_FRAMECOOKIE = 0x113Au, // Security cookie information
|
||||
S_COMPILE3 = 0x113Cu, // replacement for S_COMPILE2, more info
|
||||
S_ENVBLOCK = 0x113Du, // environment block split off from S_COMPILE2
|
||||
S_LOCAL = 0x113Eu, // defines a local symbol in optimized code
|
||||
S_DEFRANGE_REGISTER = 0x1141u, // ranges for en-registered symbol
|
||||
S_DEFRANGE_FRAMEPOINTER_REL = 0x1142u, // range for stack symbol.
|
||||
S_DEFRANGE_SUBFIELD_REGISTER = 0x1143u, // ranges for en-registered field of symbol
|
||||
S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE = 0x1144u, // range for stack symbol span valid full scope of function body, gap might apply.
|
||||
S_DEFRANGE_REGISTER_REL = 0x1145u, // range for symbol address as register + offset.
|
||||
S_LPROC32_ID = 0x1146u, // S_PROC symbol that references ID instead of type
|
||||
S_GPROC32_ID = 0x1147u, // S_PROC symbol that references ID instead of type
|
||||
S_BUILDINFO = 0x114Cu, // build info/environment details of a compiland/translation unit
|
||||
S_INLINESITE = 0x114Du, // inlined function callsite
|
||||
S_INLINESITE_END = 0x114Eu,
|
||||
S_PROC_ID_END = 0x114Fu,
|
||||
S_FILESTATIC = 0x1153u,
|
||||
S_LPROC32_DPC = 0x1155u,
|
||||
S_LPROC32_DPC_ID = 0x1156u,
|
||||
S_ARMSWITCHTABLE = 0x1159u,
|
||||
S_CALLEES = 0x115Au,
|
||||
S_CALLERS = 0x115Bu,
|
||||
S_INLINESITE2 = 0x115Du, // extended inline site information
|
||||
S_HEAPALLOCSITE = 0x115Eu, // heap allocation site
|
||||
S_INLINEES = 0x1168u, // https://llvm.org/docs/PDB/CodeViewSymbols.html#s-inlinees-0x1168
|
||||
S_REGREL32_INDIR = 0x1171u,
|
||||
S_REGREL32_ENCTMP = 0x1179u,
|
||||
S_UDT = 0x1108u, // user-defined type
|
||||
S_UDT_ST = 0x1003u, // user-defined structured types
|
||||
};
|
||||
|
||||
// https://docs.microsoft.com/en-us/visualstudio/debugger/debug-interface-access/thunk-ordinal
|
||||
enum class PDB_NO_DISCARD ThunkOrdinal : uint8_t
|
||||
{
|
||||
NoType,
|
||||
ThisAdjustor,
|
||||
VirtualCall,
|
||||
PCode,
|
||||
DelayLoad,
|
||||
TrampolineIncremental,
|
||||
TrampolineBranchIsland
|
||||
};
|
||||
|
||||
enum class PDB_NO_DISCARD TrampolineType : uint16_t
|
||||
{
|
||||
Incremental,
|
||||
BranchIsland
|
||||
};
|
||||
|
||||
enum class PDB_NO_DISCARD CookieType : uint8_t
|
||||
{
|
||||
COPY = 0,
|
||||
XOR_SP,
|
||||
XOR_BP,
|
||||
XOR_R13,
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvconst.h#L392
|
||||
enum class PDB_NO_DISCARD Register : uint16_t
|
||||
{
|
||||
EAX = 17,
|
||||
ECX = 18,
|
||||
EDX = 19,
|
||||
EBX = 20,
|
||||
ESP = 21,
|
||||
EBP = 22,
|
||||
ESI = 23,
|
||||
EDI = 24,
|
||||
|
||||
RAX = 328,
|
||||
RBX = 329,
|
||||
RCX = 330,
|
||||
RDX = 331,
|
||||
RSI = 332,
|
||||
RDI = 333,
|
||||
RBP = 334,
|
||||
RSP = 335,
|
||||
R8 = 336,
|
||||
R9 = 337,
|
||||
R10 = 338,
|
||||
R11 = 339,
|
||||
R12 = 340,
|
||||
R13 = 341,
|
||||
R14 = 342,
|
||||
R15 = 343,
|
||||
|
||||
RIP = 33, // also EIP for x32
|
||||
EFLAGS = 34, // same for x64 and x32
|
||||
};
|
||||
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L3038
|
||||
enum class PDB_NO_DISCARD ProcedureFlags : uint8_t
|
||||
{
|
||||
None = 0u,
|
||||
NoFPO = 1u << 0u,
|
||||
InterruptReturn = 1u << 1u,
|
||||
FarReturn = 1u << 2u,
|
||||
NoReturn = 1u << 3u,
|
||||
Unreachable = 1u << 4u,
|
||||
CustomCallingConvention = 1u << 5u,
|
||||
NoInline = 1u << 6u,
|
||||
OptimizedDebugInformation = 1u << 7u
|
||||
};
|
||||
PDB_DEFINE_BIT_OPERATORS(ProcedureFlags);
|
||||
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L3676
|
||||
enum class PDB_NO_DISCARD PublicSymbolFlags : uint32_t
|
||||
{
|
||||
None = 0u,
|
||||
Code = 1u << 0u, // set if public symbol refers to a code address
|
||||
Function = 1u << 1u, // set if public symbol is a function
|
||||
ManagedCode = 1u << 2u, // set if managed code (native or IL)
|
||||
ManagedILCode = 1u << 3u // set if managed IL code
|
||||
};
|
||||
PDB_DEFINE_BIT_OPERATORS(PublicSymbolFlags);
|
||||
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L3341
|
||||
enum class PDB_NO_DISCARD CompileSymbolFlags : uint32_t
|
||||
{
|
||||
None = 0u,
|
||||
SourceLanguageMask = 0xFFu,
|
||||
EC = 1u << 8u,
|
||||
NoDebugInfo = 1u << 9u,
|
||||
LTCG = 1u << 10u,
|
||||
NoDataAlign = 1u << 11u,
|
||||
ManagedCodeOrDataPresent = 1u << 12u,
|
||||
SecurityChecks = 1u << 13u,
|
||||
HotPatch = 1u << 14u,
|
||||
CVTCIL = 1u << 15u,
|
||||
MSILModule = 1u << 16u,
|
||||
SDL = 1u << 17u,
|
||||
PGO = 1u << 18u,
|
||||
Exp = 1u << 19u
|
||||
};
|
||||
PDB_DEFINE_BIT_OPERATORS(CompileSymbolFlags);
|
||||
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvconst.h#L324
|
||||
enum class PDB_NO_DISCARD CPUType : uint16_t
|
||||
{
|
||||
Intel8080 = 0x0,
|
||||
Intel8086 = 0x1,
|
||||
Intel80286 = 0x2,
|
||||
Intel80386 = 0x3,
|
||||
Intel80486 = 0x4,
|
||||
Pentium = 0x5,
|
||||
PentiumII = 0x6,
|
||||
PentiumPro = PentiumII,
|
||||
PentiumIII = 0x7,
|
||||
MIPS = 0x10,
|
||||
MIPSR4000 = MIPS,
|
||||
MIPS16 = 0x11,
|
||||
MIPS32 = 0x12,
|
||||
MIPS64 = 0x13,
|
||||
MIPSI = 0x14,
|
||||
MIPSII = 0x15,
|
||||
MIPSIII = 0x16,
|
||||
MIPSIV = 0x17,
|
||||
MIPSV = 0x18,
|
||||
M68000 = 0x20,
|
||||
M68010 = 0x21,
|
||||
M68020 = 0x22,
|
||||
M68030 = 0x23,
|
||||
M68040 = 0x24,
|
||||
Alpha = 0x30,
|
||||
Alpha21164 = 0x31,
|
||||
Alpha21164A = 0x32,
|
||||
Alpha21264 = 0x33,
|
||||
Alpha21364 = 0x34,
|
||||
PPC601 = 0x40,
|
||||
PPC603 = 0x41,
|
||||
PPC604 = 0x42,
|
||||
PPC620 = 0x43,
|
||||
PPCFP = 0x44,
|
||||
PPCBE = 0x45,
|
||||
SH3 = 0x50,
|
||||
SH3E = 0x51,
|
||||
SH3DSP = 0x52,
|
||||
SH4 = 0x53,
|
||||
SHMedia = 0x54,
|
||||
ARM3 = 0x60,
|
||||
ARM4 = 0x61,
|
||||
ARM4T = 0x62,
|
||||
ARM5 = 0x63,
|
||||
ARM5T = 0x64,
|
||||
ARM6 = 0x65,
|
||||
ARM_XMAC = 0x66,
|
||||
ARM_WMMX = 0x67,
|
||||
ARM7 = 0x68,
|
||||
Omni = 0x70,
|
||||
IA64 = 0x80,
|
||||
IA64_1 = 0x80,
|
||||
IA64_2 = 0x81,
|
||||
CEE = 0x90,
|
||||
AM33 = 0xA0,
|
||||
M32R = 0xB0,
|
||||
TriCore = 0xC0,
|
||||
X64 = 0xD0,
|
||||
AMD64 = X64,
|
||||
EBC = 0xE0,
|
||||
Thumb = 0xF0,
|
||||
ARMNT = 0xF4,
|
||||
ARM64 = 0xF6,
|
||||
HybridX86ARM64 = 0xF7,
|
||||
ARM64EC = 0xF8,
|
||||
ARM64X = 0xF9,
|
||||
D3D11_Shader = 0x100
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L3100
|
||||
// represents an address range, used for optimized code debug info
|
||||
struct LocalVariableAddressRange // defines a range of addresses
|
||||
{
|
||||
uint32_t offsetStart;
|
||||
uint16_t isectionStart;
|
||||
uint16_t length;
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L3108
|
||||
// Represents the holes in overall address range, all address is pre-bbt.
|
||||
// it is for compress and reduce the amount of relocations need.
|
||||
struct LocalVariableAddressGap
|
||||
{
|
||||
uint16_t offset; // relative offset from the beginning of the live range.
|
||||
uint16_t length; // length of this gap.
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/0fe89a942f9a0f8e061213313e438884f4c9b876/include/cvinfo.h#L4366
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/0fe89a942f9a0f8e061213313e438884f4c9b876/cvdump/dumpsym7.cpp#L5518
|
||||
enum class ARMSwitchType : uint16_t
|
||||
{
|
||||
INT1 = 0, // signed byte
|
||||
UINT1 = 1, // unsigned byte
|
||||
INT2 = 2, // signed two byte
|
||||
UINT2 = 3, // unsigned two byte
|
||||
INT4 = 4, // signed four byte
|
||||
UINT4 = 5, // unsigned four byte
|
||||
POINTER = 6,
|
||||
UINT1SHL1 = 7, // unsigned byte scaled by two
|
||||
UINT2SHL1 = 8, // unsigned two byte scaled by two
|
||||
INT1SHL1 = 9, // signed byte scaled by two
|
||||
INT2SHL1 = 10, // signed two byte scaled by two
|
||||
TBB = UINT1SHL1,
|
||||
TBH = UINT2SHL1,
|
||||
};
|
||||
|
||||
// https://llvm.org/docs/PDB/CodeViewTypes.html#leaf-types
|
||||
struct RecordHeader
|
||||
{
|
||||
uint16_t size; // record length, not including this 2-byte field
|
||||
SymbolRecordKind kind; // record kind
|
||||
};
|
||||
|
||||
// all CodeView records are stored as a header, followed by variable-length data.
|
||||
// internal Record structs such as S_PUB32, S_GDATA32, etc. correspond to the data layout of a CodeView record of that kind.
|
||||
struct Record
|
||||
{
|
||||
RecordHeader header;
|
||||
union Data
|
||||
{
|
||||
#pragma pack(push, 1)
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4069
|
||||
struct
|
||||
{
|
||||
uint32_t cbFrame; // count of bytes of total frame of procedure
|
||||
uint32_t cbPad; // count of bytes of padding in the frame
|
||||
uint32_t offPad; // offset (relative to frame poniter) to where
|
||||
// padding starts
|
||||
uint32_t cbSaveRegs; // count of bytes of callee save registers
|
||||
uint32_t offExHdlr; // offset of exception handler
|
||||
uint16_t sectExHdlr; // section id of exception handler
|
||||
|
||||
struct {
|
||||
uint32_t fHasAlloca : 1; // function uses _alloca()
|
||||
uint32_t fHasSetJmp : 1; // function uses setjmp()
|
||||
uint32_t fHasLongJmp : 1; // function uses longjmp()
|
||||
uint32_t fHasInlAsm : 1; // function uses inline asm
|
||||
uint32_t fHasEH : 1; // function has EH states
|
||||
uint32_t fInlSpec : 1; // function was speced as inline
|
||||
uint32_t fHasSEH : 1; // function has SEH
|
||||
uint32_t fNaked : 1; // function is __declspec(naked)
|
||||
uint32_t fSecurityChecks : 1; // function has buffer security check introduced by /GS.
|
||||
uint32_t fAsyncEH : 1; // function compiled with /EHa
|
||||
uint32_t fGSNoStackOrdering : 1; // function has /GS buffer checks, but stack ordering couldn't be done
|
||||
uint32_t fWasInlined : 1; // function was inlined within another function
|
||||
uint32_t fGSCheck : 1; // function is __declspec(strict_gs_check)
|
||||
uint32_t fSafeBuffers : 1; // function is __declspec(safebuffers)
|
||||
uint32_t encodedLocalBasePointer : 2; // record function's local pointer explicitly.
|
||||
uint32_t encodedParamBasePointer : 2; // record function's parameter pointer explicitly.
|
||||
uint32_t fPogoOn : 1; // function was compiled with PGO/PGU
|
||||
uint32_t fValidCounts : 1; // Do we have valid Pogo counts?
|
||||
uint32_t fOptSpeed : 1; // Did we optimize for speed?
|
||||
uint32_t fGuardCF : 1; // function contains CFG checks (and no write checks)
|
||||
uint32_t fGuardCFW : 1; // function contains CFW checks and/or instrumentation
|
||||
uint32_t pad : 9; // must be zero
|
||||
} flags;
|
||||
} S_FRAMEPROC;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
uint16_t annotationsCount; // number of zero-terminated annotation strings
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, annotations); // sequence of zero-terminated annotation strings
|
||||
} S_ANNOTATIONSYM;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L3696
|
||||
struct
|
||||
{
|
||||
PublicSymbolFlags flags;
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_PUB32;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t typeIndex;
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_GDATA32, S_GTHREAD32, S_LDATA32, S_LTHREAD32;
|
||||
|
||||
struct
|
||||
{
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_UNAMESPACE;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t signature;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_OBJNAME;
|
||||
|
||||
struct
|
||||
{
|
||||
TrampolineType type;
|
||||
uint16_t size;
|
||||
uint32_t thunkOffset;
|
||||
uint32_t targetOffset;
|
||||
uint16_t thunkSection;
|
||||
uint16_t targetSection;
|
||||
} S_TRAMPOLINE;
|
||||
|
||||
struct
|
||||
{
|
||||
uint16_t sectionNumber;
|
||||
uint8_t alignment;
|
||||
uint32_t rva;
|
||||
uint32_t length;
|
||||
uint32_t characteristics;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_SECTION;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t size;
|
||||
uint32_t characteristics;
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_COFFGROUP;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t offset ; // offset of call site
|
||||
uint16_t section; // section index of call site
|
||||
uint16_t padding; // alignment padding field, must be zero
|
||||
uint32_t typeIndex; // type index describing function signature
|
||||
} S_CALLSITEINFO;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t offset; // Frame relative offset
|
||||
uint16_t reg; // Register index
|
||||
CookieType cookietype; // Type of the cookie
|
||||
uint8_t flags; // Flags describing this cookie
|
||||
} S_FRAMECOOKIE;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t parent;
|
||||
uint32_t end;
|
||||
uint32_t next;
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
uint16_t length;
|
||||
ThunkOrdinal thunk;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_THUNK32;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t parent;
|
||||
uint32_t end;
|
||||
uint32_t next;
|
||||
uint32_t codeSize;
|
||||
uint32_t debugStart;
|
||||
uint32_t debugEnd;
|
||||
uint32_t typeIndex;
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
ProcedureFlags flags;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_LPROC32, S_GPROC32, S_LPROC32_ID, S_GPROC32_ID, S_LPROC32_DPC, S_LPROC32_DPC_ID;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t offset;
|
||||
uint32_t typeIndex;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_BPRELSYM32;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t offset;
|
||||
uint32_t typeIndex;
|
||||
Register reg;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_REGREL32, S_REGREL32_ENCTMP;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t typeIndex;
|
||||
Register reg;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_REGSYM;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t parent;
|
||||
uint32_t end;
|
||||
uint32_t codeSize;
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_BLOCK32;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t offset;
|
||||
uint16_t section;
|
||||
ProcedureFlags flags;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_LABEL32;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t typeIndex;
|
||||
uint16_t value;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_CONSTANT;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t typeIndex; // refers to a type index in the IPI stream
|
||||
} S_BUILDINFO;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t parent; // pointer to the inliner
|
||||
uint32_t end; // pointer to this block's end
|
||||
uint32_t inlinee; // CV_ItemId of inlinee
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(uint8_t, binaryAnnotations);
|
||||
} S_INLINESITE;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4199
|
||||
struct
|
||||
{
|
||||
uint32_t typeIndex; // type index
|
||||
uint32_t moduleFilenameOffset; // index of mod filename in stringtable
|
||||
|
||||
struct
|
||||
{
|
||||
uint16_t fIsParam : 1; // variable is a parameter
|
||||
uint16_t fAddrTaken : 1; // address is taken
|
||||
uint16_t fCompGenx : 1; // variable is compiler generated
|
||||
uint16_t fIsAggregate : 1; // the symbol is splitted in temporaries,
|
||||
// which are treated by compiler as
|
||||
// independent entities
|
||||
uint16_t fIsAggregated : 1; // Counterpart of fIsAggregate - tells
|
||||
// that it is a part of a fIsAggregate symbol
|
||||
uint16_t fIsAliased : 1; // variable has multiple simultaneous lifetimes
|
||||
uint16_t fIsAlias : 1; // represents one of the multiple simultaneous lifetimes
|
||||
uint16_t fIsRetValue : 1; // represents a function return value
|
||||
uint16_t fIsOptimizedOut : 1; // variable has no lifetimes
|
||||
uint16_t fIsEnregGlob : 1; // variable is an enregistered global
|
||||
uint16_t fIsEnregStat : 1; // variable is an enregistered static
|
||||
uint16_t unused : 5; // must be zero
|
||||
} flags;
|
||||
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_FILESTATIC;
|
||||
|
||||
struct
|
||||
{
|
||||
CompileSymbolFlags flags;
|
||||
CPUType machine;
|
||||
uint16_t versionFrontendMajor;
|
||||
uint16_t versionFrontendMinor;
|
||||
uint16_t versionFrontendBuild;
|
||||
uint16_t versionFrontendQFE;
|
||||
uint16_t versionBackendMajor;
|
||||
uint16_t versionBackendMinor;
|
||||
uint16_t versionBackendBuild;
|
||||
uint16_t versionBackendQFE;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, version);
|
||||
} S_COMPILE3;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L3372
|
||||
struct
|
||||
{
|
||||
uint8_t flags;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, strings);
|
||||
} S_ENVBLOCK;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4190
|
||||
struct
|
||||
{
|
||||
uint32_t typeIndex;
|
||||
|
||||
struct
|
||||
{
|
||||
uint16_t fIsParam : 1; // variable is a parameter
|
||||
uint16_t fAddrTaken : 1; // address is taken
|
||||
uint16_t fCompGenx : 1; // variable is compiler generated
|
||||
uint16_t fIsAggregate : 1; // the symbol is splitted in temporaries,
|
||||
// which are treated by compiler as
|
||||
// independent entities
|
||||
uint16_t fIsAggregated : 1; // Counterpart of fIsAggregate - tells
|
||||
// that it is a part of a fIsAggregate symbol
|
||||
uint16_t fIsAliased : 1; // variable has multiple simultaneous lifetimes
|
||||
uint16_t fIsAlias : 1; // represents one of the multiple simultaneous lifetimes
|
||||
uint16_t fIsRetValue : 1; // represents a function return value
|
||||
uint16_t fIsOptimizedOut : 1; // variable has no lifetimes
|
||||
uint16_t fIsEnregGlob : 1; // variable is an enregistered global
|
||||
uint16_t fIsEnregStat : 1; // variable is an enregistered static
|
||||
uint16_t unused : 5; // must be zero
|
||||
} flags;
|
||||
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_LOCAL;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4236
|
||||
struct
|
||||
{
|
||||
uint16_t reg; // Register to hold the value of the symbol
|
||||
|
||||
struct
|
||||
{
|
||||
uint16_t maybe : 1; // May have no user name on one of control flow path.
|
||||
uint16_t padding : 15; // Padding for future use.
|
||||
} attribute; // Attribute of the register range.
|
||||
|
||||
LocalVariableAddressRange range; // Range of addresses where this program is valid
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(LocalVariableAddressGap, gaps); // The value is not available in following gaps.
|
||||
} S_DEFRANGE_REGISTER;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4245
|
||||
struct
|
||||
{
|
||||
uint32_t offsetFramePointer;
|
||||
LocalVariableAddressRange range; // Range of addresses where this program is valid
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(LocalVariableAddressGap, gaps); // The value is not available in following gaps.
|
||||
} S_DEFRANGE_FRAMEPOINTER_REL;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4265
|
||||
struct
|
||||
{
|
||||
uint16_t reg; // Register to hold the value of the symbol
|
||||
|
||||
struct
|
||||
{
|
||||
uint16_t maybe : 1; // May have no user name on one of control flow path.
|
||||
uint16_t padding : 15; // Padding for future use.
|
||||
} attribute; // Attribute of the register range.
|
||||
|
||||
uint32_t offsetParent : 12; // Offset in parent variable.
|
||||
uint32_t padding : 20; // Padding for future use.
|
||||
LocalVariableAddressRange range; // Range of addresses where this program is valid
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(LocalVariableAddressGap, gaps); // The value is not available in following gaps.
|
||||
} S_DEFRANGE_SUBFIELD_REGISTER;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4255
|
||||
struct
|
||||
{
|
||||
uint32_t offsetFramePointer; // offset to frame pointer
|
||||
} S_DEFRANGE_FRAMEPOINTER_REL_FULL_SCOPE;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4279
|
||||
struct
|
||||
{
|
||||
uint16_t baseRegister; // Register to hold the base pointer of the symbol
|
||||
uint16_t spilledUDTMember : 1; // Spilled member for s.i.
|
||||
uint16_t padding : 3; // Padding for future use.
|
||||
uint16_t offsetParent : 12; // Offset in parent variable.
|
||||
uint32_t offsetBasePointer; // offset to register
|
||||
LocalVariableAddressRange range; // Range of addresses where this program is valid
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(LocalVariableAddressGap, gaps); // The value is not available in following gaps.
|
||||
} S_DEFRANGE_REGISTER_REL;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4500
|
||||
struct
|
||||
{
|
||||
uint32_t offset; // offset of call site
|
||||
uint16_t section; // section index of call site
|
||||
uint16_t instructionLength; // length of heap allocation call instruction
|
||||
uint32_t typeIndex; // type index describing function signature
|
||||
} S_HEAPALLOCSITE;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4402
|
||||
struct
|
||||
{
|
||||
uint32_t offsetBase; // Section-relative offset to the base for switch offsets
|
||||
uint16_t sectionBase; // Section index of the base for switch offsets
|
||||
ARMSwitchType switchType; // type of each entry
|
||||
uint32_t offsetBranch; // Section-relative offset to the table branch instruction
|
||||
uint32_t offsetTable; // Section-relative offset to the start of the table
|
||||
uint16_t sectionBranch; // Section index of the table branch instruction
|
||||
uint16_t sectionTable; // Section index of the table
|
||||
uint32_t numEntries; // number of switch table entries
|
||||
} S_ARMSWITCHTABLE;
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4382
|
||||
struct
|
||||
{
|
||||
uint32_t count; // Number of functions
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(uint32_t, funcs); // List of functions, dim == count
|
||||
// uint32_t invocations[CV_ZEROLEN]; Followed by a parallel array of
|
||||
// invocation counts. Counts > reclen are assumed to be zero
|
||||
} S_CALLERS, S_CALLEES, S_INLINEES;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t typeIndex;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
} S_UDT, S_UDT_ST;
|
||||
|
||||
struct
|
||||
{
|
||||
uint32_t unknown1;
|
||||
uint32_t typeIndex;
|
||||
uint32_t unknown2;
|
||||
Register reg;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(char, name);
|
||||
|
||||
} S_REGREL32_INDIR;
|
||||
#pragma pack(pop)
|
||||
} data;
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4576
|
||||
enum class PDB_NO_DISCARD DebugSubsectionKind : uint32_t
|
||||
{
|
||||
S_IGNORE = 0x80000000, // if this bit is set in a subsection type then ignore the subsection contents
|
||||
|
||||
S_SYMBOLS = 0xF1,
|
||||
S_LINES = 0xF2,
|
||||
S_STRINGTABLE = 0xF3,
|
||||
S_FILECHECKSUMS = 0xF4,
|
||||
S_FRAMEDATA = 0xF5,
|
||||
S_INLINEELINES = 0xF6,
|
||||
S_CROSSSCOPEIMPORTS = 0xF7,
|
||||
S_CROSSSCOPEEXPORTS = 0xF8,
|
||||
|
||||
S_IL_LINES = 0xF9,
|
||||
S_FUNC_MDTOKEN_MAP = 0xFA,
|
||||
S_TYPE_MDTOKEN_MAP = 0xFB,
|
||||
S_MERGED_ASSEMBLYINPUT = 0xFC,
|
||||
|
||||
S_COFF_SYMBOL_RVA = 0xFD,
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4596
|
||||
struct DebugSubsectionHeader
|
||||
{
|
||||
DebugSubsectionKind kind;
|
||||
uint32_t size;
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4617
|
||||
struct Line
|
||||
{
|
||||
uint32_t offset; // Offset to start of code bytes for line number
|
||||
uint32_t linenumStart : 24; // line where statement/expression starts
|
||||
uint32_t deltaLineEnd : 7; // delta to line where statement ends (optional)
|
||||
uint32_t fStatement : 1; // true if a statement linenumber, else an expression line num
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4630
|
||||
struct Column
|
||||
{
|
||||
uint16_t start;
|
||||
uint16_t end;
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4601
|
||||
struct LinesHeader
|
||||
{
|
||||
uint32_t sectionOffset;
|
||||
uint16_t sectionIndex;
|
||||
struct
|
||||
{
|
||||
uint16_t fHasColumns : 1;
|
||||
uint16_t pad : 15;
|
||||
} flags;
|
||||
|
||||
uint32_t codeSize;
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4608
|
||||
struct LinesFileBlockHeader
|
||||
{
|
||||
uint32_t fileChecksumOffset;
|
||||
uint32_t numLines;
|
||||
uint32_t size;
|
||||
// Line lines[numLines];
|
||||
// Column columns[numLines]; Might not be present
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvconst.h#L88
|
||||
enum class PDB_NO_DISCARD ChecksumKind : uint8_t
|
||||
{
|
||||
None = 0,
|
||||
MD5 = 1,
|
||||
SHA1 = 2,
|
||||
SHA256 = 3,
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/cvdump/dumpsym7.cpp#L1097
|
||||
struct FileChecksumHeader
|
||||
{
|
||||
uint32_t filenameOffset;
|
||||
uint8_t checksumSize;
|
||||
ChecksumKind checksumKind;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(uint8_t, checksum);
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4822
|
||||
enum class InlineeSourceLineKind : uint32_t
|
||||
{
|
||||
Signature = 0,
|
||||
SignatureEx = 1,
|
||||
};
|
||||
|
||||
struct InlineeSourceLineHeader
|
||||
{
|
||||
InlineeSourceLineKind kind;
|
||||
};
|
||||
|
||||
// https://github.com/microsoft/microsoft-pdb/blob/master/include/cvinfo.h#L4825
|
||||
struct InlineeSourceLine
|
||||
{
|
||||
uint32_t inlinee;
|
||||
uint32_t fileChecksumOffset;
|
||||
uint32_t lineNumber;
|
||||
};
|
||||
|
||||
struct InlineeSourceLineEx
|
||||
{
|
||||
uint32_t inlinee;
|
||||
uint32_t fileChecksumOffset;
|
||||
uint32_t lineNumber;
|
||||
uint32_t extraLines;
|
||||
PDB_FLEXIBLE_ARRAY_MEMBER(uint32_t, extrafileChecksumOffsets);
|
||||
};
|
||||
|
||||
// Combine DebugSubsectionHeader and first subsection header into one struct.
|
||||
struct LineSection
|
||||
{
|
||||
DebugSubsectionHeader header;
|
||||
union
|
||||
{
|
||||
LinesHeader linesHeader;
|
||||
FileChecksumHeader checksumHeader;
|
||||
InlineeSourceLineHeader inlineeHeader;
|
||||
};
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user