Autotools

Autotools 构建助手是对 autotools 命令行调用的封装。它会将诸如 ./configuremake 这样的调用抽象成 Python 方法调用。

用法

from conan import ConanFile
from conan.tools.gnu import Autotools

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"

    def build(self):
        autotools = Autotools(self)
        autotools.configure()
        autotools.make()

它会读取由 AutotoolsToolchain 生成的 conanbuild.conf 文件,以了解调用 configure 和 make 脚本所需的参数。

  • configure_args:用于调用 configure 脚本的参数。

  • make_args:用于调用 make 脚本的参数。

参考

class Autotools(conanfile, namespace=None)
参数:
  • conanfile – 当前的配方对象。始终使用 self

  • namespace – 当你在同一个配方中有多个 toolchain 调用时,此参数可以避免冲突。通过设置此参数,用于将信息传递给 toolchain 的 conanbuild.conf 文件将被命名为:<namespace>_conanbuild.conf。默认值为 None,表示生成的文件名为 conanbuild.conf。在 AutotoolsToolchain 的构造函数中也必须使用相同的命名空间值,以便它能够从正确的文件中读取信息。

configure(build_script_folder=None, args=None)

调用 configure 脚本。

参数:
  • args – 用于 configure 调用的参数列表。

  • build_script_folder – configure 脚本所在的子文件夹。如果未指定,则使用 conanfile.source_folder。

make(target=None, args=None, makefile=None)

调用 make 程序。

参数:
  • target – (可选,默认为 None):选择要构建的目标。这允许为某些 AutoTools 项目构建例如文档、共享库或安装。

  • args – (可选,默认为 None):用于 make 调用的参数列表。

  • makefile – (可选,默认为 None):允许指定一个自定义的 makefile 来代替默认的 “Makefile”。

install(args=None, target=None, makefile=None)

这只是 self.make(target="install")self.make(target="install-strip") 的一个“别名”。

参数:
  • args – (可选,默认为 None):用于 make 调用的参数列表。默认情况下,如果传递的值为 None,则会向调用中添加一个参数 DESTDIR=unix_path(self.package_folder)。有关 tools.microsoft.unix_path() 函数 的更多信息。

  • target – (可选,默认为 None):选择要安装的目标。

  • makefile – (可选,默认为 None):允许指定一个自定义的 makefile 来代替默认的 “Makefile”。

autoreconf(build_script_folder=None, args=None)

调用 autoreconf

参数:
  • args – (可选,默认为 None):用于 autoreconf 调用的参数列表。

  • build_script_folder – configure 脚本所在的子文件夹。如果未指定,则使用 conanfile.source_folder。

conf

Autotools 构建助手受这些 [conf] 变量的影响。

  • tools.gnu:make_program 允许定义正在使用的 make 可执行文件。对于 MinGW 构建,这将默认为 mingw32-make,对于任何其他构建,则默认为 make

  • tools.build:install_strip (Conan 2.20.0 起) 将在 Autotools.install() 方法中定义 make install-strip 目标(如果设置为 True),否则将使用 make install 目标。

关于在 macOS 上使用 Autotools 构建助手构建的可重定位共享库的说明

在 macOS 上使用 Autotools 构建共享库时,会在 .dylib 文件中添加一个 LC_ID_DYLIB 段和另一个 LC_LOAD_DYLIB 段。这些段存储 install_name 信息,即库或其依赖项安装的文件夹位置。您可以使用 otool 命令检查共享库的 install_name。

$ otool -l path/to/libMyLib.dylib
...
cmd LC_ID_DYLIB
    cmdsize 48
        name path/to/libMyLib.dylib (offset 24)
time stamp 1 Thu Jan  1 01:00:01 1970
    current version 1.0.0
compatibility version 1.0.0
...
Load command 11
        cmd LC_LOAD_DYLIB
    cmdsize 48
        name path/to/dependency.dylib (offset 24)
time stamp 2 Thu Jan  1 01:00:02 1970
    current version 1.0.0
compatibility version 1.0.0
...

为什么这在使用 Conan 时是个问题?

当使用 Conan 时,库将在本地缓存中构建,这意味着此位置将指向 Conan 的本地缓存文件夹,库已安装在该文件夹中。这个位置是库告知任何其他使用它的二进制文件在运行时在哪里加载它的。这是一个问题,因为您可以在一台机器上构建共享库,然后将其上传到服务器并在另一台机器上安装以使用它。在这种情况下,按照 Autotools 的默认行为,您会得到一个库存储了一个指向当前机器上不存在的文件夹的 install_name,因此在构建时会出现链接器错误。

如何在 Conan 中解决这个问题

Conan 可以做的让这些共享库可重定位的唯一方法是在安装后修补构建的二进制文件。为此,当使用 Autotools 构建助手并在运行 Makefile 的 install() 步骤后,您可以使用 fix_apple_shared_install_name() 工具来查找构建的 .dylib 文件,并通过运行 install_name_tool macOS 工具来修补它们,如下所示:

from conan.tools.apple import fix_apple_shared_install_name
class HelloConan(ConanFile):
  ...
  def package(self):
      autotools = Autotools(self)
      autotools.install()
      fix_apple_shared_install_name(self)

这将更改 .dylib 文件中 LC_ID_DYLIBLC_LOAD_DYLIB 段的值为:

$ otool -l path/to/libMyLib.dylib
...
cmd LC_ID_DYLIB
    cmdsize 48
        name @rpath/libMyLib.dylib (offset 24)
time stamp 1 Thu Jan  1 01:00:01 1970
    current version 1.0.0
compatibility version 1.0.0
...
Load command 11
        cmd LC_LOAD_DYLIB
    cmdsize 48
        name @rpath/dependency.dylib (offset 24)
time stamp 2 Thu Jan  1 01:00:02 1970
    current version 1.0.0
compatibility version 1.0.0

@rpath 特殊关键字将告诉加载器搜索一个路径列表来查找库。这些路径可以由库的消费者定义,方法是定义 LC_RPATH 字段。当构建库的消费者时,可以通过传递 -Wl,-rpath -Wl,/path/to/libMyLib.dylib 链接器标志来完成。然后,如果 Conan 构建了一个消耗 libMyLib.dylib 库的可执行文件,它将自动添加 -Wl,-rpath -Wl,/path/to/libMyLib.dylib 标志,以便在构建时正确找到该库。