使用 Android Studio 调试 C++ 库

Posted 2023-03-05

【中文标题】使用 Android Studio 调试 C++ 库

【英文标题】：Debugging C++ library with Android Studio

【发布时间】：2018-10-25 10:07:41

【问题描述】：

我正在开发一个 android 项目，该项目使用 Java 类，该类是 C++ 库的包装器。 C++库是公司内部库，我们可以访问它的源代码，但是在Android项目中它只是动态链接的，所以只能以头文件（.h）的形式使用，共享对象 (.so)。可以访问库源代码，是否可以向 Android Studio 指定源代码的路径，以便我可以使用调试器进入库？

调试器工作正常，我可以进入Java_clory_engine_sdk_CloryNative_nativeInit 函数，但我还想进一步调试与Clory::Engine 类对应的库，正如我所提到的，它是一个我们可以访问源代码的内部库.

例如，Clory::Engine::instance 是库的一部分，我想向 Android Studio 指定CloryEngine.cpp 文件的位置，这样我就可以使用调试器进入Clory::Engine::instance，从而调试这个静态成员函数。

我使用的是 Android Studio 3.1.4。

这可能吗？

编辑：

clory-sdk.gradle 文件指定了配置 C++ 层的CMakeLists.txt 文件。

externalNativeBuild 
    cmake 
        path "CMakeLists.txt"
    

所以我正在使用一个使用 Clory SDK 的内部应用程序。在我使用的app.gradle 文件中：

dependencies 
...
    compile project(':clory-sdk-core')
    compile project(':clory-sdk')
...

所以我认为我们不会将aars 用于app.gradle 项目。 aars 已发送到客户端，但在此之前我们正在使用 app.gradle 项目来测试我们的小 SDK 功能。 JNI 层位于 clory-sdk-core 项目内。

编辑 2：

这是处理 JNI 层的CMakeLists.txt：

cmake_minimum_required(VERSION 3.4.1)

set(CMAKE_AUTOMOC ON)
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_BUILD_TYPE Debug)

add_library(
    clory-lib
    SHARED
    # JNI layer and other helper classes for transferring data from Java to Qt/C++
    src/main/cpp/clory-lib.cpp
    src/main/cpp/JObjectHandler.cpp
    src/main/cpp/JObjectResolver.cpp
    src/main/cpp/JObjectCreator.cpp
    src/main/cpp/DataConverter.cpp
    src/main/cpp/JObjectHelper.cpp
    src/main/cpp/JEnvironmentManager.cpp
)

find_library(
    log-lib
    log
)

target_compile_options(clory-lib
    PUBLIC
        -std=c++11
)

# Hardcoded for now...will fix later...
set(_QT_ROOT_PATH /Users/jacob/Qt/5.8)

if($ANDROID_ABI MATCHES ^armeabi-v7.*$)
    set(_QT_ARCH android_armv7)
elseif($ANDROID_ABI MATCHES ^x86$)
    set(_QT_ARCH android_x86)
else()
    message(FATAL_ERROR "Unsupported Android architecture!!!")
endif()

set(CMAKE_FIND_ROOT_PATH $_QT_ROOT_PATH/$_QT_ARCH)

find_package(Qt5 REQUIRED COMPONENTS
    Core
    CONFIG
)

target_include_directories(clory-lib
    PUBLIC
        $CMAKE_CURRENT_LIST_DIR/src/main/cpp
)

set(_CLORYSDK_LIB_PATH $CMAKE_CURRENT_LIST_DIR/src/main/jniLibs/$ANDROID_ABI)

target_link_libraries(clory-lib
    $log-lib
    -L$_CLORYSDK_LIB_PATH
    clorysdk
    Qt5::Core
)

库clorysdk 实际上是我所说的我们内部的库，它包含例如Clory::Engine::instance 我想进入调试器。它是使用qmake 构建的，并且是在调试模式下构建的（CONFIG+=debug 已添加到有效的 qmake 调用中）。

编辑 3：

在遇到Java_clory_engine_sdk_CloryNative_nativeInit 断点后打开的LLDB 会话中，我得到以下信息：

(lldb) image lookup -vrn Clory::Engine::instance
2 matches found in /Users/jacob/.lldb/module_cache/remote-android/.cache/6EDE4F0A-0000-0000-0000-000000000000/libclorysdk.so:
        Address: libclorysdk.so[0x0001bb32] (libclorysdk.so..text + 8250)
        Summary: libclorysdk.so`Clory::Engine::instance(Clory::Engine::Purpose)
         Module: file = "/Users/jacob/.lldb/module_cache/remote-android/.cache/6EDE4F0A-0000-0000-0000-000000000000/libclorysdk.so", arch = "arm"
         Symbol: id = 0x0000005e, range = [0xcb41eb32-0xcb41ebc0), name="Clory::Engine::instance(Clory::Engine::Purpose)", mangled="_ZN4Clory2Engine8instanceENS0_7PurposeE"
        Address: libclorysdk.so[0x0001b82c] (libclorysdk.so..text + 7476)
        Summary: libclorysdk.so`Clory::Engine::instance(Clory::RuntimeConfiguration const&, Clory::Engine::Purpose)
         Module: file = "/Users/jacob/.lldb/module_cache/remote-android/.cache/6EDE4F0A-0000-0000-0000-000000000000/libclorysdk.so", arch = "arm"
         Symbol: id = 0x000000bd, range = [0xcb41e82c-0xcb41e970), name="Clory::Engine::instance(Clory::RuntimeConfiguration const&, Clory::Engine::Purpose)", mangled="_ZN4Clory2Engine8instanceERKNS_20RuntimeConfigurationENS0_7PurposeE"

(lldb) settings show target.source-map
target.source-map (path-map) =

首先，命令image lookup -vrn Clory::Engine::instance 的结果中没有CompileUnit 部分。如果libclorysdk.so 是在Debug 模式下构建的，这怎么可能没有定义source-map（第二个lldb 命令）？是否可以显式设置它以便调试器在那里搜索库的源文件？

编辑 4：

在搜索了更多之后，我发现创建 APK 的过程实际上从调试符号中去除了 *.so 库。 libclorysdk.so 内置调试​​模式大约有 10MB，而我在解压缩生成的 *.apk 文件后提取的 libclorysdk.so 文件只有 350KB。 如here 所述，在调试版本上运行greadelf --debug-dump=decodedline libclorysdk.so 会输出对源文件的引用，但如果在*.apk 提取的库上运行该命令，则不会输出任何内容。

有没有办法阻止 Android Studio 剥离 *.sos？我试过How to avoid stripping for native code symbols for android app但没有任何效果，*.apk文件大小和以前一样，调试本机库仍然不起作用。

我正在使用Gradle 3.1.4。

编辑 5：

stripping solution 有效，但在我的情况下，它需要一个 Clean & Build 才能到达库中的断点。部署未剥离的*.sos 允许您进行调试会话并进入本机库。

注意：

如果库是使用Qt for Android 工具链构建的，那么部署到$SHADOW_BUILD/android-build 的*.sos 也会被剥离（其中$SHADOW_BUILD 是构建目录，通常以build-* 开头）。因此，为了调试这些，您应该从生成每个*.so 的android-build 目录之外复制它们。

【问题讨论】：

您使用的是预构建共享库的调试版本吗？如果是这样，进入该库中的代码应该可以工作。

@Michael 我正在使用预构建共享库的调试版本。但是源代码不在使用共享库的项目中。所以它不知道在哪里搜索源代码（我假设），除非我告诉它在哪里搜索。我不知道该怎么做。我记得如果你想进入 Visual Studio 中的库，你会看到一个对话框，让你浏览与你正在进入的函数相对应的源文件，如下所示：i.imgur.com/doPgOs4.png 我期望某种功能给你类似的东西......

我自己做了一个小测试，从另一个项目进入预建共享库中的代码对我来说效果很好。但是，我只在同一台机器上构建两个项目的情况下对此进行了测试。与构建共享库的机器相比，您机器上的项目结构可能看起来不同？您可以尝试运行readelf --string-dump=.debug_str mylib.so 来查看源文件应该存在的位置。

@Michael 非常感谢您的回答。嗯...今晚我将构建一个小项目，我将尝试在较小的范围内重现我的场景，并让您知道我发现了什么。

您的项目有ndk 或cmake 配置吗？还是您正在使用的 lib 打包为 aar？

【参考方案1】：

调试信息记录了源文件在构建时的位置。

(lldb) image lookup -vrn Clory::Engine::instance

CompileUnit 行显示源文件。假设它说：

"/BuildDirectory/Sources/Clory/CloryEngine.cpp"

假设您的机器上有源代码：

"Users/me/Sources/Clory"

所以你可以告诉 lldb：在 Users/me/Sources/Clory 中找到根目录为 /BuildDirectory/Sources/Clory 的源文件。

(lldb) settings set target.source-map /BuildDirectory/Sources/Clory Users/me/Sources/Clory

您可以在 Android Studio 的 lldb 控制台中使用这些命令，也可以放入 .lldbinit 文件中以供一般使用。

【讨论】：

非常感谢您的回答！我跑了$ lldb libclorysdk.so，然后我跑了(lldb) image lookup -vrn Clory::Engine::instance，我只得到了4个部分：Address、Summary、Module和Symbol。它看起来像这样：pastebin.com/2wBrD1nJ 知道为什么我没有得到CompileUnit 信息吗？我的库都是在调试模式下构建的。

看来libclorysdk.so没有调试信息。尝试使用调试信息重建 sdk 或使用 sdk 的调试版本（如果可用）。在 Android Studio 中使用这些 lldb 命令。在Java_clory_engine_sdk_CloryNative_nativeInit 函数中设置断点。开始调试。当你在断点处停止时，使用 Android Studio 的 lldb 窗口运行上面的 lldb 命令。

【参考方案2】：

如果没有可用的调试符号，您可能必须在调试模式下构建引用的库。

-DCMAKE_BUILD_TYPE=DEBUG:

defaultConfig 
    externalNativeBuild 
        cmake 
            arguments "-DANDROID_TOOLCHAIN=gcc", "-DCMAKE_BUILD_TYPE=DEBUG"
            cppFlags "-std=c++14 -fexceptions -frtti"
        
    


externalNativeBuild 
    cmake 
        path file('src/main/cpp/CMakeLists.txt')
    

或将此添加到库的CMakeLists.txt：

set(CMAKE_BUILD_TYPE Debug)

请参阅CMake 文档和Symbolicating with LLDB。

elsewhere 它解释了(lldb) settings set target.source-map /buildbot/path /my/path：

重新映射调试会话的源文件路径名。 如果您的源文件不再位于与程序构建时相同的位置 --- 可能程序是在不同的计算机上构建的 --- 您需要告诉调试器如何找到源文件位于其本地文件路径，而不是构建系统的文件路径。

还有(lldb) settings show target.source-map，查看映射的内容。 (lldb) set append target.source-map /buildbot/path /my/path 似乎相当合适，以免覆盖现有映射。

【讨论】：

非常感谢您的回答！我在处理 JNI 层的 android 项目中将set(CMAKE_BUILD_TYPE Debug) 添加到我的CMakeLists.txt 中。我还确保我的所有库都是在调试模式下构建的，因为库是使用CONFIG+=debug 构建的（我使用Qt 5.8 和GCC 4.9 - 我认为这并不重要，因为我读到，调试@ 987654336@ 编译代码应该可以使用lldb)。现在我是在 Android 中桥接 C++ 和 Java 的新手，我可能会犯愚蠢的错误并提出愚蠢的问题。这就是我正在做的事情：在 Android Studio 终端中，我运行 $ lldb libclorysdk.so。

问题是当我运行然后(lldb) settings show target.source-map 我收到以下消息：target.source-map (path-map) =。这意味着没有路径与该变量相关联（我想）。现在我尝试了settings set target.source-map "" /Users/jacob/Work/clory/sdk/native/sdk/base(base 文件夹是生成我的libclorysdk.so 库的项目的位置，即 qmake .pro 项目文件的位置)，当我运行(lldb) settings show target.source-map我得到target.source-map (path-map) = [0] "" -> "/Users/jacob/Work/clory/sdk/native/sdk/base"。

此时我仍然无法使用调试器进入Clory::Engine::instance。我还尝试将键（“->”之前的值）设置为我的libclorysdk.so（位于android项目内）的路径，并将值（“->”之后的值）设置为我的路径clory 库 sdk 源代码；所以当我运行(lldb) settings show target.source-map 时，我得到target.source-map (path-map) = [0] "/Users/jacob/Work/clory/sdk/android/clory-sdk-core/src/main/jniLibs/armeabi-v7a" -> "/Users/jacob/Work/clory/sdk/native/sdk/"。

此时我运行调试器时仍然无法进入Clory::Engine::instance。另一个我认为重要的事情是，当我使用(lldb) exit 退出lldb 并再次运行$ libclorysdk.so 时，所有映射都消失了；所以操作不是持久的。我可能做错了什么？

@zwcloud 您需要将arguments 添加到defaultConfig > externalNativeBuild > cmake > arguments... 以及CMakeLists.txt 的路径在defaultConfig 之外。我已经更新了我的答案，以使这一点更清楚。