1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
--!A cross-platform build utility based on Lua
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
-- Copyright (C) 2015-present, Xmake Open Source Community.
--
-- @author ruki
-- @file dynamic_debugging.lua
--
-- imports
import("core.project.project")
import("core.tool.toolchain")
import("core.base.semver")
-- add dynamic debugging support
-- @see https://devblogs.microsoft.com/cppblog/cpp-dynamic-debugging-full-debuggability-for-optimized-builds/
-- https://github.com/xmake-io/xmake/issues/6258
function main(target, sourcekind)
-- check if dynamic debugging is enabled
local enabled = target:policy("build.c++.dynamic_debugging")
if enabled == nil then
enabled = project.policy("build.c++.dynamic_debugging")
end
if not enabled then
return
end
-- only support Windows platform
if not target:is_plat("windows") then
return
end
-- only support x64 architecture
if not target:is_arch("x64", "x86_64") then
wprint("C++ Dynamic Debugging only supports x64 architecture, current arch: %s", target:arch())
return
end
-- check MSVC toolchain (only support cl, not clang-cl or clang)
if not target:has_tool(sourcekind, "cl") then
return
end
-- check MSVC version (requires Visual Studio 2022 Version 17.14 Preview 2+, toolset 14.44+)
local msvc = target:toolchain("msvc")
if not msvc or not msvc:check() then
wprint("MSVC toolchain not found for C++ Dynamic Debugging")
return
end
local vcvars = msvc:config("vcvars")
if not vcvars or not vcvars.VCToolsVersion then
wprint("MSVC VCToolsVersion not found for C++ Dynamic Debugging")
return
end
local version = vcvars.VCToolsVersion
if not version or semver.compare(version, "14.44") < 0 then
wprint("C++ Dynamic Debugging requires Visual Studio 2022 Version 17.14 Preview 2+ (MSVC toolset 14.44+), found: %s", version or "unknown")
return
end
-- check incompatible optimizations
local has_lto = target:policy("build.optimization.lto") or project.policy("build.optimization.lto")
if has_lto then
wprint("C++ Dynamic Debugging is incompatible with LTO, disabling LTO")
target:set("policy", "build.optimization.lto", false)
end
-- check for /GL flag (added by optimize="smallest")
local optimize = target:get("optimize")
if optimize == "smallest" then
wprint("C++ Dynamic Debugging is incompatible with optimize=\"smallest\" (which adds /GL flag), consider using optimize=\"fastest\" or optimize=\"faster\" instead")
end
-- /dynamicdeopt requires debug symbols (/Zi or /Z7)
if not target:get("symbols") then
target:set("symbols", "debug")
end
-- get flag name for sourcekind (only support cc and cxx)
local cflag = sourcekind == "cxx" and "cxxflags" or "cflags"
-- add /dynamicdeopt compiler flag
target:add(cflag, "/dynamicdeopt", {force = true})
-- add /DYNAMICDEOPT linker flag
target:add("ldflags", "/DYNAMICDEOPT", {force = true})
target:add("shflags", "/DYNAMICDEOPT", {force = true})
end
|
