blob: 16f006d37e8b48674b7d2c9084776d5ab7e181b5 [file] [log] [blame]
Colin Cross3f40fa42015-01-30 17:27:36 -08001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file generates the final rules for compiling all C/C++. All properties related to
18// compiling should have been translated into builderFlags or another argument to the Transform*
19// functions.
20
21import (
Ivan Lozano0a468a42024-05-13 21:03:34 -040022 "fmt"
Colin Crossb98c8b02016-07-29 13:44:28 -070023 "path/filepath"
Colin Cross0af4b842015-04-30 16:36:18 -070024 "runtime"
Fabien Sanglardaa8020a2024-08-09 18:19:11 -070025 "slices"
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -070026 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080027 "strings"
Colin Crossed4cf0b2015-03-26 14:43:45 -070028
29 "github.com/google/blueprint"
Josh Gao75a50a22019-06-07 17:58:59 -070030 "github.com/google/blueprint/pathtools"
Colin Crossb98c8b02016-07-29 13:44:28 -070031
32 "android/soong/android"
33 "android/soong/cc/config"
Ramy Medhat9a90fe52020-04-13 13:21:23 -040034 "android/soong/remoteexec"
Colin Cross3f40fa42015-01-30 17:27:36 -080035)
36
37const (
Dan Albertc3144b12015-04-28 18:17:56 -070038 objectExtension = ".o"
Colin Cross3f40fa42015-01-30 17:27:36 -080039 staticLibraryExtension = ".a"
40)
41
42var (
Colin Cross635c3b02016-05-18 15:37:25 -070043 pctx = android.NewPackageContext("android/soong/cc")
Colin Cross3f40fa42015-01-30 17:27:36 -080044
Chris Parsonsbf4f55f2020-11-23 17:02:44 -050045 // Rule to invoke gcc with given command, flags, and dependencies. Outputs a .d depfile.
Ramy Medhat8ea054a2020-01-27 14:19:44 -050046 cc = pctx.AndroidRemoteStaticRule("cc", android.RemoteRuleSupports{Goma: true, RBE: true},
Colin Cross3f40fa42015-01-30 17:27:36 -080047 blueprint.RuleParams{
48 Depfile: "${out}.d",
49 Deps: blueprint.DepsGCC,
kellyhungd62ea302024-05-19 21:16:07 +080050 Command: "$relPwd ${config.CcWrapper}$ccCmd -c $cFlags -MD -MF ${out}.d -o $out $in$postCmd",
Dan Willemsenc94a7682015-11-17 15:27:28 -080051 CommandDeps: []string{"$ccCmd"},
Colin Cross3f40fa42015-01-30 17:27:36 -080052 },
kellyhungd62ea302024-05-19 21:16:07 +080053 "ccCmd", "cFlags", "postCmd")
Colin Cross3f40fa42015-01-30 17:27:36 -080054
Chris Parsonsbf4f55f2020-11-23 17:02:44 -050055 // Rule to invoke gcc with given command and flags, but no dependencies.
Kousik Kumar2976bfd2020-02-17 00:26:55 -080056 ccNoDeps = pctx.AndroidStaticRule("ccNoDeps",
Dan Willemsenfcabb1c2019-01-03 23:25:11 -080057 blueprint.RuleParams{
kellyhungd62ea302024-05-19 21:16:07 +080058 Command: "$relPwd $ccCmd -c $cFlags -o $out $in$postCmd",
Dan Willemsenfcabb1c2019-01-03 23:25:11 -080059 CommandDeps: []string{"$ccCmd"},
60 },
kellyhungd62ea302024-05-19 21:16:07 +080061 "ccCmd", "cFlags", "postCmd")
Dan Willemsenfcabb1c2019-01-03 23:25:11 -080062
Chris Parsonsbf4f55f2020-11-23 17:02:44 -050063 // Rules to invoke ld to link binaries. Uses a .rsp file to list dependencies, as there may
64 // be many.
Colin Cross77cdcfd2021-03-12 11:28:25 -080065 ld, ldRE = pctx.RemoteStaticRules("ld",
Colin Cross3f40fa42015-01-30 17:27:36 -080066 blueprint.RuleParams{
Ramy Medhat31ec9422020-04-17 15:03:58 -040067 Command: "$reTemplate$ldCmd ${crtBegin} @${out}.rsp " +
Kousik Kumar01332cf2022-07-04 20:34:57 +000068 "${crtEnd} -o ${out} ${ldFlags} ${extraLibFlags}",
Dan Willemsenc94a7682015-11-17 15:27:28 -080069 CommandDeps: []string{"$ldCmd"},
Colin Cross7d21c442015-03-30 17:47:53 -070070 Rspfile: "${out}.rsp",
Kousik Kumar01332cf2022-07-04 20:34:57 +000071 RspfileContent: "${in} ${libFlags}",
Colin Cross36ae1352019-03-29 15:55:30 -070072 // clang -Wl,--out-implib doesn't update its output file if it hasn't changed.
73 Restat: true,
Colin Cross3f40fa42015-01-30 17:27:36 -080074 },
Ramy Medhat31ec9422020-04-17 15:03:58 -040075 &remoteexec.REParams{
76 Labels: map[string]string{"type": "link", "tool": "clang"},
Ramy Medhat9a90fe52020-04-13 13:21:23 -040077 ExecStrategy: "${config.RECXXLinksExecStrategy}",
Ramy Medhat6797edc2020-08-28 14:21:55 -040078 Inputs: []string{"${out}.rsp", "$implicitInputs"},
Colin Crossa4eafdd2021-03-24 14:09:28 -070079 RSPFiles: []string{"${out}.rsp"},
Kousik Kumar3fb61262020-04-22 13:31:09 -070080 OutputFiles: []string{"${out}", "$implicitOutputs"},
Ramy Medhat9a90fe52020-04-13 13:21:23 -040081 ToolchainInputs: []string{"$ldCmd"},
82 Platform: map[string]string{remoteexec.PoolKey: "${config.RECXXLinksPool}"},
Ramy Medhat6797edc2020-08-28 14:21:55 -040083 }, []string{"ldCmd", "crtBegin", "libFlags", "crtEnd", "ldFlags", "extraLibFlags"}, []string{"implicitInputs", "implicitOutputs"})
Colin Cross3f40fa42015-01-30 17:27:36 -080084
Chris Parsonsbf4f55f2020-11-23 17:02:44 -050085 // Rules for .o files to combine to other .o files, using ld partial linking.
Colin Cross77cdcfd2021-03-12 11:28:25 -080086 partialLd, partialLdRE = pctx.RemoteStaticRules("partialLd",
Colin Cross3f40fa42015-01-30 17:27:36 -080087 blueprint.RuleParams{
Chih-Hung Hsieh3ede2942018-01-10 14:30:44 -080088 // Without -no-pie, clang 7.0 adds -pie to link Android files,
89 // but -r and -pie cannot be used together.
Ramy Medhat31ec9422020-04-17 15:03:58 -040090 Command: "$reTemplate$ldCmd -fuse-ld=lld -nostdlib -no-pie -Wl,-r ${in} -o ${out} ${ldFlags}",
Dan Willemsenc94a7682015-11-17 15:27:28 -080091 CommandDeps: []string{"$ldCmd"},
Ramy Medhat9a90fe52020-04-13 13:21:23 -040092 }, &remoteexec.REParams{
Ramy Medhat6797edc2020-08-28 14:21:55 -040093 Labels: map[string]string{"type": "link", "tool": "clang"},
94 ExecStrategy: "${config.RECXXLinksExecStrategy}",
95 Inputs: []string{"$inCommaList", "$implicitInputs"},
Kousik Kumar3fb61262020-04-22 13:31:09 -070096 OutputFiles: []string{"${out}", "$implicitOutputs"},
Ramy Medhat9a90fe52020-04-13 13:21:23 -040097 ToolchainInputs: []string{"$ldCmd"},
98 Platform: map[string]string{remoteexec.PoolKey: "${config.RECXXLinksPool}"},
Ramy Medhat6797edc2020-08-28 14:21:55 -040099 }, []string{"ldCmd", "ldFlags"}, []string{"implicitInputs", "inCommaList", "implicitOutputs"})
Colin Cross3f40fa42015-01-30 17:27:36 -0800100
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500101 // Rule to invoke `ar` with given cmd and flags, but no static library depenencies.
Colin Cross9d45bb72016-08-29 16:14:13 -0700102 ar = pctx.AndroidStaticRule("ar",
Colin Cross3f40fa42015-01-30 17:27:36 -0800103 blueprint.RuleParams{
Colin Cross7d21c442015-03-30 17:47:53 -0700104 Command: "rm -f ${out} && $arCmd $arFlags $out @${out}.rsp",
Dan Willemsenc94a7682015-11-17 15:27:28 -0800105 CommandDeps: []string{"$arCmd"},
Colin Cross7d21c442015-03-30 17:47:53 -0700106 Rspfile: "${out}.rsp",
107 RspfileContent: "${in}",
Colin Cross3f40fa42015-01-30 17:27:36 -0800108 },
109 "arCmd", "arFlags")
110
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500111 // Rule to invoke `ar` with given cmd, flags, and library dependencies. Generates a .a
112 // (archive) file from .o files.
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100113 arWithLibs = pctx.AndroidStaticRule("arWithLibs",
114 blueprint.RuleParams{
115 Command: "rm -f ${out} && $arCmd $arObjFlags $out @${out}.rsp && $arCmd $arLibFlags $out $arLibs",
116 CommandDeps: []string{"$arCmd"},
117 Rspfile: "${out}.rsp",
118 RspfileContent: "${arObjs}",
119 },
120 "arCmd", "arObjFlags", "arObjs", "arLibFlags", "arLibs")
121
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500122 // Rule to run objcopy --prefix-symbols (to prefix all symbols in a file with a given string).
Colin Cross9d45bb72016-08-29 16:14:13 -0700123 prefixSymbols = pctx.AndroidStaticRule("prefixSymbols",
Colin Crossbfae8852015-03-26 14:44:11 -0700124 blueprint.RuleParams{
125 Command: "$objcopyCmd --prefix-symbols=${prefix} ${in} ${out}",
Dan Willemsenc94a7682015-11-17 15:27:28 -0800126 CommandDeps: []string{"$objcopyCmd"},
Colin Crossbfae8852015-03-26 14:44:11 -0700127 },
128 "objcopyCmd", "prefix")
129
Colin Crossdea1d032022-12-06 14:50:08 -0800130 // Rule to run objcopy --remove-section=.llvm_addrsig on a partially linked object
131 noAddrSig = pctx.AndroidStaticRule("noAddrSig",
132 blueprint.RuleParams{
133 Command: "rm -f ${out} && $objcopyCmd --remove-section=.llvm_addrsig ${in} ${out}",
134 CommandDeps: []string{"$objcopyCmd"},
135 },
136 "objcopyCmd")
137
Nan Zhang43a485c2017-03-27 14:27:58 -0700138 _ = pctx.SourcePathVariable("stripPath", "build/soong/scripts/strip.sh")
Dan Willemsen8fec83a2018-03-09 10:47:52 -0800139 _ = pctx.SourcePathVariable("xzCmd", "prebuilts/build-tools/${config.HostPrebuiltTag}/bin/xz")
David Srbecky69315e42021-04-29 21:06:47 +0100140 _ = pctx.SourcePathVariable("createMiniDebugInfo", "prebuilts/build-tools/${config.HostPrebuiltTag}/bin/create_minidebuginfo")
Colin Cross665dce92016-04-28 14:50:03 -0700141
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500142 // Rule to invoke `strip` (to discard symbols and data from object files).
143 strip = pctx.AndroidStaticRule("strip",
144 blueprint.RuleParams{
David Srbecky69315e42021-04-29 21:06:47 +0100145 Depfile: "${out}.d",
146 Deps: blueprint.DepsGCC,
147 Command: "XZ=$xzCmd CREATE_MINIDEBUGINFO=$createMiniDebugInfo CLANG_BIN=${config.ClangBin} $stripPath ${args} -i ${in} -o ${out} -d ${out}.d",
148 CommandDeps: func() []string {
149 if runtime.GOOS != "darwin" {
150 return []string{"$stripPath", "$xzCmd", "$createMiniDebugInfo"}
151 } else {
152 return []string{"$stripPath", "$xzCmd"}
153 }
154 }(),
155 Pool: darwinStripPool,
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500156 },
Elliott Hughesafcd3392021-05-05 13:54:11 -0700157 "args")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500158
159 // Rule to invoke `strip` (to discard symbols and data from object files) on darwin architecture.
Yu Liu2c032762024-07-24 19:27:51 +0000160 darwinStrip = func() blueprint.Rule {
161 if runtime.GOOS == "darwin" {
162 return pctx.AndroidStaticRule("darwinStrip",
163 blueprint.RuleParams{
164 Command: "${config.MacStripPath} -u -r -o $out $in",
165 CommandDeps: []string{"${config.MacStripPath}"},
166 })
167 } else {
168 return nil
169 }
170 }()
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500171
Colin Crossee3ea312019-05-17 15:36:46 -0700172 // b/132822437: objcopy uses a file descriptor per .o file when called on .a files, which runs the system out of
Colin Crossbadf8d62019-05-22 13:25:50 -0700173 // file descriptors on darwin. Limit concurrent calls to 5 on darwin.
Colin Crossee3ea312019-05-17 15:36:46 -0700174 darwinStripPool = func() blueprint.Pool {
175 if runtime.GOOS == "darwin" {
176 return pctx.StaticPool("darwinStripPool", blueprint.PoolParams{
Colin Crossbadf8d62019-05-22 13:25:50 -0700177 Depth: 5,
Colin Crossee3ea312019-05-17 15:36:46 -0700178 })
179 } else {
180 return nil
181 }
182 }()
183
Yu Liu2c032762024-07-24 19:27:51 +0000184 darwinLipo = func() blueprint.Rule {
185 if runtime.GOOS == "darwin" {
186 return pctx.AndroidStaticRule("darwinLipo",
187 blueprint.RuleParams{
188 Command: "${config.MacLipoPath} -create -output $out $in",
189 CommandDeps: []string{"${config.MacLipoPath}"},
190 })
191 } else {
192 return nil
193 }
194 }()
Dan Willemsen47450072021-10-19 20:24:49 -0700195
Yi Kongc49c3932019-10-15 02:01:19 -0700196 _ = pctx.SourcePathVariable("archiveRepackPath", "build/soong/scripts/archive_repack.sh")
197
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500198 // Rule to repack an archive (.a) file with a subset of object files.
Yi Kongc49c3932019-10-15 02:01:19 -0700199 archiveRepack = pctx.AndroidStaticRule("archiveRepack",
200 blueprint.RuleParams{
201 Depfile: "${out}.d",
202 Deps: blueprint.DepsGCC,
203 Command: "CLANG_BIN=${config.ClangBin} $archiveRepackPath -i ${in} -o ${out} -d ${out}.d ${objects}",
204 CommandDeps: []string{"$archiveRepackPath"},
205 },
206 "objects")
207
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500208 // Rule to create an empty file at a given path.
Colin Cross9d45bb72016-08-29 16:14:13 -0700209 emptyFile = pctx.AndroidStaticRule("emptyFile",
Dan Willemsen9f0b5502016-05-13 14:05:09 -0700210 blueprint.RuleParams{
Colin Cross67a5c132017-05-09 13:45:28 -0700211 Command: "rm -f $out && touch $out",
Dan Willemsen9f0b5502016-05-13 14:05:09 -0700212 })
213
Nan Zhang43a485c2017-03-27 14:27:58 -0700214 _ = pctx.SourcePathVariable("tocPath", "build/soong/scripts/toc.sh")
Colin Cross26c34ed2016-09-30 17:10:16 -0700215
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500216 // A rule for extracting a table of contents from a shared library (.so).
Colin Cross26c34ed2016-09-30 17:10:16 -0700217 toc = pctx.AndroidStaticRule("toc",
218 blueprint.RuleParams{
219 Depfile: "${out}.d",
220 Deps: blueprint.DepsGCC,
Yi Kong4ad44e72021-04-01 17:45:42 +0800221 Command: "CLANG_BIN=$clangBin $tocPath $format -i ${in} -o ${out} -d ${out}.d",
Colin Cross26c34ed2016-09-30 17:10:16 -0700222 CommandDeps: []string{"$tocPath"},
223 Restat: true,
224 },
Yi Kong4ad44e72021-04-01 17:45:42 +0800225 "clangBin", "format")
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700226
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700227 // Rules for invoking clang-tidy (a clang-based linter).
Colin Cross77cdcfd2021-03-12 11:28:25 -0800228 clangTidy, clangTidyRE = pctx.RemoteStaticRules("clangTidy",
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700229 blueprint.RuleParams{
Chih-Hung Hsieh8e09f262021-09-10 17:25:28 -0700230 Depfile: "${out}.d",
231 Deps: blueprint.DepsGCC,
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700232 Command: "CLANG_CMD=$clangCmd TIDY_FILE=$out " +
233 "$tidyVars$reTemplate${config.ClangBin}/clang-tidy.sh $in $tidyFlags -- $cFlags",
234 CommandDeps: []string{"${config.ClangBin}/clang-tidy.sh", "$ccCmd", "$tidyCmd"},
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700235 },
Kousik Kumar4e30bba2020-06-18 09:17:51 -0700236 &remoteexec.REParams{
Chih-Hung Hsieh95dfbce2021-09-09 19:12:05 -0700237 Labels: map[string]string{"type": "lint", "tool": "clang-tidy", "lang": "cpp"},
238 ExecStrategy: "${config.REClangTidyExecStrategy}",
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700239 Inputs: []string{"$in"},
240 OutputFiles: []string{"${out}", "${out}.d"},
241 ToolchainInputs: []string{"$ccCmd", "$tidyCmd"},
242 EnvironmentVariables: []string{"CLANG_CMD", "TIDY_FILE", "TIDY_TIMEOUT"},
Chih-Hung Hsiehfde8e6d2021-08-30 12:49:39 -0700243 // Although clang-tidy has an option to "fix" source files, that feature is hardly useable
244 // under parallel compilation and RBE. So we assume no OutputFiles here.
245 // The clang-tidy fix option is best run locally in single thread.
246 // Copying source file back to local caused two problems:
247 // (1) New timestamps trigger clang and clang-tidy compilations again.
248 // (2) Changing source files caused concurrent clang or clang-tidy jobs to crash.
249 Platform: map[string]string{remoteexec.PoolKey: "${config.REClangTidyPool}"},
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700250 }, []string{"cFlags", "ccCmd", "clangCmd", "tidyCmd", "tidyFlags", "tidyVars"}, []string{})
Colin Cross91e90042016-12-02 17:13:24 -0800251
Nan Zhang43a485c2017-03-27 14:27:58 -0700252 _ = pctx.SourcePathVariable("yasmCmd", "prebuilts/misc/${config.HostPrebuiltTag}/yasm/yasm")
Colin Cross91e90042016-12-02 17:13:24 -0800253
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500254 // Rule for invoking yasm to compile .asm assembly files.
Colin Cross91e90042016-12-02 17:13:24 -0800255 yasm = pctx.AndroidStaticRule("yasm",
256 blueprint.RuleParams{
Dan Willemsen1d3e5452017-08-22 20:53:45 -0700257 Command: "$yasmCmd $asFlags -o $out $in && $yasmCmd $asFlags -M $in >$out.d",
Colin Cross91e90042016-12-02 17:13:24 -0800258 CommandDeps: []string{"$yasmCmd"},
Dan Willemsen1d3e5452017-08-22 20:53:45 -0700259 Depfile: "$out.d",
260 Deps: blueprint.DepsGCC,
Colin Cross91e90042016-12-02 17:13:24 -0800261 },
262 "asFlags")
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800263
Jayant Chowdharya4c6df52018-02-20 12:36:51 -0800264 _ = pctx.SourcePathVariable("sAbiDumper", "prebuilts/clang-tools/${config.HostPrebuiltTag}/bin/header-abi-dumper")
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800265
Jayant Chowdhary715cac32017-04-20 06:53:59 -0700266 // -w has been added since header-abi-dumper does not need to produce any sort of diagnostic information.
Colin Cross77cdcfd2021-03-12 11:28:25 -0800267 sAbiDump, sAbiDumpRE = pctx.RemoteStaticRules("sAbiDump",
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800268 blueprint.RuleParams{
Hsin-Yi Chen79781a92021-07-09 15:59:03 +0800269 Command: "rm -f $out && $reTemplate$sAbiDumper --root-dir . --root-dir $$OUT_DIR:out -o ${out} $in $exportDirs -- $cFlags -w -isystem prebuilts/clang-tools/${config.HostPrebuiltTag}/clang-headers",
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800270 CommandDeps: []string{"$sAbiDumper"},
Ramy Medhat31ec9422020-04-17 15:03:58 -0400271 }, &remoteexec.REParams{
272 Labels: map[string]string{"type": "abi-dump", "tool": "header-abi-dumper"},
273 ExecStrategy: "${config.REAbiDumperExecStrategy}",
Ulf Adams18931762020-11-25 22:54:35 +0100274 Inputs: []string{"$sAbiLinkerLibs"},
Ramy Medhat31ec9422020-04-17 15:03:58 -0400275 Platform: map[string]string{
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500276 remoteexec.PoolKey: "${config.RECXXPool}",
Ramy Medhat31ec9422020-04-17 15:03:58 -0400277 },
278 }, []string{"cFlags", "exportDirs"}, nil)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800279
Jayant Chowdharya4c6df52018-02-20 12:36:51 -0800280 _ = pctx.SourcePathVariable("sAbiLinker", "prebuilts/clang-tools/${config.HostPrebuiltTag}/bin/header-abi-linker")
Ramy Medhat808594c2020-05-07 06:56:47 -0400281 _ = pctx.SourcePathVariable("sAbiLinkerLibs", "prebuilts/clang-tools/${config.HostPrebuiltTag}/lib64")
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800282
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500283 // Rule to combine .dump sAbi dump files from multiple source files into a single .ldump
284 // sAbi dump file.
Colin Cross77cdcfd2021-03-12 11:28:25 -0800285 sAbiLink, sAbiLinkRE = pctx.RemoteStaticRules("sAbiLink",
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800286 blueprint.RuleParams{
Hsin-Yi Chen79781a92021-07-09 15:59:03 +0800287 Command: "$reTemplate$sAbiLinker --root-dir . --root-dir $$OUT_DIR:out -o ${out} $symbolFilter -arch $arch $exportedHeaderFlags @${out}.rsp",
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800288 CommandDeps: []string{"$sAbiLinker"},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800289 Rspfile: "${out}.rsp",
290 RspfileContent: "${in}",
Ramy Medhat808594c2020-05-07 06:56:47 -0400291 }, &remoteexec.REParams{
292 Labels: map[string]string{"type": "tool", "name": "abi-linker"},
293 ExecStrategy: "${config.REAbiLinkerExecStrategy}",
Ramy Medhat6797edc2020-08-28 14:21:55 -0400294 Inputs: []string{"$sAbiLinkerLibs", "${out}.rsp", "$implicitInputs"},
Colin Crossa4eafdd2021-03-24 14:09:28 -0700295 RSPFiles: []string{"${out}.rsp"},
Ramy Medhat808594c2020-05-07 06:56:47 -0400296 OutputFiles: []string{"$out"},
297 ToolchainInputs: []string{"$sAbiLinker"},
298 Platform: map[string]string{remoteexec.PoolKey: "${config.RECXXPool}"},
Ramy Medhat6797edc2020-08-28 14:21:55 -0400299 }, []string{"symbolFilter", "arch", "exportedHeaderFlags"}, []string{"implicitInputs"})
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800300
Jayant Chowdharya4c6df52018-02-20 12:36:51 -0800301 _ = pctx.SourcePathVariable("sAbiDiffer", "prebuilts/clang-tools/${config.HostPrebuiltTag}/bin/header-abi-diff")
Jayant Chowdhary715cac32017-04-20 06:53:59 -0700302
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500303 // Rule to compare linked sAbi dump files (.ldump).
Colin Cross2e2dbc22019-09-25 13:31:46 -0700304 sAbiDiff = pctx.RuleFunc("sAbiDiff",
Dan Willemsen54daaf02018-03-12 13:24:09 -0700305 func(ctx android.PackageRuleContext) blueprint.RuleParams {
Logan Chien2a65dda2019-10-01 15:58:07 -0700306 commandStr := "($sAbiDiffer ${extraFlags} -lib ${libName} -arch ${arch} -o ${out} -new ${in} -old ${referenceDump})"
Mu-Le Leef7d0b432022-08-10 08:21:06 +0000307 commandStr += "|| (echo '${errorMessage}'"
Logan Chien8f74fe62019-01-28 12:14:54 +0800308 commandStr += " && (mkdir -p $$DIST_DIR/abidiffs && cp ${out} $$DIST_DIR/abidiffs/)"
Jayant Chowdharyd8b70a32018-02-01 17:23:09 -0800309 commandStr += " && exit 1)"
Jayant Chowdhary219139d2017-11-27 14:52:21 -0800310 return blueprint.RuleParams{
311 Command: commandStr,
312 CommandDeps: []string{"$sAbiDiffer"},
Dan Willemsen54daaf02018-03-12 13:24:09 -0700313 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800314 },
Mu-Le Leef7d0b432022-08-10 08:21:06 +0000315 "extraFlags", "referenceDump", "libName", "arch", "errorMessage")
Jayant Chowdhary715cac32017-04-20 06:53:59 -0700316
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500317 // Rule to zip files.
Oliver Nguyenc7434142019-04-24 14:22:25 -0700318 zip = pctx.AndroidStaticRule("zip",
319 blueprint.RuleParams{
Colin Cross053fca12020-08-19 13:51:47 -0700320 Command: "${SoongZipCmd} -o ${out} -C $$OUT_DIR -r ${out}.rsp",
Oliver Nguyenc7434142019-04-24 14:22:25 -0700321 CommandDeps: []string{"${SoongZipCmd}"},
Colin Cross053fca12020-08-19 13:51:47 -0700322 Rspfile: "${out}.rsp",
Oliver Nguyenc7434142019-04-24 14:22:25 -0700323 RspfileContent: "$in",
324 })
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800325
326 _ = pctx.SourcePathVariable("cxxExtractor",
327 "prebuilts/clang-tools/${config.HostPrebuiltTag}/bin/cxx_extractor")
Sasha Smundak65143642019-09-26 20:14:28 -0700328 _ = pctx.SourcePathVariable("kytheVnames", "build/soong/vnames.json")
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800329 _ = pctx.VariableFunc("kytheCorpus",
330 func(ctx android.PackageVarContext) string { return ctx.Config().XrefCorpusName() })
Sasha Smundak6c2d4f92020-01-09 17:34:23 -0800331 _ = pctx.VariableFunc("kytheCuEncoding",
332 func(ctx android.PackageVarContext) string { return ctx.Config().XrefCuEncoding() })
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500333
334 // Rule to use kythe extractors to generate .kzip files, used to build code cross references.
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800335 kytheExtract = pctx.StaticRule("kythe",
336 blueprint.RuleParams{
Sasha Smundak6c2d4f92020-01-09 17:34:23 -0800337 Command: `rm -f $out && ` +
Sasha Smundaka4ef83b2020-04-21 17:08:35 -0700338 `KYTHE_CORPUS=${kytheCorpus} ` +
339 `KYTHE_OUTPUT_FILE=$out ` +
340 `KYTHE_VNAMES=$kytheVnames ` +
341 `KYTHE_KZIP_ENCODING=${kytheCuEncoding} ` +
342 `KYTHE_CANONICALIZE_VNAME_PATHS=prefer-relative ` +
Sasha Smundak6c2d4f92020-01-09 17:34:23 -0800343 `$cxxExtractor $cFlags $in `,
Sasha Smundak65143642019-09-26 20:14:28 -0700344 CommandDeps: []string{"$cxxExtractor", "$kytheVnames"},
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800345 },
346 "cFlags")
Ivan Lozano0a468a42024-05-13 21:03:34 -0400347
348 // Function pointer for producting staticlibs from rlibs. Corresponds to
349 // rust.TransformRlibstoStaticlib(), initialized in soong-rust (rust/builder.go init())
350 //
351 // This is required since soong-rust depends on soong-cc, so soong-cc cannot depend on soong-rust
352 // without resulting in a circular dependency. Setting this function pointer in soong-rust allows
353 // soong-cc to call into this particular function.
354 TransformRlibstoStaticlib (func(ctx android.ModuleContext, mainSrc android.Path, deps []RustRlibDep,
355 outputFile android.WritablePath) android.Path) = nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800356)
357
Ivan Lozanof3717ee2020-05-20 09:03:20 -0400358func PwdPrefix() string {
359 // Darwin doesn't have /proc
360 if runtime.GOOS != "darwin" {
361 return "PWD=/proc/self/cwd"
362 }
363 return ""
364}
365
Dan Willemsen322a0a62015-11-17 15:19:46 -0800366func init() {
367 // We run gcc/clang with PWD=/proc/self/cwd to remove $TOP from the
368 // debug output. That way two builds in two different directories will
369 // create the same output.
Ivan Lozanof3717ee2020-05-20 09:03:20 -0400370 pctx.StaticVariable("relPwd", PwdPrefix())
Oliver Nguyenc7434142019-04-24 14:22:25 -0700371
372 pctx.HostBinToolVariable("SoongZipCmd", "soong_zip")
Dan Willemsen322a0a62015-11-17 15:19:46 -0800373}
374
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500375// builderFlags contains various types of command line flags (and settings) for use in building
376// build statements related to C++.
Colin Cross3f40fa42015-01-30 17:27:36 -0800377type builderFlags struct {
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500378 // Global flags (which build system or toolchain is responsible for). These are separate from
379 // local flags because they should appear first (so that they may be overridden by local flags).
Colin Cross6d88dba2019-11-06 07:06:58 -0800380 globalCommonFlags string
381 globalAsFlags string
382 globalYasmFlags string
383 globalCFlags string
384 globalToolingCFlags string // A separate set of cFlags for clang LibTooling tools
385 globalToolingCppFlags string // A separate set of cppFlags for clang LibTooling tools
386 globalConlyFlags string
387 globalCppFlags string
388 globalLdFlags string
389
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500390 // Local flags (which individual modules are responsible for). These may override global flags.
Colin Cross6d88dba2019-11-06 07:06:58 -0800391 localCommonFlags string
392 localAsFlags string
393 localYasmFlags string
394 localCFlags string
395 localToolingCFlags string // A separate set of cFlags for clang LibTooling tools
396 localToolingCppFlags string // A separate set of cppFlags for clang LibTooling tools
397 localConlyFlags string
398 localCppFlags string
399 localLdFlags string
400
Luis Useche342fa6b2024-04-01 19:33:18 -0700401 noOverrideFlags string // Flags appended at the end so they are not overridden.
402 libFlags string // Flags to add to the linker directly after specifying libraries to link.
403 extraLibFlags string // Flags to add to the linker last.
404 tidyFlags string // Flags that apply to clang-tidy
405 sAbiFlags string // Flags that apply to header-abi-dumps
406 aidlFlags string // Flags that apply to aidl source files
407 rsFlags string // Flags that apply to renderscript source files
408 toolchain config.Toolchain
Colin Cross665dce92016-04-28 14:50:03 -0700409
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500410 // True if these extra features are enabled.
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800411 tidy bool
412 needTidyFiles bool
413 gcovCoverage bool
414 sAbiDump bool
415 emitXrefs bool
kellyhungd62ea302024-05-19 21:16:07 +0800416 clangVerify bool
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500417
418 assemblerWithCpp bool // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700419
Colin Crossc3199482017-03-30 15:03:04 -0700420 systemIncludeFlags string
421
Colin Cross19878da2019-03-28 14:45:07 -0700422 proto android.ProtoFlags
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500423 protoC bool // If true, compile protos as `.c` files. Otherwise, output as `.cc`.
424 protoOptionsFile bool // If true, output a proto options file.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700425
426 yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200427 lex *LexProperties
Colin Cross3f40fa42015-01-30 17:27:36 -0800428}
429
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500430// StripFlags represents flags related to stripping. This is separate from builderFlags, as these
431// flags are useful outside of this package (such as for Rust).
Thiébaud Weksteend4587452020-08-19 14:53:01 +0200432type StripFlags struct {
433 Toolchain config.Toolchain
434 StripKeepSymbols bool
435 StripKeepSymbolsList string
436 StripKeepSymbolsAndDebugFrame bool
437 StripKeepMiniDebugInfo bool
438 StripAddGnuDebuglink bool
439 StripUseGnuStrip bool
440}
441
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500442// Objects is a collection of file paths corresponding to outputs for C++ related build statements.
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700443type Objects struct {
Dan Willemsen581341d2017-02-09 16:16:31 -0800444 objFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700445 tidyFiles android.Paths
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800446 tidyDepFiles android.Paths // link dependent .tidy files
Dan Willemsen581341d2017-02-09 16:16:31 -0800447 coverageFiles android.Paths
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800448 sAbiDumpFiles android.Paths
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800449 kytheFiles android.Paths
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700450}
451
452func (a Objects) Copy() Objects {
453 return Objects{
Dan Willemsen581341d2017-02-09 16:16:31 -0800454 objFiles: append(android.Paths{}, a.objFiles...),
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700455 tidyFiles: append(android.Paths{}, a.tidyFiles...),
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800456 tidyDepFiles: append(android.Paths{}, a.tidyDepFiles...),
Dan Willemsen581341d2017-02-09 16:16:31 -0800457 coverageFiles: append(android.Paths{}, a.coverageFiles...),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800458 sAbiDumpFiles: append(android.Paths{}, a.sAbiDumpFiles...),
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800459 kytheFiles: append(android.Paths{}, a.kytheFiles...),
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700460 }
461}
462
463func (a Objects) Append(b Objects) Objects {
464 return Objects{
Dan Willemsen581341d2017-02-09 16:16:31 -0800465 objFiles: append(a.objFiles, b.objFiles...),
466 tidyFiles: append(a.tidyFiles, b.tidyFiles...),
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800467 tidyDepFiles: append(a.tidyDepFiles, b.tidyDepFiles...),
Dan Willemsen581341d2017-02-09 16:16:31 -0800468 coverageFiles: append(a.coverageFiles, b.coverageFiles...),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800469 sAbiDumpFiles: append(a.sAbiDumpFiles, b.sAbiDumpFiles...),
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800470 kytheFiles: append(a.kytheFiles, b.kytheFiles...),
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700471 }
472}
473
Colin Cross3f40fa42015-01-30 17:27:36 -0800474// Generate rules for compiling multiple .c, .cpp, or .S files to individual .o files
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000475func transformSourceToObj(ctx android.ModuleContext, subdir string, srcFiles, noTidySrcs, timeoutTidySrcs android.Paths,
476 flags builderFlags, pathDeps android.Paths, cFlagsDeps android.Paths, sharedFlags *SharedFlags) Objects {
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000477
478 // Not all source files produce a .o; a Rust source provider
479 // may provide both a .c and a .rs file (e.g. rust_bindgen).
480 srcObjFiles := android.Paths{}
481 for _, src := range srcFiles {
482 if src.Ext() != ".rs" {
483 srcObjFiles = append(srcObjFiles, src)
484 }
485 }
486
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500487 // Source files are one-to-one with tidy, coverage, or kythe files, if enabled.
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000488 objFiles := make(android.Paths, len(srcObjFiles))
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700489 var tidyFiles android.Paths
Chih-Hung Hsieh8439a142022-02-15 15:32:57 -0800490 noTidySrcsMap := make(map[string]bool)
Chih-Hung Hsieh95dfbce2021-09-09 19:12:05 -0700491 var tidyVars string
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700492 if flags.tidy {
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000493 tidyFiles = make(android.Paths, 0, len(srcObjFiles))
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700494 for _, path := range noTidySrcs {
Chih-Hung Hsieh8439a142022-02-15 15:32:57 -0800495 noTidySrcsMap[path.String()] = true
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700496 }
Chih-Hung Hsieh95dfbce2021-09-09 19:12:05 -0700497 tidyTimeout := ctx.Config().Getenv("TIDY_TIMEOUT")
498 if len(tidyTimeout) > 0 {
Chih-Hung Hsiehc74f63e2022-02-10 17:41:13 -0800499 tidyVars += "TIDY_TIMEOUT=" + tidyTimeout + " "
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800500 // add timeoutTidySrcs into noTidySrcsMap if TIDY_TIMEOUT is set
501 for _, path := range timeoutTidySrcs {
502 noTidySrcsMap[path.String()] = true
503 }
Chih-Hung Hsieh95dfbce2021-09-09 19:12:05 -0700504 }
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700505 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800506 var coverageFiles android.Paths
Oliver Nguyen04526782020-04-21 12:40:27 -0700507 if flags.gcovCoverage {
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000508 coverageFiles = make(android.Paths, 0, len(srcObjFiles))
Dan Willemsen581341d2017-02-09 16:16:31 -0800509 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800510 var kytheFiles android.Paths
Cole Faust9decf832024-06-11 11:45:53 -0700511 if flags.emitXrefs && ctx.Module() == ctx.PrimaryModule() {
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000512 kytheFiles = make(android.Paths, 0, len(srcObjFiles))
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800513 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800514
Colin Cross6d88dba2019-11-06 07:06:58 -0800515 // Produce fully expanded flags for use by C tools, C compiles, C++ tools, C++ compiles, and asm compiles
516 // respectively.
517 toolingCflags := flags.globalCommonFlags + " " +
518 flags.globalToolingCFlags + " " +
519 flags.globalConlyFlags + " " +
520 flags.localCommonFlags + " " +
521 flags.localToolingCFlags + " " +
522 flags.localConlyFlags + " " +
Luis Useche342fa6b2024-04-01 19:33:18 -0700523 flags.systemIncludeFlags + " " +
524 flags.noOverrideFlags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700525
Colin Cross6d88dba2019-11-06 07:06:58 -0800526 cflags := flags.globalCommonFlags + " " +
527 flags.globalCFlags + " " +
528 flags.globalConlyFlags + " " +
529 flags.localCommonFlags + " " +
530 flags.localCFlags + " " +
531 flags.localConlyFlags + " " +
Luis Useche342fa6b2024-04-01 19:33:18 -0700532 flags.systemIncludeFlags + " " +
533 flags.noOverrideFlags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700534
Colin Cross6d88dba2019-11-06 07:06:58 -0800535 toolingCppflags := flags.globalCommonFlags + " " +
536 flags.globalToolingCFlags + " " +
537 flags.globalToolingCppFlags + " " +
538 flags.localCommonFlags + " " +
539 flags.localToolingCFlags + " " +
540 flags.localToolingCppFlags + " " +
Luis Useche342fa6b2024-04-01 19:33:18 -0700541 flags.systemIncludeFlags + " " +
542 flags.noOverrideFlags
Colin Crossc3199482017-03-30 15:03:04 -0700543
Colin Cross6d88dba2019-11-06 07:06:58 -0800544 cppflags := flags.globalCommonFlags + " " +
545 flags.globalCFlags + " " +
546 flags.globalCppFlags + " " +
547 flags.localCommonFlags + " " +
548 flags.localCFlags + " " +
549 flags.localCppFlags + " " +
Luis Useche342fa6b2024-04-01 19:33:18 -0700550 flags.systemIncludeFlags + " " +
551 flags.noOverrideFlags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700552
Colin Cross6d88dba2019-11-06 07:06:58 -0800553 asflags := flags.globalCommonFlags + " " +
554 flags.globalAsFlags + " " +
555 flags.localCommonFlags + " " +
556 flags.localAsFlags + " " +
557 flags.systemIncludeFlags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700558
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800559 var sAbiDumpFiles android.Paths
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700560 if flags.sAbiDump {
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000561 sAbiDumpFiles = make(android.Paths, 0, len(srcObjFiles))
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800562 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800563
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700564 // Multiple source files have build rules usually share the same cFlags or tidyFlags.
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000565 // SharedFlags provides one version for this module and shares it in multiple build rules.
566 // To simplify the code, the SharedFlags variables are all named as $flags<nnn>.
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700567 // Share flags only when there are multiple files or tidy rules.
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000568 var hasMultipleRules = len(srcObjFiles) > 1 || flags.tidy
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700569
570 var shareFlags = func(kind string, flags string) string {
571 if !hasMultipleRules || len(flags) < 60 {
572 // Modules have long names and so do the module variables.
573 // It does not save space by replacing a short name with a long one.
574 return flags
575 }
576 mapKey := kind + flags
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000577 n, ok := sharedFlags.FlagsMap[mapKey]
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700578 if !ok {
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000579 sharedFlags.NumSharedFlags += 1
580 n = strconv.Itoa(sharedFlags.NumSharedFlags)
581 sharedFlags.FlagsMap[mapKey] = n
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700582 ctx.Variable(pctx, kind+n, flags)
583 }
584 return "$" + kind + n
585 }
586
Ivan Lozano8d5ee742025-01-29 20:24:33 +0000587 for i, srcFile := range srcObjFiles {
Dan Willemsen21ec4902016-11-02 20:43:13 -0700588 objFile := android.ObjPathWithExt(ctx, subdir, srcFile, "o")
Colin Cross3f40fa42015-01-30 17:27:36 -0800589
590 objFiles[i] = objFile
591
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500592 // Register compilation build statements. The actual rule used depends on the source file type.
Dan Willemsen4f1c3d42017-09-09 01:15:26 -0700593 switch srcFile.Ext() {
594 case ".asm":
Colin Crossae887032017-10-23 17:16:14 -0700595 ctx.Build(pctx, android.BuildParams{
Colin Cross67a5c132017-05-09 13:45:28 -0700596 Rule: yasm,
597 Description: "yasm " + srcFile.Rel(),
598 Output: objFile,
599 Input: srcFile,
Pirama Arumuga Nainarf231b192018-01-23 10:49:04 -0800600 Implicits: cFlagsDeps,
601 OrderOnly: pathDeps,
Colin Cross91e90042016-12-02 17:13:24 -0800602 Args: map[string]string{
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700603 "asFlags": shareFlags("asFlags", flags.globalYasmFlags+" "+flags.localYasmFlags),
Colin Cross91e90042016-12-02 17:13:24 -0800604 },
605 })
606 continue
Pete Bentleyfcf55bf2019-08-16 20:14:32 +0100607 case ".o":
608 objFiles[i] = srcFile
609 continue
Colin Cross91e90042016-12-02 17:13:24 -0800610 }
611
Colin Cross6d88dba2019-11-06 07:06:58 -0800612 var moduleFlags string
613 var moduleToolingFlags string
614
Colin Cross3f40fa42015-01-30 17:27:36 -0800615 var ccCmd string
kellyhungd62ea302024-05-19 21:16:07 +0800616 var postCmd string
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700617 tidy := flags.tidy
Oliver Nguyen04526782020-04-21 12:40:27 -0700618 coverage := flags.gcovCoverage
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700619 dump := flags.sAbiDump
Dan Willemsenfcabb1c2019-01-03 23:25:11 -0800620 rule := cc
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800621 emitXref := flags.emitXrefs
Colin Cross3f40fa42015-01-30 17:27:36 -0800622
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700623 switch srcFile.Ext() {
Dan Willemsenfcabb1c2019-01-03 23:25:11 -0800624 case ".s":
Dan Willemsen98ab3112019-08-27 21:20:40 -0700625 if !flags.assemblerWithCpp {
626 rule = ccNoDeps
627 }
Dan Willemsenfcabb1c2019-01-03 23:25:11 -0800628 fallthrough
629 case ".S":
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700630 ccCmd = "clang"
Colin Cross6d88dba2019-11-06 07:06:58 -0800631 moduleFlags = asflags
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700632 tidy = false
Dan Willemsen581341d2017-02-09 16:16:31 -0800633 coverage = false
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800634 dump = false
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800635 emitXref = false
Colin Cross3f40fa42015-01-30 17:27:36 -0800636 case ".c":
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700637 ccCmd = "clang"
Colin Cross6d88dba2019-11-06 07:06:58 -0800638 moduleFlags = cflags
639 moduleToolingFlags = toolingCflags
Colin Crossd34ab7c2019-06-27 14:46:10 -0700640 case ".cpp", ".cc", ".cxx", ".mm":
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700641 ccCmd = "clang++"
Colin Cross6d88dba2019-11-06 07:06:58 -0800642 moduleFlags = cppflags
643 moduleToolingFlags = toolingCppflags
Ivan Lozano3b591c72024-05-02 10:07:04 -0400644 case ".rs":
645 // A source provider (e.g. rust_bindgen) may provide both rs and c files.
646 // Ignore the rs files.
647 continue
Liz Kammere2861132020-12-03 22:12:41 +0000648 case ".h", ".hpp":
649 ctx.PropertyErrorf("srcs", "Header file %s is not supported, instead use export_include_dirs or local_include_dirs.", srcFile)
650 continue
Colin Cross3f40fa42015-01-30 17:27:36 -0800651 default:
Liz Kammere2861132020-12-03 22:12:41 +0000652 ctx.PropertyErrorf("srcs", "File %s has unknown extension. Supported extensions: .s, .S, .c, .cpp, .cc, .cxx, .mm", srcFile)
Colin Cross3f40fa42015-01-30 17:27:36 -0800653 continue
654 }
655
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700656 // ccCmd is "clang" or "clang++"
Colin Cross67a5c132017-05-09 13:45:28 -0700657 ccDesc := ccCmd
658
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700659 ccCmd = "${config.ClangBin}/" + ccCmd
Colin Cross3f40fa42015-01-30 17:27:36 -0800660
kellyhungd62ea302024-05-19 21:16:07 +0800661 if flags.clangVerify {
kellyhungde1b6b02024-05-23 01:55:40 +0000662 postCmd = " && touch " + objFile.String()
kellyhungd62ea302024-05-19 21:16:07 +0800663 }
664
Dan Willemsen581341d2017-02-09 16:16:31 -0800665 var implicitOutputs android.WritablePaths
666 if coverage {
667 gcnoFile := android.ObjPathWithExt(ctx, subdir, srcFile, "gcno")
668 implicitOutputs = append(implicitOutputs, gcnoFile)
669 coverageFiles = append(coverageFiles, gcnoFile)
670 }
671
Colin Crossae887032017-10-23 17:16:14 -0700672 ctx.Build(pctx, android.BuildParams{
Dan Willemsenfcabb1c2019-01-03 23:25:11 -0800673 Rule: rule,
Colin Cross67a5c132017-05-09 13:45:28 -0700674 Description: ccDesc + " " + srcFile.Rel(),
Dan Willemsen581341d2017-02-09 16:16:31 -0800675 Output: objFile,
676 ImplicitOutputs: implicitOutputs,
677 Input: srcFile,
Pirama Arumuga Nainarf231b192018-01-23 10:49:04 -0800678 Implicits: cFlagsDeps,
679 OrderOnly: pathDeps,
Colin Cross3f40fa42015-01-30 17:27:36 -0800680 Args: map[string]string{
kellyhungd62ea302024-05-19 21:16:07 +0800681 "cFlags": shareFlags("cFlags", moduleFlags),
682 "ccCmd": ccCmd, // short and not shared
683 "postCmd": postCmd,
Colin Cross3f40fa42015-01-30 17:27:36 -0800684 },
685 })
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700686
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500687 // Register post-process build statements (such as for tidy or kythe).
Cole Faust9decf832024-06-11 11:45:53 -0700688 if emitXref && ctx.Module() == ctx.PrimaryModule() {
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800689 kytheFile := android.ObjPathWithExt(ctx, subdir, srcFile, "kzip")
690 ctx.Build(pctx, android.BuildParams{
691 Rule: kytheExtract,
692 Description: "Xref C++ extractor " + srcFile.Rel(),
693 Output: kytheFile,
694 Input: srcFile,
695 Implicits: cFlagsDeps,
696 OrderOnly: pathDeps,
697 Args: map[string]string{
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700698 "cFlags": shareFlags("cFlags", moduleFlags),
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800699 },
700 })
701 kytheFiles = append(kytheFiles, kytheFile)
702 }
703
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700704 // Even with tidy, some src file could be skipped by noTidySrcsMap.
Chih-Hung Hsieh8439a142022-02-15 15:32:57 -0800705 if tidy && !noTidySrcsMap[srcFile.String()] {
Dan Willemsen21ec4902016-11-02 20:43:13 -0700706 tidyFile := android.ObjPathWithExt(ctx, subdir, srcFile, "tidy")
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700707 tidyFiles = append(tidyFiles, tidyFile)
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700708 tidyCmd := "${config.ClangBin}/clang-tidy"
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700709
Kousik Kumar4e30bba2020-06-18 09:17:51 -0700710 rule := clangTidy
Ramy Medhat16f23a42020-09-03 01:29:49 -0400711 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_CLANG_TIDY") {
Kousik Kumar4e30bba2020-06-18 09:17:51 -0700712 rule = clangTidyRE
713 }
714
Pirama Arumuga Nainar6c771e72023-11-21 19:51:07 +0000715 sharedCFlags := shareFlags("cFlags", moduleFlags)
Chih-Hung Hsiehc74f63e2022-02-10 17:41:13 -0800716 srcRelPath := srcFile.Rel()
717
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700718 // Add the .tidy rule
Chih-Hung Hsiehc74f63e2022-02-10 17:41:13 -0800719 ctx.Build(pctx, android.BuildParams{
720 Rule: rule,
721 Description: "clang-tidy " + srcRelPath,
722 Output: tidyFile,
723 Input: srcFile,
724 Implicits: cFlagsDeps,
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700725 OrderOnly: pathDeps,
Chih-Hung Hsiehc74f63e2022-02-10 17:41:13 -0800726 Args: map[string]string{
727 "cFlags": sharedCFlags,
Chih-Hung Hsieh30ab2f02022-05-28 18:52:12 -0700728 "ccCmd": ccCmd,
729 "clangCmd": ccDesc,
730 "tidyCmd": tidyCmd,
Chih-Hung Hsiehc74f63e2022-02-10 17:41:13 -0800731 "tidyFlags": shareFlags("tidyFlags", config.TidyFlagsForSrcFile(srcFile, flags.tidyFlags)),
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700732 "tidyVars": tidyVars, // short and not shared
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700733 },
734 })
735 }
736
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800737 if dump {
738 sAbiDumpFile := android.ObjPathWithExt(ctx, subdir, srcFile, "sdump")
739 sAbiDumpFiles = append(sAbiDumpFiles, sAbiDumpFile)
740
Ramy Medhat31ec9422020-04-17 15:03:58 -0400741 dumpRule := sAbiDump
Hsin-Yi Chen0713e4f2022-08-17 12:50:13 +0800742 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ABI_DUMPER") {
743 dumpRule = sAbiDumpRE
744 }
Colin Crossae887032017-10-23 17:16:14 -0700745 ctx.Build(pctx, android.BuildParams{
Ramy Medhat31ec9422020-04-17 15:03:58 -0400746 Rule: dumpRule,
Colin Cross67a5c132017-05-09 13:45:28 -0700747 Description: "header-abi-dumper " + srcFile.Rel(),
748 Output: sAbiDumpFile,
749 Input: srcFile,
750 Implicit: objFile,
Dan Willemsen6b4419c2019-08-09 12:45:53 -0700751 Implicits: cFlagsDeps,
752 OrderOnly: pathDeps,
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800753 Args: map[string]string{
Chih-Hung Hsiehb8082292021-09-09 23:20:39 -0700754 "cFlags": shareFlags("cFlags", moduleToolingFlags),
755 "exportDirs": shareFlags("exportDirs", flags.sAbiFlags),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800756 },
757 })
758 }
759
Colin Cross3f40fa42015-01-30 17:27:36 -0800760 }
761
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800762 var tidyDepFiles android.Paths
763 if flags.needTidyFiles {
764 tidyDepFiles = tidyFiles
765 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700766 return Objects{
Dan Willemsen581341d2017-02-09 16:16:31 -0800767 objFiles: objFiles,
768 tidyFiles: tidyFiles,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800769 tidyDepFiles: tidyDepFiles,
Dan Willemsen581341d2017-02-09 16:16:31 -0800770 coverageFiles: coverageFiles,
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800771 sAbiDumpFiles: sAbiDumpFiles,
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800772 kytheFiles: kytheFiles,
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700773 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800774}
775
776// Generate a rule for compiling multiple .o files to a static library (.a)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500777func transformObjToStaticLib(ctx android.ModuleContext,
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100778 objFiles android.Paths, wholeStaticLibs android.Paths,
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700779 flags builderFlags, outputFile android.ModuleOutPath, deps android.Paths, validations android.Paths) {
Colin Cross3f40fa42015-01-30 17:27:36 -0800780
Stephen Hinesf1addeb2018-01-09 23:29:04 -0800781 arCmd := "${config.ClangBin}/llvm-ar"
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100782 arFlags := ""
Stephen Hinesf1addeb2018-01-09 23:29:04 -0800783 if !ctx.Darwin() {
Mitch Phillipsed0dd762022-01-25 10:35:50 -0800784 arFlags += " --format=gnu"
Stephen Hinesf1addeb2018-01-09 23:29:04 -0800785 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800786
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100787 if len(wholeStaticLibs) == 0 {
788 ctx.Build(pctx, android.BuildParams{
789 Rule: ar,
790 Description: "static link " + outputFile.Base(),
791 Output: outputFile,
792 Inputs: objFiles,
793 Implicits: deps,
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700794 Validations: validations,
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100795 Args: map[string]string{
796 "arFlags": "crsPD" + arFlags,
797 "arCmd": arCmd,
798 },
799 })
800
801 } else {
802 ctx.Build(pctx, android.BuildParams{
803 Rule: arWithLibs,
804 Description: "static link " + outputFile.Base(),
805 Output: outputFile,
806 Inputs: append(objFiles, wholeStaticLibs...),
807 Implicits: deps,
808 Args: map[string]string{
809 "arCmd": arCmd,
810 "arObjFlags": "crsPD" + arFlags,
811 "arObjs": strings.Join(objFiles.Strings(), " "),
812 "arLibFlags": "cqsL" + arFlags,
813 "arLibs": strings.Join(wholeStaticLibs.Strings(), " "),
814 },
815 })
816 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800817}
818
Ivan Lozano0a468a42024-05-13 21:03:34 -0400819// Generate a Rust staticlib from a list of rlibDeps. Returns nil if TransformRlibstoStaticlib is nil or rlibDeps is empty.
820func generateRustStaticlib(ctx android.ModuleContext, rlibDeps []RustRlibDep) android.Path {
821 if TransformRlibstoStaticlib == nil && len(rlibDeps) > 0 {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -0400822 // This should only be reachable if a module defines Rust deps in static_libs and
Ivan Lozano0a468a42024-05-13 21:03:34 -0400823 // soong-rust hasn't been loaded alongside soong-cc (e.g. in soong-cc tests).
Ivan Lozanofd47b1a2024-05-17 14:13:41 -0400824 panic(fmt.Errorf(
825 "TransformRlibstoStaticlib is not set and rust deps are defined in static_libs for %s",
826 ctx.ModuleName()))
827
Ivan Lozano0a468a42024-05-13 21:03:34 -0400828 } else if len(rlibDeps) == 0 {
829 return nil
830 }
831
Ivan Lozano872e8462024-10-30 19:30:48 +0000832 output := android.PathForModuleOut(ctx, "generated_rust_staticlib", "librustlibs.a")
Ivan Lozano0a468a42024-05-13 21:03:34 -0400833 stemFile := output.ReplaceExtension(ctx, "rs")
834 crateNames := []string{}
835
836 // Collect crate names
837 for _, lib := range rlibDeps {
838 // Exclude libstd so this can support no_std builds.
839 if lib.CrateName != "libstd" {
840 crateNames = append(crateNames, lib.CrateName)
841 }
842 }
843
844 // Deduplicate any crateNames just to be safe
845 crateNames = android.FirstUniqueStrings(crateNames)
846
847 // Write the source file
848 android.WriteFileRule(ctx, stemFile, genRustStaticlibSrcFile(crateNames))
849
850 return TransformRlibstoStaticlib(ctx, stemFile, rlibDeps, output)
851}
852
853func genRustStaticlibSrcFile(crateNames []string) string {
854 lines := []string{
855 "// @Soong generated Source",
Ivan Lozanofd47b1a2024-05-17 14:13:41 -0400856 "#![no_std]", // pre-emptively set no_std to support both std and no_std.
Ivan Lozano0a468a42024-05-13 21:03:34 -0400857 }
858 for _, crate := range crateNames {
859 lines = append(lines, fmt.Sprintf("extern crate %s;", crate))
860 }
861 return strings.Join(lines, "\n")
862}
863
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000864func BuildRustStubs(ctx android.ModuleContext, outputFile android.ModuleOutPath,
Ivan Lozano47596d62025-01-28 13:50:55 +0000865 stubObjs Objects, ccFlags Flags) {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000866
867 // Instantiate paths
868 sharedLibs := android.Paths{}
869 staticLibs := android.Paths{}
870 lateStaticLibs := android.Paths{}
871 wholeStaticLibs := android.Paths{}
872 deps := android.Paths{}
873 implicitOutputs := android.WritablePaths{}
874 validations := android.Paths{}
Ivan Lozano47596d62025-01-28 13:50:55 +0000875 crtBegin := android.Paths{}
876 crtEnd := android.Paths{}
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000877 groupLate := false
878
879 builderFlags := flagsToBuilderFlags(ccFlags)
880 transformObjToDynamicBinary(ctx, stubObjs.objFiles, sharedLibs, staticLibs,
881 lateStaticLibs, wholeStaticLibs, deps, crtBegin, crtEnd,
882 groupLate, builderFlags, outputFile, implicitOutputs, validations)
883}
884
Colin Cross3f40fa42015-01-30 17:27:36 -0800885// Generate a rule for compiling multiple .o files, plus static libraries, whole static libraries,
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700886// and shared libraries, to a shared library (.so) or dynamic executable
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500887func transformObjToDynamicBinary(ctx android.ModuleContext,
Colin Crossc465efd2021-06-11 18:00:04 -0700888 objFiles, sharedLibs, staticLibs, lateStaticLibs, wholeStaticLibs, deps, crtBegin, crtEnd android.Paths,
889 groupLate bool, flags builderFlags, outputFile android.WritablePath,
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700890 implicitOutputs android.WritablePaths, validations android.Paths) {
Colin Cross3f40fa42015-01-30 17:27:36 -0800891
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700892 ldCmd := "${config.ClangBin}/clang++"
Colin Cross3f40fa42015-01-30 17:27:36 -0800893
Colin Cross3f40fa42015-01-30 17:27:36 -0800894 var libFlagsList []string
895
Colin Cross16b23492016-01-06 14:41:07 -0800896 if len(flags.libFlags) > 0 {
897 libFlagsList = append(libFlagsList, flags.libFlags)
898 }
899
Colin Cross3f40fa42015-01-30 17:27:36 -0800900 if len(wholeStaticLibs) > 0 {
Dan Willemsen490fd492015-11-24 17:53:15 -0800901 if ctx.Host() && ctx.Darwin() {
Colin Cross635c3b02016-05-18 15:37:25 -0700902 libFlagsList = append(libFlagsList, android.JoinWithPrefix(wholeStaticLibs.Strings(), "-force_load "))
Colin Cross0af4b842015-04-30 16:36:18 -0700903 } else {
904 libFlagsList = append(libFlagsList, "-Wl,--whole-archive ")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700905 libFlagsList = append(libFlagsList, wholeStaticLibs.Strings()...)
Colin Cross0af4b842015-04-30 16:36:18 -0700906 libFlagsList = append(libFlagsList, "-Wl,--no-whole-archive ")
907 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800908 }
909
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700910 libFlagsList = append(libFlagsList, staticLibs.Strings()...)
Colin Cross3f40fa42015-01-30 17:27:36 -0800911
Stephen Hines10347862016-07-18 15:54:54 -0700912 if groupLate && !ctx.Darwin() && len(lateStaticLibs) > 0 {
Dan Willemsenedc385f2015-07-08 13:02:23 -0700913 libFlagsList = append(libFlagsList, "-Wl,--start-group")
914 }
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700915 libFlagsList = append(libFlagsList, lateStaticLibs.Strings()...)
Stephen Hines10347862016-07-18 15:54:54 -0700916 if groupLate && !ctx.Darwin() && len(lateStaticLibs) > 0 {
Dan Willemsenedc385f2015-07-08 13:02:23 -0700917 libFlagsList = append(libFlagsList, "-Wl,--end-group")
918 }
919
Colin Cross3f40fa42015-01-30 17:27:36 -0800920 for _, lib := range sharedLibs {
Josh Gao75a50a22019-06-07 17:58:59 -0700921 libFile := lib.String()
922 if ctx.Windows() {
923 libFile = pathtools.ReplaceExtension(libFile, "lib")
924 }
925 libFlagsList = append(libFlagsList, libFile)
Colin Cross3f40fa42015-01-30 17:27:36 -0800926 }
927
Colin Cross3f40fa42015-01-30 17:27:36 -0800928 deps = append(deps, staticLibs...)
Colin Cross3075ad02015-03-17 10:47:08 -0700929 deps = append(deps, lateStaticLibs...)
Colin Cross3f40fa42015-01-30 17:27:36 -0800930 deps = append(deps, wholeStaticLibs...)
Colin Crossc465efd2021-06-11 18:00:04 -0700931 deps = append(deps, crtBegin...)
932 deps = append(deps, crtEnd...)
Colin Cross3f40fa42015-01-30 17:27:36 -0800933
Ramy Medhat9a90fe52020-04-13 13:21:23 -0400934 rule := ld
Kousik Kumar3fb61262020-04-22 13:31:09 -0700935 args := map[string]string{
936 "ldCmd": ldCmd,
Colin Crossc465efd2021-06-11 18:00:04 -0700937 "crtBegin": strings.Join(crtBegin.Strings(), " "),
Kousik Kumar3fb61262020-04-22 13:31:09 -0700938 "libFlags": strings.Join(libFlagsList, " "),
939 "extraLibFlags": flags.extraLibFlags,
Colin Cross32320e82022-06-02 23:02:01 +0000940 "ldFlags": flags.globalLdFlags + " " + flags.localLdFlags,
Colin Crossc465efd2021-06-11 18:00:04 -0700941 "crtEnd": strings.Join(crtEnd.Strings(), " "),
Kousik Kumar3fb61262020-04-22 13:31:09 -0700942 }
Fabien Sanglardaa8020a2024-08-09 18:19:11 -0700943
944 // On Windows, we always generate a PDB file
945 // --strip-debug is needed to also keep COFF symbols which are needed when
946 // we patch binaries with symbol_inject.
947 if ctx.Windows() {
948 pdb := outputFile.ReplaceExtension(ctx, "pdb")
949 args["ldFlags"] = args["ldFlags"] + " -Wl,--strip-debug -Wl,--pdb=" + pdb.String() + " "
950 implicitOutputs = append(slices.Clone(implicitOutputs), pdb)
951 }
952
Ramy Medhat16f23a42020-09-03 01:29:49 -0400953 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_CXX_LINKS") {
Ramy Medhat9a90fe52020-04-13 13:21:23 -0400954 rule = ldRE
Kousik Kumar3fb61262020-04-22 13:31:09 -0700955 args["implicitOutputs"] = strings.Join(implicitOutputs.Strings(), ",")
Ramy Medhat6797edc2020-08-28 14:21:55 -0400956 args["implicitInputs"] = strings.Join(deps.Strings(), ",")
Ramy Medhat9a90fe52020-04-13 13:21:23 -0400957 }
958
Colin Crossae887032017-10-23 17:16:14 -0700959 ctx.Build(pctx, android.BuildParams{
Ramy Medhat9a90fe52020-04-13 13:21:23 -0400960 Rule: rule,
Josh Gao75a50a22019-06-07 17:58:59 -0700961 Description: "link " + outputFile.Base(),
962 Output: outputFile,
963 ImplicitOutputs: implicitOutputs,
964 Inputs: objFiles,
965 Implicits: deps,
Colin Cross58dd6a92021-05-13 17:45:36 -0700966 OrderOnly: sharedLibs,
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700967 Validations: validations,
Kousik Kumar3fb61262020-04-22 13:31:09 -0700968 Args: args,
Colin Cross3f40fa42015-01-30 17:27:36 -0800969 })
970}
971
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800972// Generate a rule to combine .dump sAbi dump files from multiple source files
973// into a single .ldump sAbi dump file
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500974func transformDumpToLinkedDump(ctx android.ModuleContext, sAbiDumps android.Paths, soFile android.Path,
Hsin-Yi Chenaf369882024-03-29 20:10:36 +0800975 baseName string, exportedIncludeDirs []string, symbolFile android.OptionalPath,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +0800976 excludedSymbolVersions, excludedSymbolTags, includedSymbolTags []string,
Hsin-Yi Chenea748242025-01-15 15:44:48 +0800977 api string, commonGlobalIncludes bool) android.Path {
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800978
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800979 outputFile := android.PathForModuleOut(ctx, baseName+".lsdump")
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800980
981 implicits := android.Paths{soFile}
Jayant Chowdharydf344d52018-01-17 11:11:42 -0800982 symbolFilterStr := "-so " + soFile.String()
Hsin-Yi Chenaf369882024-03-29 20:10:36 +0800983 exportedHeaderFlags := android.JoinWithPrefix(exportedIncludeDirs, "-I")
Hsin-Yi Chenea748242025-01-15 15:44:48 +0800984 // If this library does not export any include directory, do not append the flags
985 // so that the ABI tool dumps everything without filtering by the include directories.
986 if commonGlobalIncludes && len(exportedIncludeDirs) > 0 {
987 exportedHeaderFlags += " ${config.CommonGlobalIncludes}"
988 }
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800989
990 if symbolFile.Valid() {
991 implicits = append(implicits, symbolFile.Path())
992 symbolFilterStr += " -v " + symbolFile.String()
993 }
994 for _, ver := range excludedSymbolVersions {
995 symbolFilterStr += " --exclude-symbol-version " + ver
996 }
997 for _, tag := range excludedSymbolTags {
998 symbolFilterStr += " --exclude-symbol-tag " + tag
999 }
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001000 for _, tag := range includedSymbolTags {
1001 symbolFilterStr += " --include-symbol-tag " + tag
1002 }
Hsin-Yi Chen843c0632023-09-25 15:26:30 +08001003 apiLevelsJson := android.GetApiLevelsJson(ctx)
1004 implicits = append(implicits, apiLevelsJson)
1005 symbolFilterStr += " --api-map " + apiLevelsJson.String()
1006 symbolFilterStr += " --api " + api
1007
Ramy Medhat808594c2020-05-07 06:56:47 -04001008 rule := sAbiLink
1009 args := map[string]string{
1010 "symbolFilter": symbolFilterStr,
1011 "arch": ctx.Arch().ArchType.Name,
1012 "exportedHeaderFlags": exportedHeaderFlags,
1013 }
Ramy Medhat16f23a42020-09-03 01:29:49 -04001014 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ABI_LINKER") {
Ramy Medhat808594c2020-05-07 06:56:47 -04001015 rule = sAbiLinkRE
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001016 rbeImplicits := append(implicits.Strings(), exportedIncludeDirs...)
Ramy Medhat6797edc2020-08-28 14:21:55 -04001017 args["implicitInputs"] = strings.Join(rbeImplicits, ",")
Ramy Medhat808594c2020-05-07 06:56:47 -04001018 }
Colin Crossae887032017-10-23 17:16:14 -07001019 ctx.Build(pctx, android.BuildParams{
Ramy Medhat808594c2020-05-07 06:56:47 -04001020 Rule: rule,
Colin Cross67a5c132017-05-09 13:45:28 -07001021 Description: "header-abi-linker " + outputFile.Base(),
1022 Output: outputFile,
1023 Inputs: sAbiDumps,
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001024 Implicits: implicits,
Ramy Medhat808594c2020-05-07 06:56:47 -04001025 Args: args,
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001026 })
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001027 return outputFile
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001028}
1029
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001030func transformAbiDumpToAbiDiff(ctx android.ModuleContext, inputDump, referenceDump android.Path,
1031 baseName, nameExt string, extraFlags []string, errorMessage string) android.Path {
Logan Chienf3511742017-10-31 18:04:35 +08001032
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001033 var outputFile android.ModuleOutPath
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001034 if nameExt != "" {
1035 outputFile = android.PathForModuleOut(ctx, baseName+"."+nameExt+".abidiff")
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001036 } else {
Mu-Le Lee13043932022-08-27 08:55:25 +00001037 outputFile = android.PathForModuleOut(ctx, baseName+".abidiff")
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001038 }
Jayant Chowdharyc7434e22018-05-31 15:42:26 -07001039 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
Logan Chien6227fed2019-02-18 13:12:21 +08001040
Colin Crossae887032017-10-23 17:16:14 -07001041 ctx.Build(pctx, android.BuildParams{
Colin Cross67a5c132017-05-09 13:45:28 -07001042 Rule: sAbiDiff,
1043 Description: "header-abi-diff " + outputFile.Base(),
1044 Output: outputFile,
1045 Input: inputDump,
1046 Implicit: referenceDump,
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001047 Args: map[string]string{
Mu-Le Leef7d0b432022-08-10 08:21:06 +00001048 "referenceDump": referenceDump.String(),
1049 "libName": libName,
1050 "arch": ctx.Arch().ArchType.Name,
1051 "extraFlags": strings.Join(extraFlags, " "),
1052 "errorMessage": errorMessage,
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001053 },
1054 })
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001055 return outputFile
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001056}
1057
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001058// Generate a rule for extracting a table of contents from a shared library (.so)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001059func TransformSharedObjectToToc(ctx android.ModuleContext, inputFile android.Path, outputFile android.WritablePath) {
Colin Cross26c34ed2016-09-30 17:10:16 -07001060
Colin Crossb496cfd2018-09-10 16:50:05 -07001061 var format string
Colin Crossb496cfd2018-09-10 16:50:05 -07001062 if ctx.Darwin() {
1063 format = "--macho"
Colin Crossb496cfd2018-09-10 16:50:05 -07001064 } else if ctx.Windows() {
1065 format = "--pe"
Colin Crossb496cfd2018-09-10 16:50:05 -07001066 } else {
1067 format = "--elf"
Colin Crossb496cfd2018-09-10 16:50:05 -07001068 }
Colin Cross26c34ed2016-09-30 17:10:16 -07001069
Colin Crossae887032017-10-23 17:16:14 -07001070 ctx.Build(pctx, android.BuildParams{
Colin Cross67a5c132017-05-09 13:45:28 -07001071 Rule: toc,
1072 Description: "generate toc " + inputFile.Base(),
1073 Output: outputFile,
1074 Input: inputFile,
Colin Cross26c34ed2016-09-30 17:10:16 -07001075 Args: map[string]string{
Yi Kong4ad44e72021-04-01 17:45:42 +08001076 "clangBin": "${config.ClangBin}",
1077 "format": format,
Colin Cross26c34ed2016-09-30 17:10:16 -07001078 },
1079 })
1080}
1081
Colin Cross3f40fa42015-01-30 17:27:36 -08001082// Generate a rule for compiling multiple .o files to a .o using ld partial linking
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001083func transformObjsToObj(ctx android.ModuleContext, objFiles android.Paths,
Dan Willemsen724ab5d2019-09-19 10:50:18 -07001084 flags builderFlags, outputFile android.WritablePath, deps android.Paths) {
Colin Cross3f40fa42015-01-30 17:27:36 -08001085
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001086 ldCmd := "${config.ClangBin}/clang++"
Colin Cross3f40fa42015-01-30 17:27:36 -08001087
Ramy Medhat9a90fe52020-04-13 13:21:23 -04001088 rule := partialLd
1089 args := map[string]string{
1090 "ldCmd": ldCmd,
Colin Cross32320e82022-06-02 23:02:01 +00001091 "ldFlags": flags.globalLdFlags + " " + flags.localLdFlags,
Ramy Medhat9a90fe52020-04-13 13:21:23 -04001092 }
Ramy Medhat16f23a42020-09-03 01:29:49 -04001093 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_CXX_LINKS") {
Ramy Medhat9a90fe52020-04-13 13:21:23 -04001094 rule = partialLdRE
1095 args["inCommaList"] = strings.Join(objFiles.Strings(), ",")
Ramy Medhat6797edc2020-08-28 14:21:55 -04001096 args["implicitInputs"] = strings.Join(deps.Strings(), ",")
Ramy Medhat9a90fe52020-04-13 13:21:23 -04001097 }
Colin Crossae887032017-10-23 17:16:14 -07001098 ctx.Build(pctx, android.BuildParams{
Ramy Medhat9a90fe52020-04-13 13:21:23 -04001099 Rule: rule,
Colin Cross67a5c132017-05-09 13:45:28 -07001100 Description: "link " + outputFile.Base(),
1101 Output: outputFile,
1102 Inputs: objFiles,
Dan Willemsen724ab5d2019-09-19 10:50:18 -07001103 Implicits: deps,
Ramy Medhat9a90fe52020-04-13 13:21:23 -04001104 Args: args,
Colin Cross3f40fa42015-01-30 17:27:36 -08001105 })
1106}
1107
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001108// Generate a rule for running objcopy --prefix-symbols on a binary
1109func transformBinaryPrefixSymbols(ctx android.ModuleContext, prefix string, inputFile android.Path,
Colin Cross635c3b02016-05-18 15:37:25 -07001110 flags builderFlags, outputFile android.WritablePath) {
Colin Crossbfae8852015-03-26 14:44:11 -07001111
Elliott Hughes2e70f792021-04-19 12:58:43 -07001112 objcopyCmd := "${config.ClangBin}/llvm-objcopy"
Colin Crossbfae8852015-03-26 14:44:11 -07001113
Colin Crossae887032017-10-23 17:16:14 -07001114 ctx.Build(pctx, android.BuildParams{
Colin Cross67a5c132017-05-09 13:45:28 -07001115 Rule: prefixSymbols,
1116 Description: "prefix symbols " + outputFile.Base(),
1117 Output: outputFile,
1118 Input: inputFile,
Colin Crossbfae8852015-03-26 14:44:11 -07001119 Args: map[string]string{
1120 "objcopyCmd": objcopyCmd,
1121 "prefix": prefix,
1122 },
1123 })
1124}
1125
Colin Crossdea1d032022-12-06 14:50:08 -08001126// Generate a rule for running objcopy --remove-section=.llvm_addrsig on a partially linked object
1127func transformObjectNoAddrSig(ctx android.ModuleContext, inputFile android.Path, outputFile android.WritablePath) {
1128 objcopyCmd := "${config.ClangBin}/llvm-objcopy"
1129
1130 ctx.Build(pctx, android.BuildParams{
1131 Rule: noAddrSig,
1132 Description: "remove addrsig " + outputFile.Base(),
1133 Output: outputFile,
1134 Input: inputFile,
1135 Args: map[string]string{
1136 "objcopyCmd": objcopyCmd,
1137 },
1138 })
1139}
1140
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001141// Registers a build statement to invoke `strip` (to discard symbols and data from object files).
1142func transformStrip(ctx android.ModuleContext, inputFile android.Path,
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001143 outputFile android.WritablePath, flags StripFlags) {
Colin Cross665dce92016-04-28 14:50:03 -07001144
Colin Cross665dce92016-04-28 14:50:03 -07001145 args := ""
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001146 if flags.StripAddGnuDebuglink {
Colin Cross665dce92016-04-28 14:50:03 -07001147 args += " --add-gnu-debuglink"
1148 }
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001149 if flags.StripKeepMiniDebugInfo {
Colin Cross665dce92016-04-28 14:50:03 -07001150 args += " --keep-mini-debug-info"
1151 }
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001152 if flags.StripKeepSymbols {
Colin Cross665dce92016-04-28 14:50:03 -07001153 args += " --keep-symbols"
1154 }
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001155 if flags.StripKeepSymbolsList != "" {
1156 args += " -k" + flags.StripKeepSymbolsList
Yi Kongacee27c2019-03-29 20:05:14 -07001157 }
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001158 if flags.StripKeepSymbolsAndDebugFrame {
Christopher Ferrisb43fe7a2019-05-17 16:39:54 -07001159 args += " --keep-symbols-and-debug-frame"
1160 }
Wei Li5f5d2712023-12-11 15:40:29 -08001161 if ctx.Windows() {
1162 args += " --windows"
1163 }
Colin Cross665dce92016-04-28 14:50:03 -07001164
Colin Crossae887032017-10-23 17:16:14 -07001165 ctx.Build(pctx, android.BuildParams{
Colin Cross67a5c132017-05-09 13:45:28 -07001166 Rule: strip,
1167 Description: "strip " + outputFile.Base(),
1168 Output: outputFile,
1169 Input: inputFile,
Colin Cross665dce92016-04-28 14:50:03 -07001170 Args: map[string]string{
Elliott Hughesafcd3392021-05-05 13:54:11 -07001171 "args": args,
Colin Cross665dce92016-04-28 14:50:03 -07001172 },
1173 })
1174}
1175
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001176// Registers build statement to invoke `strip` on darwin architecture.
1177func transformDarwinStrip(ctx android.ModuleContext, inputFile android.Path,
Colin Cross635c3b02016-05-18 15:37:25 -07001178 outputFile android.WritablePath) {
Colin Crossb8ecdfe2016-05-03 15:10:29 -07001179
Colin Crossae887032017-10-23 17:16:14 -07001180 ctx.Build(pctx, android.BuildParams{
Colin Cross67a5c132017-05-09 13:45:28 -07001181 Rule: darwinStrip,
1182 Description: "strip " + outputFile.Base(),
1183 Output: outputFile,
1184 Input: inputFile,
Colin Crossb8ecdfe2016-05-03 15:10:29 -07001185 })
1186}
1187
Dan Willemsen47450072021-10-19 20:24:49 -07001188func transformDarwinUniversalBinary(ctx android.ModuleContext, outputFile android.WritablePath, inputFiles ...android.Path) {
1189 ctx.Build(pctx, android.BuildParams{
1190 Rule: darwinLipo,
1191 Description: "lipo " + outputFile.Base(),
1192 Output: outputFile,
1193 Inputs: inputFiles,
1194 })
1195}
1196
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001197// Registers build statement to zip one or more coverage files.
1198func transformCoverageFilesToZip(ctx android.ModuleContext,
Oliver Nguyenc7434142019-04-24 14:22:25 -07001199 inputs Objects, baseName string) android.OptionalPath {
Dan Willemsen581341d2017-02-09 16:16:31 -08001200
1201 if len(inputs.coverageFiles) > 0 {
Oliver Nguyenc7434142019-04-24 14:22:25 -07001202 outputFile := android.PathForModuleOut(ctx, baseName+".zip")
Dan Willemsen581341d2017-02-09 16:16:31 -08001203
Oliver Nguyenc7434142019-04-24 14:22:25 -07001204 ctx.Build(pctx, android.BuildParams{
1205 Rule: zip,
1206 Description: "zip " + outputFile.Base(),
1207 Inputs: inputs.coverageFiles,
1208 Output: outputFile,
1209 })
Dan Willemsen581341d2017-02-09 16:16:31 -08001210
1211 return android.OptionalPathForPath(outputFile)
1212 }
1213
1214 return android.OptionalPath{}
1215}
1216
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001217// Rule to repack an archive (.a) file with a subset of object files.
1218func transformArchiveRepack(ctx android.ModuleContext, inputFile android.Path,
Yi Kongc49c3932019-10-15 02:01:19 -07001219 outputFile android.WritablePath, objects []string) {
1220
1221 ctx.Build(pctx, android.BuildParams{
1222 Rule: archiveRepack,
1223 Description: "Repack archive " + outputFile.Base(),
1224 Output: outputFile,
1225 Input: inputFile,
1226 Args: map[string]string{
1227 "objects": strings.Join(objects, " "),
1228 },
1229 })
1230}