请问能否在vscode上单步调试xmake？ #4580

ruiyuanlu · 2024-01-08T09:44:51Z

ruiyuanlu
Jan 8, 2024

问题描述：

我这边尝试在 windows 下用 xmake+vs 编译别人用 cmake 管理的库时遇到一个问题，编译模式只能是 debug/release 。我需要编译出 releasedbg 和 minsizerel 模式的库，但是好像传入的只要不是 debug ，都会生成 release的库，我想单步追踪一下哪里出了问题，但是不知道怎么在 vscode 上启动调试。

我的输入的命令是

xmake f --arch=x64 --trybuild=cmake --kind=shared --mode=releasedbg --vs_runtime=MD --tryconfigs="-DBUILD_SHARED_LIBS=ON"

xmake 输出的 dll 文件和 cmake 生成的 release 版 dll 大小一致，要明显小于 cmake 的 RelWithDebInfo 生成的 dll，因此猜测 xmake 应该实际走的是 release 模式

尝试的步骤

根据文档，我在 vscode 中下载了 xmake 的源码，然后通过 xmake f -m debug 创建 build 目录编译生成了 xmake.exe

问题

我现在比较困惑的是，我要怎么结合我输入的命令，来进行跟踪调试？（打断点和单步）
PS: 我只用过 vscode 所以想请教一下能不能在 vscode 里面调试

Answered by waruqi

Jan 12, 2024

所以我觉得，是不是可以考虑一下增加类似上面的 vs_configuration=RelWIthDebInfo，以及 auto_flags=false，来控制 xmake 是否默认添加 flag，替代这里的注释代码的行为，同时设置 vs 的 configuration来和 cmake 对齐输出路径，这样能方便检查，从而避免这种隐式 bug。这样做可以给用户更大的自由度，已有的 cmake 代码库就完全不需要改动了。

这是特殊 api 设置不会考虑的。而且 cmake 也不只 vs 一个 generator，用户切到 ninja 就没法适用了。。

你想要最大自由度，就自己 os.exec 执行 cmake 命令，完全自主可控。。或者切到 ninja generator 去编译

View full answer

waruqi · 2024-01-08T10:36:23Z

waruqi
Jan 8, 2024
Maintainer

https://xmake.io/#/zh-cn/guide/faq?id=%e6%96%ad%e7%82%b9%e8%b0%83%e8%af%95

0 replies

ruiyuanlu · 2024-01-10T03:24:38Z

ruiyuanlu
Jan 10, 2024
Author

谢谢，经过调试我发现应该是 xmake 里面的 mode 判断用的是 is_debug() and "Debug" or "Release" 所以没有对 releasedbg 做响应。

我现在有多个基础库是基于 cmake 已有的，本身的业务代码需要依赖这些基础库，一个简化的目录结构为

project
|---xmake.lua
|---src
|---include
|---lib
| |---lib1
| | |--- src
| | |--- include
| | |--- CMakeLists.txt
| |---lib2
| | |--- src
| | |--- include
| | |--- CMakeLists.txt

因为每个库里面 CMakeLists.txt 有通用的设置, 比如 -DCMAKE_BUILD_TYPE, 和 -DUSE_MSVC_RUNTIME_LIBRARY_DLL, 的 option 需要设置，也有每个 lib 专用的 option 需要设置，并且根据 project根节点的 mode/vs_runtime/kind 来组合设置

以前的做法是使用 cmake 手工编译每个库，手动设置 option ，待生成 static/dynamic lib 后再编译 project 的源码, 很容易出错而且非常麻烦，想请问能否通过每个lib维护一个 xmake.lua 打通这个手工编译的流程?

我目前想尽可能复用 cmakelists.txt 里面的 option, 想请问一下最佳实践是什么，我目前的想法是

在 project 的根 xmake.lua 中通过调整全局的 mode 和 kind, 通过 includes 包含子 xmake.lua, 设置 add_deps 来约束编译顺序
在lib1-3 的 CMakeLists.txt 同级目录下面写一个 xmake.lua, 手动维护 target
这个手动维护的 target 用于对子项目的 CMakeLists.txt 的option 的组合设置, 主要根据全局的 mode 和 kind, platform 来生成不同的 -Dxx 参数
把生成的 -D 参数通过 trybuild 传给 cmake 生成不同情况下的库文件

目前遇到的问题:

目前对子项目的 target 是这么写的

target("lib1")
    set_kind("static")  -- 固定类型为 static 或 shared  这里不知道怎么写成变化的
    add_imports("core.project.config")  -- 修改 trybuild
    before_build(
        function (pkg)
            print("$(mode)")
            print("$(kind)")
            -- 设置4种构建类型
            local trybuild = "-DCMAKE_BUILD_TYPE=Debug "
            -- 设置 msvc dll 版本
            trybuild = trybuild .. "-DUSE_MSVC_RUNTIME_LIBRARY_DLL=" .. (is_plat("windows") and "ON" or "OFF") .. " "
            -- 设置 lib1 专用的 option
            trybuild = trybuild .. "-DLIB1_USEUSE_OSMESA=" .. (is_kind("shared") and "ON" or "OFF") .. " "
            config.set("trybuild", trybuild)
        end
    )
target_end()

没找到给全局的 lib 设置 kind 的方法，目前只能在每个子项目的 target 中手动修改, 无法做到全局修改 lib 的kind之后所有子项目都生效
脚本中不知道怎么调用 cmake trybuild，复用 cmake 配置的话命令行中可以传 trybuild 相关参数, 但是脚本中不清楚要怎么做，目前给 config里面塞了一个 config.set("trybuild", trybuild) 但是好像不起作用
-DCMAKE_BUILD_TYPE 和 -DUSE_MSVC_RUNTIME_LIBRARY_DLL 这种公共的 trybuildconfigs 不知道怎么能够继承, 目前是每个子项目都是重新写一遍

0 replies

waruqi · 2024-01-10T03:34:36Z

waruqi
Jan 10, 2024
Maintainer

不是有包么，干么不用，参考 xmake-repo 里面的包配置

0 replies

ruiyuanlu · 2024-01-10T06:32:44Z

ruiyuanlu
Jan 10, 2024
Author

去看了一下 package，好像没有 is_releasedbg 这样的 api, 所以是不是可以用 pkg:config("releasedbg") 这种写法来补充对于releasedbg的判断呢？

子工程下的 xmake.lua 改写成这样了

package("lib1")
    add_deps("cmake")
    set_sourcedir(os.scriptdir())
    -- 制定 cmake 安装逻辑
    on_install(
        function (pkg)
            local cfgs = {}
            mode = "Debug"
            if pkg:config("releasedbg") then   -- 这里的写法是OK的吗？
                mode = "RelWithDebInfo"
            elseif pkg:config("release") then
                mode = "Release"
            elseif pkg:config("minsizerel") then  -- 这里的写法是OK的吗？
                mode = "MinSizeRel"
            end
            table.insert(cfgs, "-DCMAKE_BUILD_TYPE=" .. mode)
            table.insert(cfgs, "-DBUILD_SHARED_LIBS=" .. (pkg:config("shared") and "ON" or "OFF"))
            table.insert(cfgs, "-DUSE_MSVC_RUNTIME_LIBRARY_DLL=" .. (pkg:is_plat("windows") and "ON" or "OFF"))
            import("package.tools.cmake").install(pkg, cfgs)
        end
    )
package_end()

2 replies

ruiyuanlu Jan 10, 2024
Author

本地测试的话，mode 不 work, 传入还是只有 Debug 和 Release

            if pkg:config("releasedbg") then   -- 这里不 work
                mode = "RelWithDebInfo"
            elseif pkg:config("release") then
                mode = "Release"
            elseif pkg:config("minsizerel") then  -- 这里不 work
                mode = "MinSize

waruqi Jan 10, 2024
Maintainer

你没定义 add_configs 。。自定义配置自己定义。。add_configs("mode", ...)

ruiyuanlu · 2024-01-11T10:07:39Z

ruiyuanlu
Jan 11, 2024
Author

我自己调了一下，感觉是 xmake 的内部代码只区分了 debug/release 导致对于 releasedbg 不响应，具体可以看下
msbuild.lua 62行和 cmake.lua 796行以及 cmake.lua 864行

由于没有进一步区分编译模式，所以这些地方都写死了 VS 的 -p:Configuration 参数，当传入的不是 debug 时全部按照 release 处理了，结果导致我这边编译库的时候，需要 releasedbg 的编译结果，但是给定了编译模式之后还是输出 release 的编译结果

类似还有 private/action/trybuild/msbuild.lua 的 52行和 39行

我下周看能不能改一下试试，可能会牵扯到 mode() 函数返回的结果，目前我看底层调用的是 is_debug() ，如果要进一步区分编译模式，可能得直接返回字符串

1 reply

waruqi Jan 11, 2024
Maintainer

这个没法进一步细分，暂时也不考虑细分，其实对于 xmake 的 mode 是没有任何内置命名规定的，用户可以随意配置自己的 mode 。。

而 rules 里面的 mode.release / mode.debug / mode.releasedbg 也都是可选的，仅仅只是提供了一些常规 mode，方便用户使用而已，用户完全可以不用。

即使所有包对这些 mode 做了处理，也没法处理用户自定义的 mode 。所以目前对于包，仅仅只是做了 debug/release 区分。

如果你非要包区分处理 releasedbg，可以在包里添加 add_configs("mode", ...) 自定义的mode 配置选项。。然后 add_requires("zlib", {configs = {mode = "releasedbg"}}) 自己传入，然后 on_install 里面，根据 package:config("mode") == "releasedbg" 自己去控制 cmake/autoconf 怎么编译 releasedbg。。

ruiyuanlu · 2024-01-12T04:30:05Z

ruiyuanlu
Jan 12, 2024
Author

目前的确是用 add_configs 来定义的，但是还是对不上，似乎没有这么简单

我目前是把
modules/package/tools/cmake.lua#L864
的 -p:Configuration 固定为 RelWIthDebInfo, 这样输出文件夹的名称是对的上的

但是生成的 vs 项目里面编译参数和 cmake 生成的 vs 项目对不上，编译后生成的文件大小也对不上，对比了一下编译命令，有2个宏在 xmake 生成的 VS 项目的编译命令里没有，分别是 "WIN32" 和 `"_WINDOWS"。

import("package.tools.cmake").install 函数里面会通过 _get_configs 的

table.insert

添加一些给定的默认 cmake 命令行参数，有什么办法可以禁用 xmake 对 cmake 添加默认参数吗？目前猜想是添加的默认参数改变了 cmake 的行为，想调试一下

目前的 package 改成了这样

package("lib1")
    -- 编译 cmake 项目需要 cmake 作为依赖
    add_deps("cmake")
    -- 本地源码目录
    set_sourcedir(os.scriptdir())
    -- 安装目录
    set_installdir(path.join(os.projectdir(), "lib1"))
    -- 总是保持安装
    set_policy("package.install_always", true)
    -- 添加参数
    add_configs("mode", {description = "Library compile mode.", default = "debug", values = {"debug", "releasedbg", "release", "minsizerel"}})
    add_configs("shared", {description = "If enable shared library.", default = false, type = "boolean"})
    add_configs("vs_runtime_dll", {description = "If use MSVC runtime library dll.", default = true, type = "boolean"})

    -- 生成 cmake 安装参数
    on_install(
        function (pkg)
            local cfgs = {}
            -- 将 xmake 的 mode 转换为 cmake 的编译模式
            mode = pkg:config("mode")
            if mode == "debug" then
                cmake_mode = "Debug"
            elseif mode == "releasedbg" then
                cmake_mode = "RelWithDebInfo"
            elseif mode == "release" then
                cmake_mode = "Release"
            elseif mode == "minsizerel" then
                cmake_mode = "MinSizeRel"
            else
                raise("Unknown compile mode: " .. mode)
            end
            -- 设置 xmake 内部参数
            pkg:set("kind", pkg:config("shared") and "shared" or "static")
            -- 生成 cmake 配置参数
            table.insert(cfgs, "-DCMAKE_BUILD_TYPE=" .. cmake_mode)
            table.insert(cfgs, "-DBUILD_SHARED_LIBS=" .. (pkg:config("shared") and "ON" or "OFF"))
            table.insert(cfgs, "-DUSE_MSVC_RUNTIME_LIBRARY_DLL=" .. ((pkg:is_plat("windows") and pkg:config("vs_runtime_dll")) and "ON" or "OFF"))
            import("package.tools.cmake").install(pkg, cfgs)  -- 这里会有什么办法可以禁止 xmake 在这里对 cmake 添加默认参数吗？
        end
    )
package_end()

2 replies

ruiyuanlu Jan 12, 2024
Author

简单起见，我觉得是不是可以借鉴 set_runtimes 这个 api ，增加2个 api 分别用于控制 vs 的 configuration 和 cmake 的命令行参数，剩下的交给用户去控制 configuration 不同的行为，以及 cmake 里面到底要传什么参数。

比如：增加 vs_configuration=RelWIthDebInfo，以及 auto_flags=false

当 vs_configuration 指定时，modules/package/tools/cmake.lua#L864 直接传入指定的 configuration

当 auto_flags=false 时（可以默认是 true），只传入用户手动添加的 cmake 参数，而不再添加 xmake 中的默认参数

package("lib1")
    on_install(
        function (pkg)
            local cfgs = {}
            -- 设置 xmake 内部参数
            pkg:set("vs_configuration", cmake_mode )  -- 告知 xmake 所使用的 configuration
            pkg:set("auto_flags", false)  -- 告知 xmake 不要对 cmake 添加默认参数，全部由用户手动给出
            -- 生成 cmake 配置参数
            table.insert(cfgs, "-DCMAKE_BUILD_TYPE=" .. cmake_mode)
            table.insert(cfgs, "-DBUILD_SHARED_LIBS=" .. (pkg:config("shared") and "ON" or "OFF"))
            table.insert(cfgs, "-DUSE_MSVC_RUNTIME_LIBRARY_DLL=" .. ((pkg:is_plat("windows") and pkg:config("vs_runtime_dll")) and "ON" or "OFF"))
            import("package.tools.cmake").install(pkg, cfgs)  -- install 内部检查vs_configuration和auto_flags，如果没有指定则保持现有处理不变，否则就不对 cfgs 做任何修改，直接传给 cmake
        end
    )
package_end()

waruqi Jan 12, 2024
Maintainer

package.tools.cmake 只是个辅助编译的模块，如果你想高度定制化，你完全可以不用它，自己通过 os.exec("cmake ...") 执行命令处理一切。。目前不会考虑添加这种特殊的 api

ruiyuanlu · 2024-01-12T06:16:05Z

ruiyuanlu
Jan 12, 2024
Author

问题找到了，的确是 xmake 添加的默认 flag 和 cmakelist.txt 中的设置发生冲突产生的 bug，目前修改之后程序编译后的大小是正常的，程序行为也正常了

具体做法是先注释掉 cmake.lua #365-373后，再注释掉 cmake.lua #377，整个 package 的编译就正常了

所以我觉得，是不是可以考虑一下增加类似上面的 vs_configuration=RelWIthDebInfo，以及 auto_flags=false，来控制 xmake 是否默认添加 flag，替代这里的注释代码的行为，同时设置 vs 的 configuration来和 cmake 对齐输出路径，这样能方便检查，从而避免这种隐式 bug。这样做可以给用户更大的自由度，已有的 cmake 代码库就完全不需要改动了。

而且，这个文件下面的 _get_configs_for_android、_get_configs_for_appleos、_get_configs_for_wasm 等函数里面都有类似的写法，很可能也会有这种隐式 bug，不仔细调试其实很难发现，程序不一定会崩，只是可能行为很奇怪。

感觉可以另开一个 issue 来修一下这个问题，您觉得呢？

0 replies

waruqi · 2024-01-12T06:19:15Z

waruqi
Jan 12, 2024
Maintainer

所以我觉得，是不是可以考虑一下增加类似上面的 vs_configuration=RelWIthDebInfo，以及 auto_flags=false，来控制 xmake 是否默认添加 flag，替代这里的注释代码的行为，同时设置 vs 的 configuration来和 cmake 对齐输出路径，这样能方便检查，从而避免这种隐式 bug。这样做可以给用户更大的自由度，已有的 cmake 代码库就完全不需要改动了。

这是特殊 api 设置不会考虑的。而且 cmake 也不只 vs 一个 generator，用户切到 ninja 就没法适用了。。

你想要最大自由度，就自己 os.exec 执行 cmake 命令，完全自主可控。。或者切到 ninja generator 去编译

1 reply

ruiyuanlu Jan 12, 2024
Author

OK，这也是个办法

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

请问能否在vscode上单步调试xmake？ #4580

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 8 comments 6 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

请问能否在vscode上单步调试xmake？ #4580

ruiyuanlu Jan 8, 2024

问题描述：

我的输入的命令是

尝试的步骤

问题

Replies: 8 comments · 6 replies

waruqi Jan 8, 2024 Maintainer

ruiyuanlu Jan 10, 2024 Author

目前遇到的问题:

waruqi Jan 10, 2024 Maintainer

ruiyuanlu Jan 10, 2024 Author

ruiyuanlu Jan 10, 2024 Author

waruqi Jan 10, 2024 Maintainer

ruiyuanlu Jan 11, 2024 Author

waruqi Jan 11, 2024 Maintainer

ruiyuanlu Jan 12, 2024 Author

ruiyuanlu Jan 12, 2024 Author

waruqi Jan 12, 2024 Maintainer

ruiyuanlu Jan 12, 2024 Author

waruqi Jan 12, 2024 Maintainer

ruiyuanlu Jan 12, 2024 Author

ruiyuanlu
Jan 8, 2024

Replies: 8 comments 6 replies

waruqi
Jan 8, 2024
Maintainer

ruiyuanlu
Jan 10, 2024
Author

waruqi
Jan 10, 2024
Maintainer

ruiyuanlu
Jan 10, 2024
Author

ruiyuanlu Jan 10, 2024
Author

waruqi Jan 10, 2024
Maintainer

ruiyuanlu
Jan 11, 2024
Author

waruqi Jan 11, 2024
Maintainer

ruiyuanlu
Jan 12, 2024
Author

ruiyuanlu Jan 12, 2024
Author

waruqi Jan 12, 2024
Maintainer

ruiyuanlu
Jan 12, 2024
Author

waruqi
Jan 12, 2024
Maintainer

ruiyuanlu Jan 12, 2024
Author