rules_foreign_cc/docs

Rules Foreign CC

• boost_build
• cmake_external
• cmake_tool
• ConfigureParameters
• configure_make
• ForeignCcArtifact
• ForeignCcDeps
• InputFiles
• make
• make_tool
• native_tool_toolchain
• ninja_tool
• rules_foreign_cc_dependencies
• ToolInfo
• WrappedOutputs

boost_build

boost_build(name, additional_inputs, additional_tools, alwayslink, binaries, bootstrap_options,
            data, defines, deps, env, headers_only, interface_libraries, lib_name, lib_source,
            linkopts, make_commands, out_bin_dir, out_include_dir, out_lib_dir, postfix_script,
            shared_libraries, static_libraries, 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
binaries	Optional names of the resulting binaries.	List of strings	optional	[]
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 buidl 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	{}
headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	False
interface_libraries	Optional names of the resulting interface libraries.	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	[]
make_commands	Optinal make commands, defaults to ["make", "make install"]	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_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	"include"
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	"lib"
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	""
shared_libraries	Optional names of the resulting shared libraries.	List of strings	optional	[]
static_libraries	Optional names of the resulting static libraries.	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	[]
user_options	any additional flags to pass to b2	List of strings	optional	[]

cmake_external

cmake_external(name, additional_inputs, additional_tools, alwayslink, binaries, cache_entries,
               cmake_options, data, defines, deps, env, env_vars, generate_crosstool_file,
               headers_only, install_prefix, interface_libraries, lib_name, lib_source, linkopts,
               make_commands, out_bin_dir, out_include_dir, out_lib_dir, postfix_script,
               shared_libraries, static_libraries, 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
binaries	Optional names of the resulting binaries.	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	{}
cmake_options	Other CMake options	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 buidl 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_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, it makes sense to specify CMAKE_SYSTEM_NAME in the cache_entries - the rule makes only a poor guess about the target system, it is better to specify it manually.	Boolean	optional	False
headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	False
install_prefix	Relative install prefix to be passed to CMake in -DCMAKE_INSTALL_PREFIX	String	optional	""
interface_libraries	Optional names of the resulting interface libraries.	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	[]
make_commands	Optinal make commands, defaults to ["make", "make install"]	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_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	"include"
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	"lib"
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	""
shared_libraries	Optional names of the resulting shared libraries.	List of strings	optional	[]
static_libraries	Optional names of the resulting static libraries.	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, cmake_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
cmake_srcs	-	Label	required

configure_make

configure_make(name, additional_inputs, additional_tools, alwayslink, autoconf, autoconf_env_vars,
               autoconf_options, autogen, autogen_command, autogen_env_vars, autogen_options,
               autoreconf, autoreconf_env_vars, autoreconf_options, binaries, configure_command,
               configure_env_vars, configure_in_place, configure_options, data, defines, deps, env,
               headers_only, install_prefix, interface_libraries, lib_name, lib_source, linkopts,
               make_commands, out_bin_dir, out_include_dir, out_lib_dir, postfix_script,
               shared_libraries, static_libraries, 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
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	[]
binaries	Optional names of the resulting binaries.	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 buidl 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	{}
headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	False
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	""
interface_libraries	Optional names of the resulting interface libraries.	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	[]
make_commands	Optinal make commands, defaults to ["make", "make install"]	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_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	"include"
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	"lib"
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	""
shared_libraries	Optional names of the resulting shared libraries.	List of strings	optional	[]
static_libraries	Optional names of the resulting static libraries.	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	[]

make

make(name, additional_inputs, additional_tools, alwayslink, binaries, data, defines, deps, env,
     headers_only, interface_libraries, keep_going, lib_name, lib_source, linkopts, make_commands,
     make_env_vars, out_bin_dir, out_include_dir, out_lib_dir, postfix_script, prefix,
     shared_libraries, static_libraries, 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
binaries	Optional names of the resulting binaries.	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 buidl 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	{}
headers_only	Flag variable to indicate that the library produces only headers	Boolean	optional	False
interface_libraries	Optional names of the resulting interface libraries.	List of strings	optional	[]
keep_going	Keep going when some targets can not be made, -k flag is passed to make (applies only if make_commands attribute is not set). Please have a look at _create_make_script for default make_commands.	Boolean	optional	True
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	Overriding make_commands default value to be empty, then we can provide better default value programmatically	List of strings	optional	[]
make_env_vars	Environment variables to be set for the 'configure' invocation.	Dictionary: String -> String	optional	{}
out_bin_dir	Optional name of the output subdirectory with the binary files, defaults to 'bin'.	String	optional	"bin"
out_include_dir	Optional name of the output subdirectory with the header files, defaults to 'include'.	String	optional	"include"
out_lib_dir	Optional name of the output subdirectory with the library files, defaults to 'lib'.	String	optional	"lib"
postfix_script	Optional part of the shell script to be added after the make commands	String	optional	""
prefix	Install prefix, an absolute path. Passed to the GNU make via "make install PREFIX=<value>". By default, the install directory created under sandboxed execution root is used. Build results are copied to the Bazel's output directory, so the prefix is only important if it is recorded into any text files by Makefile script. In that case, it is important to note that rules_foreign_cc is overriding the paths under execution root with "BAZEL_GEN_ROOT" value.	String	optional	""
shared_libraries	Optional names of the resulting shared libraries.	List of strings	optional	[]
static_libraries	Optional names of the resulting static libraries.	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	[]

make_tool

make_tool(name, make_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
make_srcs	target with the Make 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//tools/build_defs:cmake_toolchain and @rules_foreign_cc//tools/build_defs: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_tool

ninja_tool(name, ninja_srcs)

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

ATTRIBUTES

Name	Description	Type	Mandatory	Default
name	A unique name for this target.	Name	required
ninja_srcs	-	Label	required

ConfigureParameters

ConfigureParameters(ctx, attrs, inputs)

Parameters of create_configure_script callback function, called by cc_external_rule_impl function. create_configure_script creates the configuration part of the script, and allows to reuse the inputs structure, created by the framework.

FIELDS

Name	Description
ctx	Rule context
attrs	Attributes struct, created by create_attrs function above
inputs	InputFiles provider: summarized information on rule inputs, created by framework function, to be reused in script creator. Contains in particular merged compilation and linking dependencies.

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

InputFiles

InputFiles(headers, include_dirs, libs, tools_files, ext_build_dirs, deps_compilation_info,
           deps_linking_info, declared_inputs)

Provider to keep different kinds of input files, directories, and C/C++ compilation and linking info from dependencies

FIELDS

Name	Description
headers	Include files built by Bazel. Will be copied into $EXT_BUILD_DEPS/include.
include_dirs	Include directories built by Bazel. Will be copied into $EXT_BUILD_DEPS/include.
libs	Library files built by Bazel. Will be copied into $EXT_BUILD_DEPS/lib.
tools_files	Files and directories with tools needed for configuration/building to be copied into the bin folder, which is added to the PATH
ext_build_dirs	Directories with libraries, built by framework function. This directories should be copied into $EXT_BUILD_DEPS/lib-name as is, with all contents.
deps_compilation_info	Merged CcCompilationInfo from deps attribute
deps_linking_info	Merged CcLinkingInfo from deps attribute
declared_inputs	All files and directories that must be declared as action inputs

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.

WrappedOutputs

WrappedOutputs(log_file, script_file, wrapper_script, wrapper_script_file)

Structure for passing the log and scripts file information, and wrapper script text.

FIELDS

Name	Description
log_file	Execution log file
script_file	Main script file
wrapper_script	Wrapper script text to execute
wrapper_script_file	Wrapper script file (output for debugging purposes)

rules_foreign_cc_dependencies

rules_foreign_cc_dependencies(native_tools_toolchains, register_default_tools,
                              additional_shell_toolchain_mappings, additional_shell_toolchain_package)

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//tools/build_defs:cmake_toolchain' and '@rules_foreign_cc//tools/build_defs: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
additional_shell_toolchain_mappings	Mappings of the shell toolchain functions to execution and target platforms constraints. Similar to what defined in @rules_foreign_cc//tools/build_defs/shell_toolchain/toolchains:toolchain_mappings.bzl in the TOOLCHAIN_MAPPINGS list. Please refer to example in @rules_foreign_cc//toolchain_examples.	[]
additional_shell_toolchain_package	A package under which additional toolchains, referencing the generated data for the passed additonal_shell_toolchain_mappings, will be defined. This value is needed since register_toolchains() is called for these toolchains. Please refer to example in @rules_foreign_cc//toolchain_examples.	None