bazel/rules_foreign_cc
2
0
Fork 0
mirror of https://github.com/bazel-contrib/rules_foreign_cc synced 2024-11-29 12:33:51 +00:00
Code Issues Releases Activity
rules_foreign_cc/docs/README.md

51 KiB
Raw Blame History

Rules ForeignCc Docs

Up to date documentation can be found at: https://bazel-contrib.github.io/rules_foreign_cc/

Legacy documentation

The sections below exist to maintain links to the previous build rules. Again, the link above should be used instead.

boost_build

boost_build(name, additional_inputs, additional_tools, alwayslink, bootstrap_options, data, defines,
            deps, env, lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs,
            out_headers_only, out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs,
            out_static_libs, postfix_script, tools_deps, user_options)

Rule for building Boost. Invokes bootstrap.sh and then b2 install.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
additional_inputs Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl. List of labels optional []
additional_tools Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl. List of labels optional []
alwayslink Optional. if true, link all the object files from the static library, even if they are not used. Boolean optional False
bootstrap_options any additional flags to pass to bootstrap.sh List of strings optional []
data Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. List of labels optional []
defines Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. List of strings optional []
deps Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule) List of labels optional []
env Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. Dictionary: String -> String optional {}
lib_name Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. String optional ""
lib_source Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. Label required
linkopts Optional link options to be passed up to the dependencies of this library List of strings optional []
out_bin_dir Optional name of the output subdirectory with the binary files, defaults to 'bin'. String optional "bin"
out_binaries Optional names of the resulting binaries. List of strings optional []
out_data_dirs Optional names of additional directories created by the build that should be declared as bazel action outputs List of strings optional []
out_headers_only Flag variable to indicate that the library produces only headers Boolean optional False
out_include_dir Optional name of the output subdirectory with the header files, defaults to 'include'. String optional "include"
out_interface_libs Optional names of the resulting interface libraries. List of strings optional []
out_lib_dir Optional name of the output subdirectory with the library files, defaults to 'lib'. String optional "lib"
out_shared_libs Optional names of the resulting shared libraries. List of strings optional []
out_static_libs Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed List of strings optional []
postfix_script Optional part of the shell script to be added after the make commands String optional ""
tools_deps Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries. List of labels optional []
user_options any additional flags to pass to b2 List of strings optional []

cmake

cmake(name, additional_inputs, additional_tools, alwayslink, build_args, cache_entries, data,
      defines, deps, env, env_vars, generate_args, generate_crosstool_file, install, install_args,
      lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_headers_only,
      out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
      postfix_script, targets, tools_deps, working_directory)

Rule for building external library with CMake.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
additional_inputs Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl. List of labels optional []
additional_tools Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl. List of labels optional []
alwayslink Optional. if true, link all the object files from the static library, even if they are not used. Boolean optional False
build_args Arguments for the CMake build command List of strings optional []
cache_entries CMake cache entries to initialize (they will be passed with -Dkey=value) Values, defined by the toolchain, will be joined with the values, passed here. (Toolchain values come first) Dictionary: String -> String optional {}
data Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. List of labels optional []
defines Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. List of strings optional []
deps Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule) List of labels optional []
env Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. Dictionary: String -> String optional {}
env_vars CMake environment variable values to join with toolchain-defined. For example, additional CXXFLAGS. Dictionary: String -> String optional {}
generate_args Arguments for CMake's generate command. Arguments should be passed as key/value pairs. eg: ["-G Ninja", "--debug-output", "-DFOO=bar"]. Note that unless a generator (-G) argument is provided, the default generators are Unix Makefiles for Linux and MacOS and Ninja for Windows. List of strings optional []
generate_crosstool_file When True, CMake crosstool file will be generated from the toolchain values, provided cache-entries and env_vars (some values will still be passed as -Dkey=value and environment variables). If CMAKE_TOOLCHAIN_FILE cache entry is passed, specified crosstool file will be used When using this option to cross-compile, it is required to specify CMAKE_SYSTEM_NAME in the cache_entries Boolean optional True
install If True, the cmake --install comand will be performed after a build Boolean optional True
install_args Arguments for the CMake install command List of strings optional []
lib_name Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. String optional ""
lib_source Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. Label required
linkopts Optional link options to be passed up to the dependencies of this library List of strings optional []
out_bin_dir Optional name of the output subdirectory with the binary files, defaults to 'bin'. String optional "bin"
out_binaries Optional names of the resulting binaries. List of strings optional []
out_data_dirs Optional names of additional directories created by the build that should be declared as bazel action outputs List of strings optional []
out_headers_only Flag variable to indicate that the library produces only headers Boolean optional False
out_include_dir Optional name of the output subdirectory with the header files, defaults to 'include'. String optional "include"
out_interface_libs Optional names of the resulting interface libraries. List of strings optional []
out_lib_dir Optional name of the output subdirectory with the library files, defaults to 'lib'. String optional "lib"
out_shared_libs Optional names of the resulting shared libraries. List of strings optional []
out_static_libs Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed List of strings optional []
postfix_script Optional part of the shell script to be added after the make commands String optional ""
targets A list of targets with in the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set List of strings optional []
tools_deps Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries. List of labels optional []
working_directory Working directory, with the main CMakeLists.txt (otherwise, the top directory of the lib_source label files is used.) String optional ""

cmake_tool

cmake_tool(name, srcs)

Rule for building CMake. Invokes bootstrap script and make install.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
srcs The target containing the build tool's sources Label required

configure_make

configure_make(name, additional_inputs, additional_tools, alwayslink, args, autoconf,
               autoconf_env_vars, autoconf_options, autogen, autogen_command, autogen_env_vars,
               autogen_options, autoreconf, autoreconf_env_vars, autoreconf_options,
               configure_command, configure_env_vars, configure_in_place, configure_options, data,
               defines, deps, env, install_prefix, lib_name, lib_source, linkopts, make_commands,
               out_bin_dir, out_binaries, out_data_dirs, out_headers_only, out_include_dir,
               out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs, postfix_script,
               targets, tools_deps)

Rule for building external libraries with configure-make pattern. Some 'configure' script is invoked with --prefix=install (by default), and other parameters for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies. After configuration, GNU Make is called.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
additional_inputs Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl. List of labels optional []
additional_tools Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl. List of labels optional []
alwayslink Optional. if true, link all the object files from the static library, even if they are not used. Boolean optional False
args A list of arguments to pass to the call to make List of strings optional []
autoconf Set to True if 'autoconf' should be invoked before 'configure', currently requires configure_in_place to be True. Boolean optional False
autoconf_env_vars Environment variables to be set for 'autoconf' invocation. Dictionary: String -> String optional {}
autoconf_options Any options to be put in the 'autoconf.sh' command line. List of strings optional []
autogen Set to True if 'autogen.sh' should be invoked before 'configure', currently requires configure_in_place to be True. Boolean optional False
autogen_command The name of the autogen script file, default: autogen.sh. Many projects use autogen.sh however the Autotools FAQ recommends bootstrap so we provide this option to support that. String optional "autogen.sh"
autogen_env_vars Environment variables to be set for 'autogen' invocation. Dictionary: String -> String optional {}
autogen_options Any options to be put in the 'autogen.sh' command line. List of strings optional []
autoreconf Set to True if 'autoreconf' should be invoked before 'configure.', currently requires configure_in_place to be True. Boolean optional False
autoreconf_env_vars Environment variables to be set for 'autoreconf' invocation. Dictionary: String -> String optional {}
autoreconf_options Any options to be put in the 'autoreconf.sh' command line. List of strings optional []
configure_command The name of the configuration script file, default: configure. The file must be in the root of the source directory. String optional "configure"
configure_env_vars Environment variables to be set for the 'configure' invocation. Dictionary: String -> String optional {}
configure_in_place Set to True if 'configure' should be invoked in place, i.e. from its enclosing directory. Boolean optional False
configure_options Any options to be put on the 'configure' command line. List of strings optional []
data Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. List of labels optional []
defines Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. List of strings optional []
deps Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule) List of labels optional []
env Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. Dictionary: String -> String optional {}
install_prefix Install prefix, i.e. relative path to where to install the result of the build. Passed to the 'configure' script with --prefix flag. String optional ""
lib_name Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. String optional ""
lib_source Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. Label required
linkopts Optional link options to be passed up to the dependencies of this library List of strings optional []
make_commands Optional make commands. List of strings optional ["make", "make install"]
out_bin_dir Optional name of the output subdirectory with the binary files, defaults to 'bin'. String optional "bin"
out_binaries Optional names of the resulting binaries. List of strings optional []
out_data_dirs Optional names of additional directories created by the build that should be declared as bazel action outputs List of strings optional []
out_headers_only Flag variable to indicate that the library produces only headers Boolean optional False
out_include_dir Optional name of the output subdirectory with the header files, defaults to 'include'. String optional "include"
out_interface_libs Optional names of the resulting interface libraries. List of strings optional []
out_lib_dir Optional name of the output subdirectory with the library files, defaults to 'lib'. String optional "lib"
out_shared_libs Optional names of the resulting shared libraries. List of strings optional []
out_static_libs Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed List of strings optional []
postfix_script Optional part of the shell script to be added after the make commands String optional ""
targets A list of targets within the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set List of strings optional ["", "install"]
tools_deps Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries. List of labels optional []

make

make(name, additional_inputs, additional_tools, alwayslink, args, data, defines, deps, env,
     lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_headers_only,
     out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
     postfix_script, targets, tools_deps)

Rule for building external libraries with GNU Make. GNU Make commands (make and make install by default) are invoked with prefix="install" (by default), and other environment variables for compilation and linking, taken from Bazel C/C++ toolchain and passed dependencies.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
additional_inputs Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl. List of labels optional []
additional_tools Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl. List of labels optional []
alwayslink Optional. if true, link all the object files from the static library, even if they are not used. Boolean optional False
args A list of arguments to pass to the call to make List of strings optional []
data Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. List of labels optional []
defines Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. List of strings optional []
deps Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule) List of labels optional []
env Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. Dictionary: String -> String optional {}
lib_name Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. String optional ""
lib_source Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. Label required
linkopts Optional link options to be passed up to the dependencies of this library List of strings optional []
out_bin_dir Optional name of the output subdirectory with the binary files, defaults to 'bin'. String optional "bin"
out_binaries Optional names of the resulting binaries. List of strings optional []
out_data_dirs Optional names of additional directories created by the build that should be declared as bazel action outputs List of strings optional []
out_headers_only Flag variable to indicate that the library produces only headers Boolean optional False
out_include_dir Optional name of the output subdirectory with the header files, defaults to 'include'. String optional "include"
out_interface_libs Optional names of the resulting interface libraries. List of strings optional []
out_lib_dir Optional name of the output subdirectory with the library files, defaults to 'lib'. String optional "lib"
out_shared_libs Optional names of the resulting shared libraries. List of strings optional []
out_static_libs Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed List of strings optional []
postfix_script Optional part of the shell script to be added after the make commands String optional ""
targets A list of targets within the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set List of strings optional ["", "install"]
tools_deps Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries. List of labels optional []

make_tool

make_tool(name, srcs)

Rule for building Make. Invokes configure script and make install.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
srcs The target containing the build tool's sources Label required

native_tool_toolchain

native_tool_toolchain(name, path, target)

Rule for defining the toolchain data of the native tools (cmake, ninja), to be used by rules_foreign_cc with toolchain types @rules_foreign_cc//toolchains:cmake_toolchain and @rules_foreign_cc//toolchains:ninja_toolchain.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
path Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example //examples:built_cmake_toolchain) String optional ""
target If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call. Label optional None

ninja

ninja(name, additional_inputs, additional_tools, alwayslink, args, data, defines, deps, directory,
      env, lib_name, lib_source, linkopts, out_bin_dir, out_binaries, out_data_dirs, out_headers_only,
      out_include_dir, out_interface_libs, out_lib_dir, out_shared_libs, out_static_libs,
      postfix_script, targets, tools_deps)

Rule for building external libraries with Ninja.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
additional_inputs Optional additional inputs to be declared as needed for the shell script action.Not used by the shell script part in cc_external_rule_impl. List of labels optional []
additional_tools Optional additional tools needed for the building. Not used by the shell script part in cc_external_rule_impl. List of labels optional []
alwayslink Optional. if true, link all the object files from the static library, even if they are not used. Boolean optional False
args A list of arguments to pass to the call to ninja List of strings optional []
data Files needed by this rule at runtime. May list file or rule targets. Generally allows any target. List of labels optional []
defines Optional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options. List of strings optional []
deps Optional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule) List of labels optional []
directory A directory to pass as the -C argument. The rule will always use the root directory of the lib_sources attribute if this attribute is not set String optional ""
env Environment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data deps, tools_deps, or additional_tools, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. No other macros are supported. Dictionary: String -> String optional {}
lib_name Library name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name. String optional ""
lib_source Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory. Label required
linkopts Optional link options to be passed up to the dependencies of this library List of strings optional []
out_bin_dir Optional name of the output subdirectory with the binary files, defaults to 'bin'. String optional "bin"
out_binaries Optional names of the resulting binaries. List of strings optional []
out_data_dirs Optional names of additional directories created by the build that should be declared as bazel action outputs List of strings optional []
out_headers_only Flag variable to indicate that the library produces only headers Boolean optional False
out_include_dir Optional name of the output subdirectory with the header files, defaults to 'include'. String optional "include"
out_interface_libs Optional names of the resulting interface libraries. List of strings optional []
out_lib_dir Optional name of the output subdirectory with the library files, defaults to 'lib'. String optional "lib"
out_shared_libs Optional names of the resulting shared libraries. List of strings optional []
out_static_libs Optional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumed List of strings optional []
postfix_script Optional part of the shell script to be added after the make commands String optional ""
targets A list of targets with in the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target set List of strings optional []
tools_deps Optional tools to be copied into the directory structure. Similar to deps, those directly required for the external building of the library/binaries. List of labels optional []

ninja_tool

ninja_tool(name, srcs)

Rule for building Ninja. Invokes configure script.

ATTRIBUTES

Name Description Type Mandatory Default
name A unique name for this target. Name required
srcs The target containing the build tool's sources Label required

ForeignCcArtifact

ForeignCcArtifact(bin_dir_name, gen_dir, include_dir_name, lib_dir_name)

Groups information about the external library install directory, and relative bin, include and lib directories.

Serves to pass transitive information about externally built artifacts up the dependency chain.

Can not be used as a top-level provider. Instances of ForeignCcArtifact are incapsulated in a depset ForeignCcDeps#artifacts.

FIELDS

Name Description
bin_dir_name Bin directory, relative to install directory
gen_dir Install directory
include_dir_name Include directory, relative to install directory
lib_dir_name Lib directory, relative to install directory

ForeignCcDeps

ForeignCcDeps(artifacts)

Provider to pass transitive information about external libraries.

FIELDS

Name Description
artifacts Depset of ForeignCcArtifact

ToolInfo

ToolInfo(path, target)

Information about the native tool

FIELDS

Name Description
path Absolute path to the tool in case the tool is preinstalled on the machine. Relative path to the tool in case the tool is built as part of a build; the path should be relative to the bazel-genfiles, i.e. it should start with the name of the top directory of the built tree artifact. (Please see the example //examples:built_cmake_toolchain)
target If the tool is preinstalled, must be None. If the tool is built as part of the build, the corresponding build target, which should produce the tree artifact with the binary to call.

rules_foreign_cc_dependencies

rules_foreign_cc_dependencies(native_tools_toolchains, register_default_tools, cmake_version,
                              make_version, ninja_version, register_preinstalled_tools,
                              register_built_tools)

Call this function from the WORKSPACE file to initialize rules_foreign_cc dependencies and let neccesary code generation happen (Code generation is needed to support different variants of the C++ Starlark API.).

PARAMETERS

Name Description Default Value
native_tools_toolchains pass the toolchains for toolchain types '@rules_foreign_cc//toolchains:cmake_toolchain' and '@rules_foreign_cc//toolchains:ninja_toolchain' with the needed platform constraints. If you do not pass anything, registered default toolchains will be selected (see below). []
register_default_tools If True, the cmake and ninja toolchains, calling corresponding preinstalled binaries by name (cmake, ninja) will be registered after 'native_tools_toolchains' without any platform constraints. The default is True. True
cmake_version The target version of the cmake toolchain if register_default_tools or register_built_tools is set to True. "3.22.0"
make_version The target version of the default make toolchain if register_built_tools is set to True. "4.3"
ninja_version The target version of the ninja toolchain if register_default_tools or register_built_tools is set to True. "1.10.2"
register_preinstalled_tools If true, toolchains will be registered for the native built tools installed on the exec host True
register_built_tools If true, toolchains that build the tools from source are registered True