返回介绍

5.5 构建时为特定目标运行自定义命令

发布于 2025-05-06 21:45:56 字数 4379 浏览 0 评论 0 收藏

NOTE : 此示例代码可以在 https://github.com/dev-cafe/cmake-cookbook/tree/v1.0/chapter-5/recipe-05 中找到,其中包含一个 Fortran 例子。该示例在 CMake 3.5 版(或更高版本) 中是有效的,并且已经在 GNU/Linux、macOS 和 Windows 上进行过测试。

本节示例将展示,如何使用 add_custom_command 的第二个参数,来执行没有输出的自定义操作,这对于构建或链接特定目标之前或之后执行某些操作非常有用。由于自定义命令仅在必须构建目标本身时才执行,因此我们实现了对其执行的目标级控制。我们将通过一个示例来演示,在构建目标之前打印目标的链接,然后在编译后,立即测量编译后,可执行文件的静态分配大小。

准备工作

本示例中,我们将使用 Fortran 代码( example.f90 ):

program example
​
  implicit none
​
  real(8) :: array(20000000)
  real(8) :: r
  integer :: i
​
  do i = 1, size(array)
    call random_number(r)
    array(i) = r
  end do
​
  print *, sum(array)
​
end program

虽然我们选择了 Fortran,但 Fortran 代码的对于后面的讨论并不重要,因为有很多遗留的 Fortran 代码,存在静态分配大小的问题。

这段代码中,我们定义了一个包含 20,000,000 双精度浮点数的数组,这个数组占用 160MB 的内存。在这里,我们并不是推荐这样的编程实践。一般来说,这些内存的分配和代码中是否使用这段内存无关。一个更好的方法是只在需要时动态分配数组,随后立即释放。

示例代码用随机数填充数组,并计算它们的和 - 这样是为了确保数组确实被使用,并且编译器不会优化分配。我们将使用 Python 脚本( static-size.py ) 来统计二进制文件静态分配的大小,该脚本用 size 命令来封装:

import subprocess
import sys
​
# for simplicity we do not check number of
# arguments and whether the file really exists
file_path = sys.argv[-1]
try:
    output = subprocess.check_output(['size', file_path]).decode('utf-8')
except FileNotFoundError:
    print('command "size" is not available on this platform')
    sys.exit(0)
​
size = 0.0
for line in output.split('\n'):
    if file_path in line:
        # we are interested in the 4th number on this line
        size = int(line.split()[3])
​
print('{0:.3f} MB'.format(size/1.0e6))

要打印链接行,我们将使用第二个 Python helper 脚本( echo-file.py ) 打印文件的内容:

import sys
​
# for simplicity we do not verify the number and
# type of arguments
file_path = sys.argv[-1]
try:
    with open(file_path, 'r') as f:
print(f.read())
except FileNotFoundError:
    print('ERROR: file {0} not found'.format(file_path))

具体实施

来看看 CMakeLists.txt

  1. 首先声明一个 Fortran 项目:
    cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
    project(recipe-05 LANGUAGES Fortran)
  2. 例子依赖于 Python 解释器,所以以一种可移植的方式执行 helper 脚本:
    find_package(PythonInterp REQUIRED)
  3. 本例中,默认为“Release”构建类型,以便 CMake 添加优化标志:
    if(NOT CMAKE_BUILD_TYPE)
        set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
    endif()
  4. 现在,定义可执行目标:
    add_executable(example "")
    ​
    target_sources(example
      PRIVATE
          example.f90
      )
  5. 然后,定义一个自定义命令,在 example 目标在已链接之前,打印链接行:
    add_custom_command(
      TARGET
          example
      PRE_LINK
          COMMAND
              ${PYTHON_EXECUTABLE}
              ${CMAKE_CURRENT_SOURCE_DIR}/echo-file.py
                ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/example.dir/link.txt
      COMMENT
          "link line:"
      VERBATIM
      )
  6. 测试一下。观察打印的链接行和可执行文件的静态大小:
    $ mkdir -p build
    $ cd build
    $ cmake ..
    $ cmake --build .
    ​
    Scanning dependencies of target example
    [ 50%] Building Fortran object CMakeFiles/example.dir/example.f90.o
    [100%] Linking Fortran executable example
    link line:
    /usr/bin/f95 -O3 -DNDEBUG -O3 CMakeFiles/example.dir/example.f90.o -o example
    static size of executable:
    160.003 MB
    [100%] Built target example

工作原理

当声明了库或可执行目标,就可以使用 add_custom_command 将其他命令锁定到目标上。这些命令将在特定的时间执行,与它们所附加的目标的执行相关联。CMake 通过以下选项,定制命令执行顺序:

  • PRE_BUILD :在执行与目标相关的任何其他规则之前执行的命令。
  • PRE_LINK :使用此选项,命令在编译目标之后,调用链接器或归档器之前执行。Visual Studio 7 或更高版本之外的生成器中使用 PRE_BUILD 将被解释为 PRE_LINK
  • POST_BUILD :如前所述,这些命令将在执行给定目标的所有规则之后运行。

本例中,将两个自定义命令绑定到可执行目标。 PRE_LINK 命令将 ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/example.dir/link.txt 的内容打印到屏幕上。在我们的例子中,链接行是这样的:

link line:
/usr/bin/f95 -O3 -DNDEBUG -O3 CMakeFiles/example.dir/example.f90.o -o example

使用 Python 包装器来实现这一点,它依赖于 shell 命令。

第二步中, POST_BUILD 自定义命令调用 Python helper 脚本 static-size.py ,生成器表达式 $<target_file:example> 作为参数。CMake 将在生成时(即生成生成系统时) 将生成器表达式扩展到目标文件路径。然后,Python 脚本 static-size.py 使用 size 命令获取可执行文件的静态分配大小,将其转换为 MB,并打印结果。我们的例子中,获得了预期的 160 MB:

static size of executable:
160.003 MB

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。