调试并步入依赖项

有时,在开发和调试自己的代码时,能够步入依赖项的源代码也可能很有用。有几点需要考虑:

  • 来自 ConanCenter 的 recipe 和包并不总是打包所有必要的调试 artifact。例如在 Windows 中,*.pdb 文件不被打包,因为它们非常大,并且在实践中很少使用。如果你需要,可以让你自己的包打包 PDB 文件,但这仍然无法解决下一点。

  • 调试 artifact 通常不可重定位,这意味着这类 artifact 只能在其从源代码构建的原始位置使用。但上传到服务器并下载到不同机器的包可能会将这些 artifact 放置在不同的文件夹中。这样,调试 artifact 可能无法正确地定位源代码、符号等。

从源代码构建

调试依赖项的推荐方法是在本地缓存中从源代码构建它们。这种方法应该适用于大多数 recipe,包括 ConanCenter 的 recipe。

我们可以重用教程中第一个示例的代码来实现此用例。请先克隆源代码以重新创建此项目。你可以在 GitHub 的 examples2 仓库中找到它们。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/consuming_packages/simple_cmake_project

然后,我们确保依赖项是从源代码构建的。

$ conan install . -s build_type=Debug --build="zlib/*"
...
Install finished successfully

假设我们有 CMake >=3.23,我们可以使用预设(否则,请使用 -DCMAKE_TOOLCHAIN_FILE 参数)。

$ cmake . --preset conan-default

这将创建我们的项目,然后我们可以开始构建和调试。

使用 Visual Studio 步入依赖项

项目创建后,在 Visual Studio 中,我们可以双击 compressor.sln 文件,或者从已打开的 Visual Studio IDE 中打开该文件。

项目打开后,第一步是构建它,确保 Debug 配置处于活动状态,转到 Build -> Build Solution 即可完成。然后我们可以在项目视图中将 compressor 定义为“启动项目”。

转到 compressor/main.c 源文件,我们可以在其中的某一行设置一个断点。

main.c
int main(void) {
    ...

    // add a breakpoint in deflateInit line in your IDE
    deflateInit(&defstream, Z_BEST_COMPRESSION);
    deflate(&defstream, Z_FINISH);

点击 Debug -> Start Debugging(或按 F5),程序将开始调试并在 deflateInit() 行停止。点击 Debug -> Step Into,IDE 应该能够导航到 deflate.c 源代码。如果我们检查这个文件,它的路径将在 Conan 缓存中,例如 C:\Users\<myuser>\.conan2\p\b\zlib4f7275ba0a71f\b\src\deflate.c

deflate.c
int ZEXPORT deflateInit_(strm, level, version, stream_size)
 z_streamp strm;
 int level;
 const char *version;
 int stream_size;
 {
     return deflateInit2_(strm, level, Z_DEFLATED, MAX_WBITS, DEF_MEM_LEVEL,
                         Z_DEFAULT_STRATEGY, version, stream_size);
     /* To do: ignore strm->next_in if we use it as window */
 }

另请参阅

  • 通过这种方法在调试时修改依赖项的源代码是不可能的。如果这是预期的流程,推荐的方法是使用 可编辑包