blob: 51f51c588dfb4f2c2dbb575c665e5d933e764985 [file] [log] [blame]
# Copyright 2019 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import("//build/cpp/verify_pragma_once.gni")
import("//build/sdk/plasa/config.gni")
import("//build/sdk/plasa/plasa_fragment_cc.gni")
import("//build/sdk/sdk_atom.gni")
import("//build/sdk/sdk_atom_alias.gni")
# A static library that can be exported to an SDK in binary form.
#
# Parameters
#
# category (required)
# Publication level of the library in SDKs.
# See //build/sdk/sdk_atom.gni.
#
# api (optional)
# Path to the file representing the API of this library.
# This file is used to ensure modifications to the library's API are
# explicitly acknowledged. It is mandatory for publication categories of
# "partner" or "public".
# Defaults to "<SDK name>.api".
#
# libcxx_linkage (optional)
# Whether or how to link libc++. SDK shared libraries cannot link libc++.so
# dynamically because libc++.so does not have a stable ABI. Can be either
# "none" or "static".
# Defaults to "none".
#
# sdk_name (required for non-internal libraries)
# Name of the library in the SDK.
# For internal libraries, defaults to ${fully_qualified_target_path}_${target_name}.
# e.g. (target) //src/lib/fxl:fxl -> (default sdk_name) //src/lib/fxl_fxl
#
# include_base (optional)
# Path to the root directory for includes.
# Defaults to "include".
#
# runtime_deps (optional)
# List of labels representing the library's runtime dependencies. This is
# only needed for runtime dependencies inherited from private dependencies.
# Note that these labels should represent SDK targets.
#
# private_headers (optional)
# List of header files that are not intended for direct inclusion by users.
# Used to help generate stub files, which do not know apriori that a header
# is not to be used. Define these in addition to deps (i.e. repeat them
# if they are already mentioned in 'sources').
#
# The defaults for a sdk_static_library should match that of a shared_library.
set_defaults("sdk_static_library") {
configs = default_common_binary_configs
}
template("sdk_static_library") {
assert(defined(invoker.category), "Must define an SDK category")
is_internal = invoker.category == "internal"
output_name = target_name
if (defined(invoker.output_name)) {
output_name = invoker.output_name
}
if (is_internal) {
# If not defined by the invoker, the sdk_name is the fully qualified target name with some tweaks. For example:
# //src/lib/fxl:fxl sdk_name = //src/lib/fxl_fxl sdk_root_path= src/lib/fxl_fxl
# //src/lib/fxl:functional sdk_name = //src/lib/fxl_functional sdk_root_path= src/lib/fxl_functional
# //src/lib/fxl/files:files sdk_name = //src/lib/fxl/files_files sdk_root_path= src/lib/fxl/files_files
full_label = get_label_info(":${target_name}", "label_no_toolchain")
path = get_label_info(full_label, "dir")
path = "${path}_${invoker.target_name}"
sdk_name = path
sdk_root_path = string_replace(sdk_name, "//", "")
} else {
assert(defined(invoker.sdk_name),
"Non-internal sdk_static_library must define an SDK name")
sdk_name = invoker.sdk_name
sdk_root_path = "pkg/${sdk_name}"
}
sdk_id = "sdk://${sdk_root_path}"
is_partner_or_public =
invoker.category == "partner" || invoker.category == "public"
no_headers = defined(invoker.no_headers) && invoker.no_headers
if (is_partner_or_public && !no_headers) {
api_reference = "${sdk_name}.api"
if (defined(invoker.api)) {
api_reference = invoker.api
}
}
main_target_name = target_name
metadata_target_name = "${target_name}_sdk_metadata"
manifest_target_name = "${target_name}_sdk_manifest"
sdk_target_name = "${target_name}_sdk"
runtime_deps_file = "${target_out_dir}/${target_name}.runtime_deps"
# This is subtle: If one of the dependencies is listed in runtime_deps
# with an _sdk suffix, assume it is a shared_library() target, and ensure
# that the current target depends on the dependency built in the same
# build variant, i.e. ignoring build variant redirection, even when we
# are in the default toolchain.
if (current_toolchain == default_toolchain && defined(invoker.runtime_deps)) {
_new_deps = []
if (defined(invoker.deps)) {
foreach(dep, invoker.deps) {
_dep_label = get_label_info(dep, "label_no_toolchain")
_dep_sdk_label = _dep_label + "_sdk"
if (invoker.runtime_deps + [ _dep_sdk_label ] - [ _dep_sdk_label ] !=
invoker.runtime_deps) {
dep = _dep_label + "(${shlib_toolchain_no_default_variant_redirect})"
}
_new_deps += [ dep ]
}
invoker.deps = []
invoker.deps = _new_deps
}
}
static_library(main_target_name) {
forward_variables_from(invoker,
"*",
[
"api",
"category",
"include_base",
"private_headers",
"runtime_deps",
"sdk_name",
])
if (!defined(sources)) {
sources = []
}
if (defined(invoker.private_headers)) {
sources += invoker.private_headers
}
if (defined(visibility)) {
visibility += [ ":$manifest_target_name" ]
}
if (!defined(libcxx_linkage)) {
libcxx_linkage = "none"
}
assert(libcxx_linkage == "none" || libcxx_linkage == "static")
# Prebuilt shared libraries are eligible for inclusion in the SDK. We do not
# want to dynamically link against libc++.so because we let clients bring
# their own toolchain, which might have a different C++ Standard Library or
# a different C++ ABI entirely.
if (!defined(configs)) {
configs = []
}
if (libcxx_linkage == "static") {
configs += [ "//build/config/fuchsia:static_cpp_standard_library" ]
} else {
# Adding this linker flag keeps us honest about not commiting to a
# specific C++ ABI. If this flag is causing your library to not
# compile, consider whether your library really ought to be in the SDK.
# If so, consider including your library in the SDK as source rather than
# precompiled. If you do require precompilation, you probably need to
# find a way not to depend on dynamically linking C++ symbols because C++
# does not have a sufficiently stable ABI for the purposes of our SDK.
configs += [ "//build/config/fuchsia:no_cpp_standard_library" ]
}
# Request that the runtime deps be written out to a file. This file will be
# used later to verify that all runtime deps are available in the SDK.
write_runtime_deps = runtime_deps_file
metadata = {
if (defined(invoker.metadata)) {
forward_variables_from(invoker.metadata, "*")
}
if (is_fuchsia) {
component_catalog = [
{
sdk_id = sdk_id
label = get_label_info(":$target_name", "label_with_toolchain")
},
]
}
}
}
# Base path for binaries of this library in SDKs.
prebuilt_base = "arch/$target_cpu"
# Identify dependencies and their metadata files.
sdk_deps = []
sdk_metas = []
build_deps = []
if (defined(invoker.deps)) {
build_deps += invoker.deps
}
if (defined(invoker.public_deps)) {
build_deps += invoker.public_deps
}
if (defined(invoker.public_deps)) {
foreach(dep, invoker.public_deps) {
full_label = get_label_info(dep, "label_no_toolchain")
sdk_dep = "${full_label}_sdk"
sdk_deps += [ sdk_dep ]
}
}
# Runtime deps are already SDK targets.
if (defined(invoker.runtime_deps)) {
sdk_deps += invoker.runtime_deps
}
foreach(sdk_dep, sdk_deps) {
gen_dir = get_label_info(sdk_dep, "target_gen_dir")
name = get_label_info(sdk_dep, "name")
sdk_metas += [ "$gen_dir/$name.meta.json" ]
}
include_dest = "${sdk_root_path}/include"
sdk_header_files = []
sdk_metadata_headers = []
if (!no_headers) {
# Process headers.
all_headers = []
if (defined(invoker.public) || defined(invoker.private_headers)) {
if (defined(invoker.public)) {
all_headers += invoker.public
}
if (defined(invoker.private_headers)) {
all_headers += invoker.private_headers
}
} else {
# If no explicit headers are defined, pick them out from sources.
if (defined(invoker.sources)) {
foreach(source_file, invoker.sources) {
extension = get_path_info(source_file, "extension")
if (extension == "h") {
all_headers += [ source_file ]
}
}
}
}
assert(
all_headers != [],
"Library does not contain any headers or sources. If this is intentional then set `no_headers = true`")
if (defined(invoker.include_base)) {
include_base = invoker.include_base
} else {
if (is_internal) {
# by default, we want internal SDK elements to have their include path similar when used through
# an SDK (eg Bazel SDk) or directly (GN/Ninja), so that source code doesn't need to be changed
# when switching from one to the other.
include_base = "//"
} else {
include_base = "include"
}
}
include_dest = "${sdk_root_path}/include"
foreach(header, all_headers) {
destination = rebase_path(header, include_base)
header_dest = "${include_dest}/${destination}"
sdk_metadata_headers += [ header_dest ]
sdk_header_files += [
{
source = header
dest = header_dest
},
]
}
}
# Add binaries.
lib_name = "lib${output_name}.a"
link_lib = "${prebuilt_base}/lib/${lib_name}"
sdk_files = sdk_header_files + [
{
source = "${target_out_dir}/${lib_name}"
dest = link_lib
},
]
if (generate_plasa_artifacts) {
_plasa_artifacts_target_name = "${main_target_name}_plasa"
plasa_fragment_cc(_plasa_artifacts_target_name) {
forward_variables_from(invoker,
[
"all_headers",
"private_headers",
"source_dir",
"testonly",
])
all_deps = build_deps
file_base = sdk_root_path
}
}
metadata_file = "${target_gen_dir}/${metadata_target_name}.sdk_meta.json"
action(metadata_target_name) {
forward_variables_from(invoker, [ "testonly" ])
script = "//build/cpp/gen_sdk_prebuilt_meta_file.py"
inputs = sdk_metas + [
"//build/cpp/binaries.py",
"//build/images/elfinfo.py",
]
outputs = [ metadata_file ]
args = [
"--out",
rebase_path(metadata_file, root_build_dir),
"--name",
sdk_name,
"--format",
"static",
"--root",
sdk_root_path,
"--include-dir",
include_dest,
"--arch",
target_cpu,
"--lib-link",
link_lib,
]
args += [ "--deps" ] + rebase_path(sdk_metas, root_build_dir)
args += [ "--headers" ] + sdk_metadata_headers
deps = sdk_deps + [ ":${main_target_name}" ]
}
# Exempt internal libraries from pragma verification.
should_verify_pragma = !is_internal && !no_headers
if (should_verify_pragma) {
verify_pragma_target_name = "${target_name}_sdk_pragma"
verify_pragma_once(verify_pragma_target_name) {
headers = all_headers
}
}
sdk_atom(manifest_target_name) {
forward_variables_from(invoker,
[
"testonly",
"category",
])
id = sdk_id
if (defined(api_reference) && !no_headers) {
api = api_reference
api_contents = sdk_header_files
}
meta = {
source = metadata_file
dest = "${sdk_root_path}/meta.json"
schema = "cc_prebuilt_library"
}
files = sdk_files
deps = sdk_deps
non_sdk_deps = [
":${main_target_name}",
":${metadata_target_name}",
]
if (should_verify_pragma) {
non_sdk_deps += [ ":${verify_pragma_target_name}" ]
}
# Explicitly add non-public dependencies, in case some of the source files
# are generated.
if (defined(invoker.deps)) {
non_sdk_deps += invoker.deps
}
if (generate_plasa_artifacts) {
non_sdk_deps += [ ":${_plasa_artifacts_target_name}" ]
}
}
sdk_manifest_file = "${target_gen_dir}/${manifest_target_name}.sdk"
verify_target_name = "${target_name}_verify"
# Verify that the SDK manifest for this target includes all of the expected
# runtime dependencies.
# TODO(fxbug.dev/5365): also check that everything in there is either prebuilt or
# headers only.
action(verify_target_name) {
script = "//build/cpp/verify_runtime_deps.py"
inputs = [
sdk_manifest_file,
runtime_deps_file,
]
stamp_file = "${target_gen_dir}/${target_name}.gn_stamp"
outputs = [ stamp_file ]
args = [
"--stamp",
rebase_path(stamp_file, root_build_dir),
"--manifest",
rebase_path(sdk_manifest_file, root_build_dir),
"--runtime-deps-file",
rebase_path(runtime_deps_file, root_build_dir),
]
deps = [
":${main_target_name}",
":${manifest_target_name}",
]
}
sdk_atom_alias(sdk_target_name) {
atom = ":${manifest_target_name}"
non_sdk_deps = [ ":${verify_target_name}" ]
if (generate_plasa_artifacts) {
non_sdk_deps += [ ":$_plasa_artifacts_target_name" ]
}
}
}