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** – 此参数避免在同一个配方中有多个工具链调用时发生冲突。通过设置此参数,用于将信息传递给工具链的 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)

调用 make 程序。

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

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

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

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

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

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

autoreconf(build_script_folder=None, args=None)

调用 autoreconf

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

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

关于在 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 标志,以便在构建时正确找到库。