blob: de049f77ffa5d495d15c3aab57f2198a2c478194 [file] [log] [blame]
Ivan Lozanoffee3342019-08-27 12:03:00 -07001// Copyright 2019 The Android Open Source Project
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 rust
16
17import (
Chris Parsons637458d2023-09-19 20:09:00 +000018 "fmt"
19 "strings"
20
Sasha Smundaka76acba2022-04-18 20:12:56 -070021 "android/soong/bloaty"
Aditya Choudhary87b2ab22023-11-17 15:27:06 +000022 "android/soong/testing"
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090023
Ivan Lozanoffee3342019-08-27 12:03:00 -070024 "github.com/google/blueprint"
25 "github.com/google/blueprint/proptools"
26
27 "android/soong/android"
28 "android/soong/cc"
Thiébaud Weksteen31f1bb82020-08-27 13:37:29 +020029 cc_config "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070030 "android/soong/fuzz"
Spandan Das604f3762023-03-16 22:51:40 +000031 "android/soong/multitree"
Ivan Lozanoffee3342019-08-27 12:03:00 -070032 "android/soong/rust/config"
33)
34
35var pctx = android.NewPackageContext("android/soong/rust")
36
37func init() {
Ivan Lozanoffee3342019-08-27 12:03:00 -070038 android.RegisterModuleType("rust_defaults", defaultsFactory)
39 android.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
40 ctx.BottomUp("rust_libraries", LibraryMutator).Parallel()
Ivan Lozano2b081132020-09-08 12:46:52 -040041 ctx.BottomUp("rust_stdlinkage", LibstdMutator).Parallel()
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -040042 ctx.BottomUp("rust_begin", BeginMutator).Parallel()
Ivan Lozano6cd99e62020-02-11 08:24:25 -050043 })
44 android.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
45 ctx.BottomUp("rust_sanitizers", rustSanitizerRuntimeMutator).Parallel()
Ivan Lozanoffee3342019-08-27 12:03:00 -070046 })
Inseob Kim3b244062023-07-11 13:31:36 +090047 pctx.Import("android/soong/android")
Ivan Lozanoffee3342019-08-27 12:03:00 -070048 pctx.Import("android/soong/rust/config")
Thiébaud Weksteen682c9d72020-08-31 10:06:16 +020049 pctx.ImportAs("cc_config", "android/soong/cc/config")
LaMont Jones0c10e4d2023-05-16 00:58:37 +000050 android.InitRegistrationContext.RegisterParallelSingletonType("kythe_rust_extract", kytheExtractRustFactory)
Ivan Lozanoffee3342019-08-27 12:03:00 -070051}
52
53type Flags struct {
Ivan Lozano8a23fa42020-06-16 10:26:57 -040054 GlobalRustFlags []string // Flags that apply globally to rust
55 GlobalLinkFlags []string // Flags that apply globally to linker
56 RustFlags []string // Flags that apply to rust
57 LinkFlags []string // Flags that apply to linker
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020058 ClippyFlags []string // Flags that apply to clippy-driver, during the linting
Dan Albert06feee92021-03-19 15:06:02 -070059 RustdocFlags []string // Flags that apply to rustdoc
Ivan Lozanof1c84332019-09-20 11:00:37 -070060 Toolchain config.Toolchain
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -040061 Coverage bool
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020062 Clippy bool
Sasha Smundaka76acba2022-04-18 20:12:56 -070063 EmitXrefs bool // If true, emit rules to aid cross-referencing
Ivan Lozanoffee3342019-08-27 12:03:00 -070064}
65
66type BaseProperties struct {
Liz Kammer884fe9e2023-02-28 14:29:13 -050067 AndroidMkRlibs []string `blueprint:"mutated"`
68 AndroidMkDylibs []string `blueprint:"mutated"`
69 AndroidMkProcMacroLibs []string `blueprint:"mutated"`
Liz Kammer884fe9e2023-02-28 14:29:13 -050070 AndroidMkStaticLibs []string `blueprint:"mutated"`
Ivan Lozano1dbfa142024-03-29 14:48:11 +000071 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Ivan Lozano43845682020-07-09 21:03:28 -040072
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090073 ImageVariation string `blueprint:"mutated"`
74 VndkVersion string `blueprint:"mutated"`
75 SubName string `blueprint:"mutated"`
Ivan Lozano6a884432020-12-02 09:15:16 -050076
Ivan Lozanoc08897c2021-04-02 12:41:32 -040077 // SubName is used by CC for tracking image variants / SDK versions. RustSubName is used for Rust-specific
78 // subnaming which shouldn't be visible to CC modules (such as the rlib stdlinkage subname). This should be
79 // appended before SubName.
80 RustSubName string `blueprint:"mutated"`
81
Ivan Lozano6a884432020-12-02 09:15:16 -050082 // Set by imageMutator
Ivan Lozanoe6d30982021-02-05 10:57:43 -050083 CoreVariantNeeded bool `blueprint:"mutated"`
84 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
Matthew Maurerc6868382021-07-13 14:12:37 -070085 RamdiskVariantNeeded bool `blueprint:"mutated"`
Matthew Maurer460ee942021-02-11 12:31:46 -080086 RecoveryVariantNeeded bool `blueprint:"mutated"`
Ivan Lozanoe6d30982021-02-05 10:57:43 -050087 ExtraVariants []string `blueprint:"mutated"`
88
Ivan Lozanoa2268632021-07-22 10:52:06 -040089 // Allows this module to use non-APEX version of libraries. Useful
90 // for building binaries that are started before APEXes are activated.
91 Bootstrap *bool
92
Ivan Lozano1921e802021-05-20 13:39:16 -040093 // Used by vendor snapshot to record dependencies from snapshot modules.
94 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +090095 SnapshotStaticLibs []string `blueprint:"mutated"`
Ivan Lozanoadd122a2023-07-13 11:01:41 -040096 SnapshotRlibs []string `blueprint:"mutated"`
97 SnapshotDylibs []string `blueprint:"mutated"`
Ivan Lozano1921e802021-05-20 13:39:16 -040098
Matthew Maurerc6868382021-07-13 14:12:37 -070099 // Make this module available when building for ramdisk.
100 // On device without a dedicated recovery partition, the module is only
101 // available after switching root into
102 // /first_stage_ramdisk. To expose the module before switching root, install
103 // the recovery variant instead.
104 Ramdisk_available *bool
105
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500106 // Make this module available when building for vendor ramdisk.
107 // On device without a dedicated recovery partition, the module is only
108 // available after switching root into
109 // /first_stage_ramdisk. To expose the module before switching root, install
Matthew Maurer460ee942021-02-11 12:31:46 -0800110 // the recovery variant instead
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500111 Vendor_ramdisk_available *bool
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400112
Ivan Lozano1921e802021-05-20 13:39:16 -0400113 // Normally Soong uses the directory structure to decide which modules
114 // should be included (framework) or excluded (non-framework) from the
115 // different snapshots (vendor, recovery, etc.), but this property
116 // allows a partner to exclude a module normally thought of as a
117 // framework module from the vendor snapshot.
118 Exclude_from_vendor_snapshot *bool
119
120 // Normally Soong uses the directory structure to decide which modules
121 // should be included (framework) or excluded (non-framework) from the
122 // different snapshots (vendor, recovery, etc.), but this property
123 // allows a partner to exclude a module normally thought of as a
124 // framework module from the recovery snapshot.
125 Exclude_from_recovery_snapshot *bool
126
Matthew Maurer460ee942021-02-11 12:31:46 -0800127 // Make this module available when building for recovery
128 Recovery_available *bool
129
Ivan Lozano3e9f9e42020-12-04 15:05:43 -0500130 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
131 Min_sdk_version *string
132
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900133 HideFromMake bool `blueprint:"mutated"`
134 PreventInstall bool `blueprint:"mutated"`
135
136 Installable *bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700137}
138
139type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700140 fuzz.FuzzModule
Ivan Lozanoffee3342019-08-27 12:03:00 -0700141
Ivan Lozano6a884432020-12-02 09:15:16 -0500142 VendorProperties cc.VendorProperties
143
Ivan Lozanoffee3342019-08-27 12:03:00 -0700144 Properties BaseProperties
145
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000146 hod android.HostOrDeviceSupported
147 multilib android.Multilib
148 testModule bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700149
Ivan Lozano6a884432020-12-02 09:15:16 -0500150 makeLinkType string
151
Yi Kong46c6e592022-01-20 22:55:00 +0800152 afdo *afdo
Ivan Lozanoffee3342019-08-27 12:03:00 -0700153 compiler compiler
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400154 coverage *coverage
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200155 clippy *clippy
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500156 sanitize *sanitize
Ivan Lozanoffee3342019-08-27 12:03:00 -0700157 cachedToolchain config.Toolchain
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400158 sourceProvider SourceProvider
Andrei Homescuc7767922020-08-05 06:36:19 -0700159 subAndroidMkOnce map[SubAndroidMkProvider]bool
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400160
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400161 // Output file to be installed, may be stripped or unstripped.
162 outputFile android.OptionalPath
163
Sasha Smundaka76acba2022-04-18 20:12:56 -0700164 // Cross-reference input file
165 kytheFiles android.Paths
166
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400167 docTimestampFile android.OptionalPath
Jiyong Park99644e92020-11-17 22:21:02 +0900168
169 hideApexVariantFromMake bool
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500170
171 // For apex variants, this is set as apex.min_sdk_version
172 apexSdkVersion android.ApiLevel
Cole Faustb6e6f992023-08-17 17:42:26 -0700173
174 transitiveAndroidMkSharedLibs *android.DepSet[string]
Vinh Tranbcb5f572023-08-24 11:10:01 -0400175
LaMont Jones0c971852023-12-07 21:56:59 +0000176 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
177 mergedAconfigFiles map[string]android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -0700178}
179
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500180func (mod *Module) Header() bool {
181 //TODO: If Rust libraries provide header variants, this needs to be updated.
182 return false
183}
184
185func (mod *Module) SetPreventInstall() {
186 mod.Properties.PreventInstall = true
187}
188
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500189func (mod *Module) SetHideFromMake() {
190 mod.Properties.HideFromMake = true
191}
192
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900193func (mod *Module) HiddenFromMake() bool {
194 return mod.Properties.HideFromMake
Ivan Lozanod7586b62021-04-01 09:49:36 -0400195}
196
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500197func (mod *Module) SanitizePropDefined() bool {
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500198 // Because compiler is not set for some Rust modules where sanitize might be set, check that compiler is also not
199 // nil since we need compiler to actually sanitize.
200 return mod.sanitize != nil && mod.compiler != nil
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500201}
202
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500203func (mod *Module) IsPrebuilt() bool {
204 if _, ok := mod.compiler.(*prebuiltLibraryDecorator); ok {
205 return true
206 }
207 return false
208}
209
Ivan Lozano43845682020-07-09 21:03:28 -0400210func (mod *Module) OutputFiles(tag string) (android.Paths, error) {
211 switch tag {
212 case "":
Andrei Homescu5db69cc2020-08-06 15:27:45 -0700213 if mod.sourceProvider != nil && (mod.compiler == nil || mod.compiler.Disabled()) {
Ivan Lozano43845682020-07-09 21:03:28 -0400214 return mod.sourceProvider.Srcs(), nil
215 } else {
Jiyong Parke54f07e2021-04-07 15:08:04 +0900216 if mod.OutputFile().Valid() {
217 return android.Paths{mod.OutputFile().Path()}, nil
Ivan Lozano43845682020-07-09 21:03:28 -0400218 }
219 return android.Paths{}, nil
220 }
Ivan Lozano0f9963e2023-02-06 13:31:02 -0500221 case "unstripped":
222 if mod.compiler != nil {
223 return android.PathsIfNonNil(mod.compiler.unstrippedOutputFilePath()), nil
224 }
225 return nil, nil
Ivan Lozano43845682020-07-09 21:03:28 -0400226 default:
227 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
228 }
229}
230
Ivan Lozano52767be2019-10-18 14:49:46 -0700231func (mod *Module) SelectedStl() string {
232 return ""
233}
234
Ivan Lozano2b262972019-11-21 12:30:50 -0800235func (mod *Module) NonCcVariants() bool {
236 if mod.compiler != nil {
Ivan Lozano89435d12020-07-31 11:01:18 -0400237 if _, ok := mod.compiler.(libraryInterface); ok {
238 return false
Ivan Lozano2b262972019-11-21 12:30:50 -0800239 }
240 }
241 panic(fmt.Errorf("NonCcVariants called on non-library module: %q", mod.BaseModuleName()))
242}
243
Ivan Lozano52767be2019-10-18 14:49:46 -0700244func (mod *Module) Static() bool {
245 if mod.compiler != nil {
246 if library, ok := mod.compiler.(libraryInterface); ok {
247 return library.static()
248 }
249 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400250 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700251}
252
253func (mod *Module) Shared() bool {
254 if mod.compiler != nil {
255 if library, ok := mod.compiler.(libraryInterface); ok {
Ivan Lozano89435d12020-07-31 11:01:18 -0400256 return library.shared()
Ivan Lozano52767be2019-10-18 14:49:46 -0700257 }
258 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400259 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700260}
261
Ivan Lozanod7586b62021-04-01 09:49:36 -0400262func (mod *Module) Dylib() bool {
263 if mod.compiler != nil {
264 if library, ok := mod.compiler.(libraryInterface); ok {
265 return library.dylib()
266 }
267 }
268 return false
269}
270
Ivan Lozanod106efe2023-09-21 23:30:26 -0400271func (mod *Module) Source() bool {
272 if mod.compiler != nil {
273 if library, ok := mod.compiler.(libraryInterface); ok && mod.sourceProvider != nil {
274 return library.source()
275 }
276 }
277 return false
278}
279
Ivan Lozanoadd122a2023-07-13 11:01:41 -0400280func (mod *Module) RlibStd() bool {
281 if mod.compiler != nil {
282 if library, ok := mod.compiler.(libraryInterface); ok && library.rlib() {
283 return library.rlibStd()
284 }
285 }
286 panic(fmt.Errorf("RlibStd() called on non-rlib module: %q", mod.BaseModuleName()))
287}
288
Ivan Lozanod7586b62021-04-01 09:49:36 -0400289func (mod *Module) Rlib() bool {
290 if mod.compiler != nil {
291 if library, ok := mod.compiler.(libraryInterface); ok {
292 return library.rlib()
293 }
294 }
295 return false
296}
297
298func (mod *Module) Binary() bool {
Ivan Lozano21fa0a52021-11-01 09:19:45 -0400299 if binary, ok := mod.compiler.(binaryInterface); ok {
300 return binary.binary()
Ivan Lozanod7586b62021-04-01 09:49:36 -0400301 }
302 return false
303}
304
Justin Yun5e035862021-06-29 20:50:37 +0900305func (mod *Module) StaticExecutable() bool {
306 if !mod.Binary() {
307 return false
308 }
Ivan Lozano21fa0a52021-11-01 09:19:45 -0400309 return mod.StaticallyLinked()
Justin Yun5e035862021-06-29 20:50:37 +0900310}
311
Ivan Lozanod7586b62021-04-01 09:49:36 -0400312func (mod *Module) Object() bool {
313 // Rust has no modules which produce only object files.
314 return false
315}
316
Ivan Lozano52767be2019-10-18 14:49:46 -0700317func (mod *Module) Toc() android.OptionalPath {
318 if mod.compiler != nil {
Ivan Lozano7b0781d2021-11-03 15:30:18 -0400319 if lib, ok := mod.compiler.(libraryInterface); ok {
320 return lib.toc()
Ivan Lozano52767be2019-10-18 14:49:46 -0700321 }
322 }
323 panic(fmt.Errorf("Toc() called on non-library module: %q", mod.BaseModuleName()))
324}
325
Colin Crossc511bc52020-04-07 16:50:32 +0000326func (mod *Module) UseSdk() bool {
327 return false
328}
329
Ivan Lozanod7586b62021-04-01 09:49:36 -0400330func (mod *Module) RelativeInstallPath() string {
331 if mod.compiler != nil {
332 return mod.compiler.relativeInstallPath()
333 }
334 return ""
335}
336
Ivan Lozano52767be2019-10-18 14:49:46 -0700337func (mod *Module) UseVndk() bool {
Ivan Lozano6a884432020-12-02 09:15:16 -0500338 return mod.Properties.VndkVersion != ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700339}
340
Jiyong Park7d55b612021-06-11 17:22:09 +0900341func (mod *Module) Bootstrap() bool {
Ivan Lozanoa2268632021-07-22 10:52:06 -0400342 return Bool(mod.Properties.Bootstrap)
Jiyong Park7d55b612021-06-11 17:22:09 +0900343}
344
Ivan Lozano52767be2019-10-18 14:49:46 -0700345func (mod *Module) MustUseVendorVariant() bool {
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400346 return true
347}
348
349func (mod *Module) SubName() string {
350 return mod.Properties.SubName
Ivan Lozano52767be2019-10-18 14:49:46 -0700351}
352
353func (mod *Module) IsVndk() bool {
Ivan Lozano6a884432020-12-02 09:15:16 -0500354 // TODO(b/165791368)
Ivan Lozano52767be2019-10-18 14:49:46 -0700355 return false
356}
357
Ivan Lozanof9e21722020-12-02 09:00:51 -0500358func (mod *Module) IsVndkExt() bool {
359 return false
360}
361
Ivan Lozanod7586b62021-04-01 09:49:36 -0400362func (mod *Module) IsVndkSp() bool {
363 return false
364}
365
Ivan Lozanof1868af2022-04-12 13:08:36 -0400366func (mod *Module) IsVndkPrebuiltLibrary() bool {
367 // Rust modules do not provide VNDK prebuilts
368 return false
369}
370
371func (mod *Module) IsVendorPublicLibrary() bool {
372 return mod.VendorProperties.IsVendorPublicLibrary
373}
374
375func (mod *Module) SdkAndPlatformVariantVisibleToMake() bool {
376 // Rust modules to not provide Sdk variants
377 return false
378}
379
Colin Cross127bb8b2020-12-16 16:46:01 -0800380func (c *Module) IsVndkPrivate() bool {
381 return false
382}
383
384func (c *Module) IsLlndk() bool {
385 return false
386}
387
388func (c *Module) IsLlndkPublic() bool {
Ivan Lozanof9e21722020-12-02 09:00:51 -0500389 return false
390}
391
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400392func (mod *Module) KernelHeadersDecorator() bool {
393 return false
394}
395
Colin Cross1f3f1302021-04-26 18:37:44 -0700396func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400397 return false
398}
399
Colin Cross5271fea2021-04-27 13:06:04 -0700400func (m *Module) NeedsVendorPublicLibraryVariants() bool {
401 return false
402}
403
Ivan Lozanod7586b62021-04-01 09:49:36 -0400404func (mod *Module) HasLlndkStubs() bool {
405 return false
406}
407
408func (mod *Module) StubsVersion() string {
409 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", mod.BaseModuleName()))
410}
411
Ivan Lozano52767be2019-10-18 14:49:46 -0700412func (mod *Module) SdkVersion() string {
413 return ""
414}
415
Colin Crossc511bc52020-04-07 16:50:32 +0000416func (mod *Module) AlwaysSdk() bool {
417 return false
418}
419
Jiyong Park2286afd2020-06-16 21:58:53 +0900420func (mod *Module) IsSdkVariant() bool {
421 return false
422}
423
Colin Cross1348ce32020-10-01 13:37:16 -0700424func (mod *Module) SplitPerApiLevel() bool {
425 return false
426}
427
Sasha Smundaka76acba2022-04-18 20:12:56 -0700428func (mod *Module) XrefRustFiles() android.Paths {
429 return mod.kytheFiles
430}
431
Ivan Lozanoffee3342019-08-27 12:03:00 -0700432type Deps struct {
Ivan Lozano63bb7682021-03-23 15:53:44 -0400433 Dylibs []string
434 Rlibs []string
435 Rustlibs []string
436 Stdlibs []string
437 ProcMacros []string
438 SharedLibs []string
439 StaticLibs []string
440 WholeStaticLibs []string
441 HeaderLibs []string
Ivan Lozanoffee3342019-08-27 12:03:00 -0700442
Ivan Lozano4e5f07d2021-11-04 14:09:38 -0400443 // Used for data dependencies adjacent to tests
444 DataLibs []string
445 DataBins []string
446
Colin Crossfe605e12022-01-23 20:46:16 -0800447 CrtBegin, CrtEnd []string
Ivan Lozanoffee3342019-08-27 12:03:00 -0700448}
449
450type PathDeps struct {
Colin Cross004bd3f2023-10-02 11:39:17 -0700451 DyLibs RustLibraries
452 RLibs RustLibraries
453 SharedLibs android.Paths
454 SharedLibDeps android.Paths
455 StaticLibs android.Paths
456 ProcMacros RustLibraries
457 AfdoProfiles android.Paths
Ivan Lozano3dfa12d2021-02-04 11:29:41 -0500458
459 // depFlags and depLinkFlags are rustc and linker (clang) flags.
460 depFlags []string
461 depLinkFlags []string
462
463 // linkDirs are link paths passed via -L to rustc. linkObjects are objects passed directly to the linker.
464 // Both of these are exported and propagate to dependencies.
Wen-yi Chu41326c12023-09-22 03:58:59 +0000465 linkDirs []string
Colin Cross004bd3f2023-10-02 11:39:17 -0700466 linkObjects []string
Ivan Lozanof1c84332019-09-20 11:00:37 -0700467
Ivan Lozano45901ed2020-07-24 16:05:01 -0400468 // Used by bindgen modules which call clang
469 depClangFlags []string
470 depIncludePaths android.Paths
Ivan Lozanoddd0bdb2020-08-28 17:00:26 -0400471 depGeneratedHeaders android.Paths
Ivan Lozano45901ed2020-07-24 16:05:01 -0400472 depSystemIncludePaths android.Paths
473
Colin Crossfe605e12022-01-23 20:46:16 -0800474 CrtBegin android.Paths
475 CrtEnd android.Paths
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700476
477 // Paths to generated source files
Ivan Lozano9d74a522020-12-01 09:25:22 -0500478 SrcDeps android.Paths
479 srcProviderFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -0700480}
481
482type RustLibraries []RustLibrary
483
484type RustLibrary struct {
485 Path android.Path
486 CrateName string
487}
488
Matthew Maurerbb3add12020-06-25 09:34:12 -0700489type exportedFlagsProducer interface {
Wen-yi Chu41326c12023-09-22 03:58:59 +0000490 exportLinkDirs(...string)
Colin Cross004bd3f2023-10-02 11:39:17 -0700491 exportLinkObjects(...string)
Matthew Maurerbb3add12020-06-25 09:34:12 -0700492}
493
Sasha Smundaka76acba2022-04-18 20:12:56 -0700494type xref interface {
495 XrefRustFiles() android.Paths
496}
497
Matthew Maurerbb3add12020-06-25 09:34:12 -0700498type flagExporter struct {
Wen-yi Chu41326c12023-09-22 03:58:59 +0000499 linkDirs []string
Colin Cross004bd3f2023-10-02 11:39:17 -0700500 linkObjects []string
Matthew Maurerbb3add12020-06-25 09:34:12 -0700501}
502
Wen-yi Chu41326c12023-09-22 03:58:59 +0000503func (flagExporter *flagExporter) exportLinkDirs(dirs ...string) {
504 flagExporter.linkDirs = android.FirstUniqueStrings(append(flagExporter.linkDirs, dirs...))
Matthew Maurerbb3add12020-06-25 09:34:12 -0700505}
506
Colin Cross004bd3f2023-10-02 11:39:17 -0700507func (flagExporter *flagExporter) exportLinkObjects(flags ...string) {
508 flagExporter.linkObjects = android.FirstUniqueStrings(append(flagExporter.linkObjects, flags...))
Ivan Lozano2093af22020-08-25 12:48:19 -0400509}
510
Colin Cross0de8a1e2020-09-18 14:15:30 -0700511func (flagExporter *flagExporter) setProvider(ctx ModuleContext) {
Colin Cross40213022023-12-13 15:19:49 -0800512 android.SetProvider(ctx, FlagExporterInfoProvider, FlagExporterInfo{
Colin Cross0de8a1e2020-09-18 14:15:30 -0700513 LinkDirs: flagExporter.linkDirs,
514 LinkObjects: flagExporter.linkObjects,
515 })
516}
517
Matthew Maurerbb3add12020-06-25 09:34:12 -0700518var _ exportedFlagsProducer = (*flagExporter)(nil)
519
520func NewFlagExporter() *flagExporter {
Colin Cross0de8a1e2020-09-18 14:15:30 -0700521 return &flagExporter{}
Matthew Maurerbb3add12020-06-25 09:34:12 -0700522}
523
Colin Cross0de8a1e2020-09-18 14:15:30 -0700524type FlagExporterInfo struct {
525 Flags []string
Wen-yi Chu41326c12023-09-22 03:58:59 +0000526 LinkDirs []string // TODO: this should be android.Paths
Colin Cross004bd3f2023-10-02 11:39:17 -0700527 LinkObjects []string // TODO: this should be android.Paths
Colin Cross0de8a1e2020-09-18 14:15:30 -0700528}
529
Colin Crossbc7d76c2023-12-12 16:39:03 -0800530var FlagExporterInfoProvider = blueprint.NewProvider[FlagExporterInfo]()
Colin Cross0de8a1e2020-09-18 14:15:30 -0700531
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400532func (mod *Module) isCoverageVariant() bool {
533 return mod.coverage.Properties.IsCoverageVariant
534}
535
536var _ cc.Coverage = (*Module)(nil)
537
Colin Crossf5f4ad32024-01-19 15:41:48 -0800538func (mod *Module) IsNativeCoverageNeeded(ctx android.IncomingTransitionContext) bool {
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400539 return mod.coverage != nil && mod.coverage.Properties.NeedCoverageVariant
540}
541
Ivan Lozanod7586b62021-04-01 09:49:36 -0400542func (mod *Module) VndkVersion() string {
543 return mod.Properties.VndkVersion
544}
545
546func (mod *Module) PreventInstall() bool {
547 return mod.Properties.PreventInstall
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400548}
549
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400550func (mod *Module) MarkAsCoverageVariant(coverage bool) {
551 mod.coverage.Properties.IsCoverageVariant = coverage
552}
553
554func (mod *Module) EnableCoverageIfNeeded() {
555 mod.coverage.Properties.CoverageEnabled = mod.coverage.Properties.NeedCoverageBuild
Ivan Lozanoffee3342019-08-27 12:03:00 -0700556}
557
558func defaultsFactory() android.Module {
559 return DefaultsFactory()
560}
561
562type Defaults struct {
563 android.ModuleBase
564 android.DefaultsModuleBase
565}
566
567func DefaultsFactory(props ...interface{}) android.Module {
568 module := &Defaults{}
569
570 module.AddProperties(props...)
571 module.AddProperties(
572 &BaseProperties{},
Yi Kong46c6e592022-01-20 22:55:00 +0800573 &cc.AfdoProperties{},
Ivan Lozano6a884432020-12-02 09:15:16 -0500574 &cc.VendorProperties{},
Jakub Kotur1d640d02021-01-06 12:40:43 +0100575 &BenchmarkProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400576 &BindgenProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700577 &BaseCompilerProperties{},
578 &BinaryCompilerProperties{},
579 &LibraryCompilerProperties{},
580 &ProcMacroCompilerProperties{},
581 &PrebuiltProperties{},
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400582 &SourceProviderProperties{},
Chih-Hung Hsieh41805be2019-10-31 20:56:47 -0700583 &TestProperties{},
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400584 &cc.CoverageProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400585 &cc.RustBindgenClangProperties{},
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200586 &ClippyProperties{},
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500587 &SanitizeProperties{},
Pawan Waghccb75582023-08-16 23:58:25 +0000588 &fuzz.FuzzProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700589 )
590
591 android.InitDefaultsModule(module)
592 return module
593}
594
595func (mod *Module) CrateName() string {
Ivan Lozanoad8b18b2019-10-31 19:38:29 -0700596 return mod.compiler.crateName()
Ivan Lozanoffee3342019-08-27 12:03:00 -0700597}
598
Ivan Lozano183a3212019-10-18 14:18:45 -0700599func (mod *Module) CcLibrary() bool {
600 if mod.compiler != nil {
Ivan Lozano45e0e5b2021-11-13 07:42:36 -0500601 if _, ok := mod.compiler.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700602 return true
603 }
604 }
605 return false
606}
607
608func (mod *Module) CcLibraryInterface() bool {
609 if mod.compiler != nil {
Ivan Lozano89435d12020-07-31 11:01:18 -0400610 // use build{Static,Shared}() instead of {static,shared}() here because this might be called before
611 // VariantIs{Static,Shared} is set.
612 if lib, ok := mod.compiler.(libraryInterface); ok && (lib.buildShared() || lib.buildStatic()) {
Ivan Lozano183a3212019-10-18 14:18:45 -0700613 return true
614 }
615 }
616 return false
617}
618
Ivan Lozano61c02cc2023-06-09 14:06:44 -0400619func (mod *Module) RustLibraryInterface() bool {
620 if mod.compiler != nil {
621 if _, ok := mod.compiler.(libraryInterface); ok {
622 return true
623 }
624 }
625 return false
626}
627
Ivan Lozano0f9963e2023-02-06 13:31:02 -0500628func (mod *Module) IsFuzzModule() bool {
629 if _, ok := mod.compiler.(*fuzzDecorator); ok {
630 return true
631 }
632 return false
633}
634
635func (mod *Module) FuzzModuleStruct() fuzz.FuzzModule {
636 return mod.FuzzModule
637}
638
639func (mod *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
640 if fuzzer, ok := mod.compiler.(*fuzzDecorator); ok {
641 return fuzzer.fuzzPackagedModule
642 }
643 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", mod.BaseModuleName()))
644}
645
Hamzeh Zawawy38917492023-04-05 22:08:46 +0000646func (mod *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -0500647 if fuzzer, ok := mod.compiler.(*fuzzDecorator); ok {
648 return fuzzer.sharedLibraries
649 }
650 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", mod.BaseModuleName()))
651}
652
Ivan Lozano39b0bf02021-10-14 12:22:09 -0400653func (mod *Module) UnstrippedOutputFile() android.Path {
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400654 if mod.compiler != nil {
655 return mod.compiler.unstrippedOutputFilePath()
Ivan Lozano39b0bf02021-10-14 12:22:09 -0400656 }
657 return nil
658}
659
Ivan Lozanoe0833b12019-11-06 19:15:49 -0800660func (mod *Module) IncludeDirs() android.Paths {
Ivan Lozano183a3212019-10-18 14:18:45 -0700661 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700662 if library, ok := mod.compiler.(*libraryDecorator); ok {
Ivan Lozanoe0833b12019-11-06 19:15:49 -0800663 return library.includeDirs
Ivan Lozano183a3212019-10-18 14:18:45 -0700664 }
665 }
666 panic(fmt.Errorf("IncludeDirs called on non-library module: %q", mod.BaseModuleName()))
667}
668
669func (mod *Module) SetStatic() {
670 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700671 if library, ok := mod.compiler.(libraryInterface); ok {
672 library.setStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700673 return
674 }
675 }
676 panic(fmt.Errorf("SetStatic called on non-library module: %q", mod.BaseModuleName()))
677}
678
679func (mod *Module) SetShared() {
680 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700681 if library, ok := mod.compiler.(libraryInterface); ok {
682 library.setShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700683 return
684 }
685 }
686 panic(fmt.Errorf("SetShared called on non-library module: %q", mod.BaseModuleName()))
687}
688
Ivan Lozano183a3212019-10-18 14:18:45 -0700689func (mod *Module) BuildStaticVariant() bool {
690 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700691 if library, ok := mod.compiler.(libraryInterface); ok {
692 return library.buildStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700693 }
694 }
695 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", mod.BaseModuleName()))
696}
697
698func (mod *Module) BuildSharedVariant() bool {
699 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700700 if library, ok := mod.compiler.(libraryInterface); ok {
701 return library.buildShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700702 }
703 }
704 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", mod.BaseModuleName()))
705}
706
Ivan Lozano183a3212019-10-18 14:18:45 -0700707func (mod *Module) Module() android.Module {
708 return mod
709}
710
Ivan Lozano183a3212019-10-18 14:18:45 -0700711func (mod *Module) OutputFile() android.OptionalPath {
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400712 return mod.outputFile
Ivan Lozano183a3212019-10-18 14:18:45 -0700713}
714
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400715func (mod *Module) CoverageFiles() android.Paths {
716 if mod.compiler != nil {
Joel Galensonfa049382021-01-14 16:03:18 -0800717 return android.Paths{}
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400718 }
719 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", mod.BaseModuleName()))
720}
721
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400722// Rust does not produce gcno files, and therefore does not produce a coverage archive.
723func (mod *Module) CoverageOutputFile() android.OptionalPath {
724 return android.OptionalPath{}
725}
726
727func (mod *Module) IsNdk(config android.Config) bool {
728 return false
729}
730
731func (mod *Module) IsStubs() bool {
732 return false
733}
734
Jiyong Park459feca2020-12-15 11:02:21 +0900735func (mod *Module) installable(apexInfo android.ApexInfo) bool {
Jiyong Park2811e072021-09-30 17:25:21 +0900736 if !proptools.BoolDefault(mod.Installable(), mod.EverInstallable()) {
Jiyong Parkbf8147a2021-05-17 13:19:33 +0900737 return false
738 }
739
Jiyong Park459feca2020-12-15 11:02:21 +0900740 // The apex variant is not installable because it is included in the APEX and won't appear
741 // in the system partition as a standalone file.
742 if !apexInfo.IsForPlatform() {
743 return false
744 }
745
Jiyong Parke54f07e2021-04-07 15:08:04 +0900746 return mod.OutputFile().Valid() && !mod.Properties.PreventInstall
Jiyong Park459feca2020-12-15 11:02:21 +0900747}
748
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500749func (ctx moduleContext) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -0800750 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
751 return apexInfo.ApexVariationName
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500752}
753
Ivan Lozano183a3212019-10-18 14:18:45 -0700754var _ cc.LinkableInterface = (*Module)(nil)
755
Ivan Lozanoffee3342019-08-27 12:03:00 -0700756func (mod *Module) Init() android.Module {
757 mod.AddProperties(&mod.Properties)
Ivan Lozano6a884432020-12-02 09:15:16 -0500758 mod.AddProperties(&mod.VendorProperties)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700759
Yi Kong46c6e592022-01-20 22:55:00 +0800760 if mod.afdo != nil {
761 mod.AddProperties(mod.afdo.props()...)
762 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700763 if mod.compiler != nil {
764 mod.AddProperties(mod.compiler.compilerProps()...)
765 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400766 if mod.coverage != nil {
767 mod.AddProperties(mod.coverage.props()...)
768 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200769 if mod.clippy != nil {
770 mod.AddProperties(mod.clippy.props()...)
771 }
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400772 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -0700773 mod.AddProperties(mod.sourceProvider.SourceProviderProps()...)
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400774 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500775 if mod.sanitize != nil {
776 mod.AddProperties(mod.sanitize.props()...)
777 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400778
Ivan Lozanoffee3342019-08-27 12:03:00 -0700779 android.InitAndroidArchModule(mod, mod.hod, mod.multilib)
Jiyong Park99644e92020-11-17 22:21:02 +0900780 android.InitApexModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700781
782 android.InitDefaultableModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700783 return mod
784}
785
786func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
787 return &Module{
788 hod: hod,
789 multilib: multilib,
790 }
791}
792func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
793 module := newBaseModule(hod, multilib)
Yi Kong46c6e592022-01-20 22:55:00 +0800794 module.afdo = &afdo{}
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400795 module.coverage = &coverage{}
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200796 module.clippy = &clippy{}
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500797 module.sanitize = &sanitize{}
Ivan Lozanoffee3342019-08-27 12:03:00 -0700798 return module
799}
800
801type ModuleContext interface {
802 android.ModuleContext
803 ModuleContextIntf
804}
805
806type BaseModuleContext interface {
807 android.BaseModuleContext
808 ModuleContextIntf
809}
810
811type DepsContext interface {
812 android.BottomUpMutatorContext
813 ModuleContextIntf
814}
815
816type ModuleContextIntf interface {
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200817 RustModule() *Module
Ivan Lozanoffee3342019-08-27 12:03:00 -0700818 toolchain() config.Toolchain
Ivan Lozanoffee3342019-08-27 12:03:00 -0700819}
820
821type depsContext struct {
822 android.BottomUpMutatorContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700823}
824
825type moduleContext struct {
826 android.ModuleContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700827}
828
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200829type baseModuleContext struct {
830 android.BaseModuleContext
831}
832
833func (ctx *moduleContext) RustModule() *Module {
834 return ctx.Module().(*Module)
835}
836
837func (ctx *moduleContext) toolchain() config.Toolchain {
838 return ctx.RustModule().toolchain(ctx)
839}
840
841func (ctx *depsContext) RustModule() *Module {
842 return ctx.Module().(*Module)
843}
844
845func (ctx *depsContext) toolchain() config.Toolchain {
846 return ctx.RustModule().toolchain(ctx)
847}
848
849func (ctx *baseModuleContext) RustModule() *Module {
850 return ctx.Module().(*Module)
851}
852
853func (ctx *baseModuleContext) toolchain() config.Toolchain {
854 return ctx.RustModule().toolchain(ctx)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400855}
856
857func (mod *Module) nativeCoverage() bool {
Matthew Maurera61e31f2021-05-27 11:09:11 -0700858 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
859 if mod.Target().NativeBridge == android.NativeBridgeEnabled {
860 return false
861 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400862 return mod.compiler != nil && mod.compiler.nativeCoverage()
863}
864
Ivan Lozanod7586b62021-04-01 09:49:36 -0400865func (mod *Module) EverInstallable() bool {
866 return mod.compiler != nil &&
867 // Check to see whether the module is actually ever installable.
868 mod.compiler.everInstallable()
869}
870
871func (mod *Module) Installable() *bool {
872 return mod.Properties.Installable
873}
874
Ivan Lozano872d5792022-03-23 17:31:39 -0400875func (mod *Module) ProcMacro() bool {
876 if pm, ok := mod.compiler.(procMacroInterface); ok {
877 return pm.ProcMacro()
878 }
879 return false
880}
881
Ivan Lozanoffee3342019-08-27 12:03:00 -0700882func (mod *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
883 if mod.cachedToolchain == nil {
884 mod.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
885 }
886 return mod.cachedToolchain
887}
888
Thiébaud Weksteen31f1bb82020-08-27 13:37:29 +0200889func (mod *Module) ccToolchain(ctx android.BaseModuleContext) cc_config.Toolchain {
890 return cc_config.FindToolchain(ctx.Os(), ctx.Arch())
891}
892
Ivan Lozanoffee3342019-08-27 12:03:00 -0700893func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
894}
895
896func (mod *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
897 ctx := &moduleContext{
898 ModuleContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -0700899 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700900
Colin Crossff694a82023-12-13 15:54:49 -0800901 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Jiyong Park99644e92020-11-17 22:21:02 +0900902 if !apexInfo.IsForPlatform() {
903 mod.hideApexVariantFromMake = true
904 }
905
Ivan Lozanoffee3342019-08-27 12:03:00 -0700906 toolchain := mod.toolchain(ctx)
Ivan Lozano6a884432020-12-02 09:15:16 -0500907 mod.makeLinkType = cc.GetMakeLinkType(actx, mod)
908
Ivan Lozanof1868af2022-04-12 13:08:36 -0400909 mod.Properties.SubName = cc.GetSubnameProperty(actx, mod)
Matthew Maurera61e31f2021-05-27 11:09:11 -0700910
Ivan Lozanoffee3342019-08-27 12:03:00 -0700911 if !toolchain.Supported() {
912 // This toolchain's unsupported, there's nothing to do for this mod.
913 return
914 }
915
916 deps := mod.depsToPaths(ctx)
917 flags := Flags{
918 Toolchain: toolchain,
919 }
920
Ivan Lozano67eada32021-09-23 11:50:33 -0400921 // Calculate rustc flags
Yi Kong46c6e592022-01-20 22:55:00 +0800922 if mod.afdo != nil {
Vinh Trancde10162023-03-09 22:07:19 -0500923 flags, deps = mod.afdo.flags(actx, flags, deps)
Yi Kong46c6e592022-01-20 22:55:00 +0800924 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700925 if mod.compiler != nil {
926 flags = mod.compiler.compilerFlags(ctx, flags)
Ivan Lozano67eada32021-09-23 11:50:33 -0400927 flags = mod.compiler.cfgFlags(ctx, flags)
928 flags = mod.compiler.featureFlags(ctx, flags)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400929 }
930 if mod.coverage != nil {
931 flags, deps = mod.coverage.flags(ctx, flags, deps)
932 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200933 if mod.clippy != nil {
934 flags, deps = mod.clippy.flags(ctx, flags, deps)
935 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500936 if mod.sanitize != nil {
937 flags, deps = mod.sanitize.flags(ctx, flags, deps)
938 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400939
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200940 // SourceProvider needs to call GenerateSource() before compiler calls
941 // compile() so it can provide the source. A SourceProvider has
942 // multiple variants (e.g. source, rlib, dylib). Only the "source"
943 // variant is responsible for effectively generating the source. The
944 // remaining variants relies on the "source" variant output.
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400945 if mod.sourceProvider != nil {
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200946 if mod.compiler.(libraryInterface).source() {
947 mod.sourceProvider.GenerateSource(ctx, deps)
948 mod.sourceProvider.setSubName(ctx.ModuleSubDir())
949 } else {
950 sourceMod := actx.GetDirectDepWithTag(mod.Name(), sourceDepTag)
951 sourceLib := sourceMod.(*Module).compiler.(*libraryDecorator)
Chih-Hung Hsiehc49649c2020-10-01 21:25:05 -0700952 mod.sourceProvider.setOutputFiles(sourceLib.sourceProvider.Srcs())
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200953 }
Colin Cross40213022023-12-13 15:19:49 -0800954 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: mod.sourceProvider.Srcs().Strings()})
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400955 }
956
957 if mod.compiler != nil && !mod.compiler.Disabled() {
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100958 mod.compiler.initialize(ctx)
Sasha Smundaka76acba2022-04-18 20:12:56 -0700959 buildOutput := mod.compiler.compile(ctx, flags, deps)
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400960 if ctx.Failed() {
961 return
962 }
Sasha Smundaka76acba2022-04-18 20:12:56 -0700963 mod.outputFile = android.OptionalPathForPath(buildOutput.outputFile)
964 if buildOutput.kytheFile != nil {
965 mod.kytheFiles = append(mod.kytheFiles, buildOutput.kytheFile)
966 }
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400967 bloaty.MeasureSizeForPaths(ctx, mod.compiler.strippedOutputFilePath(), android.OptionalPathForPath(mod.compiler.unstrippedOutputFilePath()))
Jiyong Park459feca2020-12-15 11:02:21 +0900968
Dan Albert06feee92021-03-19 15:06:02 -0700969 mod.docTimestampFile = mod.compiler.rustdoc(ctx, flags, deps)
Matthew Maurere3803632021-12-10 21:57:21 +0000970 if mod.docTimestampFile.Valid() {
971 ctx.CheckbuildFile(mod.docTimestampFile.Path())
972 }
Dan Albert06feee92021-03-19 15:06:02 -0700973
Colin Crossff694a82023-12-13 15:54:49 -0800974 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Ivan Lozano872d5792022-03-23 17:31:39 -0400975 if !proptools.BoolDefault(mod.Installable(), mod.EverInstallable()) && !mod.ProcMacro() {
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900976 // If the module has been specifically configure to not be installed then
977 // hide from make as otherwise it will break when running inside make as the
978 // output path to install will not be specified. Not all uninstallable
979 // modules can be hidden from make as some are needed for resolving make
Ivan Lozano872d5792022-03-23 17:31:39 -0400980 // side dependencies. In particular, proc-macros need to be captured in the
981 // host snapshot.
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900982 mod.HideFromMake()
983 } else if !mod.installable(apexInfo) {
984 mod.SkipInstall()
985 }
986
987 // Still call install though, the installs will be stored as PackageSpecs to allow
988 // using the outputs in a genrule.
989 if mod.OutputFile().Valid() {
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +0200990 mod.compiler.install(ctx)
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900991 if ctx.Failed() {
992 return
993 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400994 }
Chris Wailes74be7642021-07-22 16:20:28 -0700995
996 ctx.Phony("rust", ctx.RustModule().OutputFile().Path())
Ivan Lozanoffee3342019-08-27 12:03:00 -0700997 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000998 if mod.testModule {
Colin Cross40213022023-12-13 15:19:49 -0800999 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00001000 }
LaMont Jones0c971852023-12-07 21:56:59 +00001001
LaMont Jonesaa005ae2023-12-19 19:01:57 +00001002 android.CollectDependencyAconfigFiles(ctx, &mod.mergedAconfigFiles)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001003}
1004
1005func (mod *Module) deps(ctx DepsContext) Deps {
1006 deps := Deps{}
1007
1008 if mod.compiler != nil {
1009 deps = mod.compiler.compilerDeps(ctx, deps)
Ivan Lozano26ecd6c2020-07-31 13:40:31 -04001010 }
1011 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -07001012 deps = mod.sourceProvider.SourceProviderDeps(ctx, deps)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001013 }
1014
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001015 if mod.coverage != nil {
1016 deps = mod.coverage.deps(ctx, deps)
1017 }
1018
Ivan Lozano6cd99e62020-02-11 08:24:25 -05001019 if mod.sanitize != nil {
1020 deps = mod.sanitize.deps(ctx, deps)
1021 }
1022
Ivan Lozanoffee3342019-08-27 12:03:00 -07001023 deps.Rlibs = android.LastUniqueStrings(deps.Rlibs)
1024 deps.Dylibs = android.LastUniqueStrings(deps.Dylibs)
Matthew Maurer0f003b12020-06-29 14:34:06 -07001025 deps.Rustlibs = android.LastUniqueStrings(deps.Rustlibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001026 deps.ProcMacros = android.LastUniqueStrings(deps.ProcMacros)
1027 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1028 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
Andrew Walbran797e4be2022-03-07 15:41:53 +00001029 deps.Stdlibs = android.LastUniqueStrings(deps.Stdlibs)
Ivan Lozano63bb7682021-03-23 15:53:44 -04001030 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001031 return deps
1032
1033}
1034
Ivan Lozanoffee3342019-08-27 12:03:00 -07001035type dependencyTag struct {
1036 blueprint.BaseDependencyTag
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001037 name string
1038 library bool
1039 procMacro bool
Colin Cross65cb3142021-12-10 23:05:02 +00001040 dynamic bool
Ivan Lozanoffee3342019-08-27 12:03:00 -07001041}
1042
Jiyong Park65b62242020-11-25 12:44:59 +09001043// InstallDepNeeded returns true for rlibs, dylibs, and proc macros so that they or their transitive
1044// dependencies (especially C/C++ shared libs) are installed as dependencies of a rust binary.
1045func (d dependencyTag) InstallDepNeeded() bool {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001046 return d.library || d.procMacro
Jiyong Park65b62242020-11-25 12:44:59 +09001047}
1048
1049var _ android.InstallNeededDependencyTag = dependencyTag{}
1050
Colin Cross65cb3142021-12-10 23:05:02 +00001051func (d dependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
1052 if d.library && d.dynamic {
1053 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
1054 }
1055 return nil
1056}
1057
Yu Liuc8884602024-03-15 18:48:38 +00001058func (d dependencyTag) PropagateAconfigValidation() bool {
1059 return d == rlibDepTag || d == sourceDepTag
1060}
1061
1062var _ android.PropagateAconfigValidationDependencyTag = dependencyTag{}
1063
Colin Cross65cb3142021-12-10 23:05:02 +00001064var _ android.LicenseAnnotationsDependencyTag = dependencyTag{}
1065
Ivan Lozanoffee3342019-08-27 12:03:00 -07001066var (
Ivan Lozanoc564d2d2020-08-04 15:43:37 -04001067 customBindgenDepTag = dependencyTag{name: "customBindgenTag"}
1068 rlibDepTag = dependencyTag{name: "rlibTag", library: true}
Colin Cross65cb3142021-12-10 23:05:02 +00001069 dylibDepTag = dependencyTag{name: "dylib", library: true, dynamic: true}
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001070 procMacroDepTag = dependencyTag{name: "procMacro", procMacro: true}
Ivan Lozanoc564d2d2020-08-04 15:43:37 -04001071 testPerSrcDepTag = dependencyTag{name: "rust_unit_tests"}
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001072 sourceDepTag = dependencyTag{name: "source"}
Ivan Lozano4e5f07d2021-11-04 14:09:38 -04001073 dataLibDepTag = dependencyTag{name: "data lib"}
1074 dataBinDepTag = dependencyTag{name: "data bin"}
Ivan Lozanoffee3342019-08-27 12:03:00 -07001075)
1076
Jiyong Park99644e92020-11-17 22:21:02 +09001077func IsDylibDepTag(depTag blueprint.DependencyTag) bool {
1078 tag, ok := depTag.(dependencyTag)
1079 return ok && tag == dylibDepTag
1080}
1081
Jiyong Park94e22fd2021-04-08 18:19:15 +09001082func IsRlibDepTag(depTag blueprint.DependencyTag) bool {
1083 tag, ok := depTag.(dependencyTag)
1084 return ok && tag == rlibDepTag
1085}
1086
Matthew Maurer0f003b12020-06-29 14:34:06 -07001087type autoDep struct {
1088 variation string
1089 depTag dependencyTag
1090}
1091
1092var (
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001093 rlibVariation = "rlib"
1094 dylibVariation = "dylib"
1095 rlibAutoDep = autoDep{variation: rlibVariation, depTag: rlibDepTag}
1096 dylibAutoDep = autoDep{variation: dylibVariation, depTag: dylibDepTag}
Matthew Maurer0f003b12020-06-29 14:34:06 -07001097)
1098
1099type autoDeppable interface {
Liz Kammer356f7d42021-01-26 09:18:53 -05001100 autoDep(ctx android.BottomUpMutatorContext) autoDep
Matthew Maurer0f003b12020-06-29 14:34:06 -07001101}
1102
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001103func (mod *Module) begin(ctx BaseModuleContext) {
1104 if mod.coverage != nil {
1105 mod.coverage.begin(ctx)
1106 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -05001107 if mod.sanitize != nil {
1108 mod.sanitize.begin(ctx)
1109 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001110}
1111
Ivan Lozanofba2aa22021-11-11 09:29:07 -05001112func (mod *Module) Prebuilt() *android.Prebuilt {
Ivan Lozano872d5792022-03-23 17:31:39 -04001113 if p, ok := mod.compiler.(rustPrebuilt); ok {
Ivan Lozanofba2aa22021-11-11 09:29:07 -05001114 return p.prebuilt()
1115 }
1116 return nil
1117}
1118
Kiyoung Kim37693d02024-04-04 09:56:15 +09001119func (mod *Module) Symlinks() []string {
1120 // TODO update this to return the list of symlinks when Rust supports defining symlinks
1121 return nil
1122}
1123
Justin Yun24b246a2023-03-16 10:36:16 +09001124func rustMakeLibName(ctx android.ModuleContext, c cc.LinkableInterface, dep cc.LinkableInterface, depName string) string {
1125 if rustDep, ok := dep.(*Module); ok {
1126 // Use base module name for snapshots when exporting to Makefile.
1127 if snapshotPrebuilt, ok := rustDep.compiler.(cc.SnapshotInterface); ok {
1128 baseName := rustDep.BaseModuleName()
1129 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix() + rustDep.AndroidMkSuffix()
1130 }
1131 }
1132 return cc.MakeLibName(ctx, c, dep, depName)
1133}
1134
Ivan Lozanod106efe2023-09-21 23:30:26 -04001135func collectIncludedProtos(mod *Module, dep *Module) {
1136 if protoMod, ok := mod.sourceProvider.(*protobufDecorator); ok {
1137 if _, ok := dep.sourceProvider.(*protobufDecorator); ok {
1138 protoMod.additionalCrates = append(protoMod.additionalCrates, dep.CrateName())
1139 }
1140 }
1141}
Andrew Walbran52533232024-03-19 11:36:04 +00001142
Ivan Lozanoffee3342019-08-27 12:03:00 -07001143func (mod *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
1144 var depPaths PathDeps
1145
1146 directRlibDeps := []*Module{}
1147 directDylibDeps := []*Module{}
1148 directProcMacroDeps := []*Module{}
Jiyong Park7d55b612021-06-11 17:22:09 +09001149 directSharedLibDeps := []cc.SharedLibraryInfo{}
Ivan Lozano52767be2019-10-18 14:49:46 -07001150 directStaticLibDeps := [](cc.LinkableInterface){}
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001151 directSrcProvidersDeps := []*Module{}
1152 directSrcDeps := [](android.SourceFileProducer){}
Ivan Lozanoffee3342019-08-27 12:03:00 -07001153
Ivan Lozanoe950cda2021-11-09 11:26:04 -05001154 // For the dependency from platform to apex, use the latest stubs
1155 mod.apexSdkVersion = android.FutureApiLevel
Colin Crossff694a82023-12-13 15:54:49 -08001156 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Ivan Lozanoe950cda2021-11-09 11:26:04 -05001157 if !apexInfo.IsForPlatform() {
1158 mod.apexSdkVersion = apexInfo.MinSdkVersion
1159 }
1160
1161 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
1162 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
1163 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
1164 // (b/144430859)
1165 mod.apexSdkVersion = android.FutureApiLevel
1166 }
1167
Spandan Das604f3762023-03-16 22:51:40 +00001168 skipModuleList := map[string]bool{}
1169
1170 var apiImportInfo multitree.ApiImportInfo
1171 hasApiImportInfo := false
1172
1173 ctx.VisitDirectDeps(func(dep android.Module) {
1174 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08001175 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Spandan Das604f3762023-03-16 22:51:40 +00001176 hasApiImportInfo = true
1177 }
1178 })
1179
1180 if hasApiImportInfo {
1181 targetStubModuleList := map[string]string{}
1182 targetOrigModuleList := map[string]string{}
1183
1184 // Search for dependency which both original module and API imported library with APEX stub exists
1185 ctx.VisitDirectDeps(func(dep android.Module) {
1186 depName := ctx.OtherModuleName(dep)
1187 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
1188 targetStubModuleList[apiLibrary] = depName
1189 }
1190 })
1191 ctx.VisitDirectDeps(func(dep android.Module) {
1192 depName := ctx.OtherModuleName(dep)
1193 if origLibrary, ok := targetStubModuleList[depName]; ok {
1194 targetOrigModuleList[origLibrary] = depName
1195 }
1196 })
1197
1198 // Decide which library should be used between original and API imported library
1199 ctx.VisitDirectDeps(func(dep android.Module) {
1200 depName := ctx.OtherModuleName(dep)
1201 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
1202 if cc.ShouldUseStubForApex(ctx, dep) {
1203 skipModuleList[depName] = true
1204 } else {
1205 skipModuleList[apiLibrary] = true
1206 }
1207 }
1208 })
1209 }
1210
Cole Faustb6e6f992023-08-17 17:42:26 -07001211 var transitiveAndroidMkSharedLibs []*android.DepSet[string]
1212 var directAndroidMkSharedLibs []string
Wen-yi Chu41326c12023-09-22 03:58:59 +00001213
Ivan Lozanoffee3342019-08-27 12:03:00 -07001214 ctx.VisitDirectDeps(func(dep android.Module) {
1215 depName := ctx.OtherModuleName(dep)
1216 depTag := ctx.OtherModuleDependencyTag(dep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001217
Spandan Das604f3762023-03-16 22:51:40 +00001218 if _, exists := skipModuleList[depName]; exists {
1219 return
1220 }
A. Cody Schuffelenc183e3a2023-08-14 21:09:47 -07001221
1222 if depTag == android.DarwinUniversalVariantTag {
1223 return
1224 }
1225
Ivan Lozano89435d12020-07-31 11:01:18 -04001226 if rustDep, ok := dep.(*Module); ok && !rustDep.CcLibraryInterface() {
Ivan Lozanoffee3342019-08-27 12:03:00 -07001227 //Handle Rust Modules
Justin Yun24b246a2023-03-16 10:36:16 +09001228 makeLibName := rustMakeLibName(ctx, mod, rustDep, depName+rustDep.Properties.RustSubName)
Ivan Lozano70e0a072019-09-13 14:23:15 -07001229
Ivan Lozanoffee3342019-08-27 12:03:00 -07001230 switch depTag {
1231 case dylibDepTag:
1232 dylib, ok := rustDep.compiler.(libraryInterface)
1233 if !ok || !dylib.dylib() {
1234 ctx.ModuleErrorf("mod %q not an dylib library", depName)
1235 return
1236 }
1237 directDylibDeps = append(directDylibDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001238 mod.Properties.AndroidMkDylibs = append(mod.Properties.AndroidMkDylibs, makeLibName)
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001239 mod.Properties.SnapshotDylibs = append(mod.Properties.SnapshotDylibs, cc.BaseLibName(depName))
1240
Ivan Lozanoffee3342019-08-27 12:03:00 -07001241 case rlibDepTag:
Wen-yi Chu41326c12023-09-22 03:58:59 +00001242
Ivan Lozanoffee3342019-08-27 12:03:00 -07001243 rlib, ok := rustDep.compiler.(libraryInterface)
1244 if !ok || !rlib.rlib() {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001245 ctx.ModuleErrorf("mod %q not an rlib library", makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001246 return
1247 }
1248 directRlibDeps = append(directRlibDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001249 mod.Properties.AndroidMkRlibs = append(mod.Properties.AndroidMkRlibs, makeLibName)
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001250 mod.Properties.SnapshotRlibs = append(mod.Properties.SnapshotRlibs, cc.BaseLibName(depName))
1251
Ivan Lozanoffee3342019-08-27 12:03:00 -07001252 case procMacroDepTag:
1253 directProcMacroDeps = append(directProcMacroDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001254 mod.Properties.AndroidMkProcMacroLibs = append(mod.Properties.AndroidMkProcMacroLibs, makeLibName)
Ivan Lozanod106efe2023-09-21 23:30:26 -04001255
1256 case sourceDepTag:
1257 if _, ok := mod.sourceProvider.(*protobufDecorator); ok {
1258 collectIncludedProtos(mod, rustDep)
1259 }
Paul Duffind5cf92e2021-07-09 17:38:55 +01001260 }
1261
Cole Faustb6e6f992023-08-17 17:42:26 -07001262 transitiveAndroidMkSharedLibs = append(transitiveAndroidMkSharedLibs, rustDep.transitiveAndroidMkSharedLibs)
1263
Paul Duffind5cf92e2021-07-09 17:38:55 +01001264 if android.IsSourceDepTagWithOutputTag(depTag, "") {
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001265 // Since these deps are added in path_properties.go via AddDependencies, we need to ensure the correct
1266 // OS/Arch variant is used.
1267 var helper string
1268 if ctx.Host() {
1269 helper = "missing 'host_supported'?"
1270 } else {
1271 helper = "device module defined?"
1272 }
1273
1274 if dep.Target().Os != ctx.Os() {
1275 ctx.ModuleErrorf("OS mismatch on dependency %q (%s)", dep.Name(), helper)
1276 return
1277 } else if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
1278 ctx.ModuleErrorf("Arch mismatch on dependency %q (%s)", dep.Name(), helper)
1279 return
1280 }
1281 directSrcProvidersDeps = append(directSrcProvidersDeps, rustDep)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001282 }
1283
Ivan Lozano2bbcacf2020-08-07 09:00:50 -04001284 //Append the dependencies exportedDirs, except for proc-macros which target a different arch/OS
Colin Cross0de8a1e2020-09-18 14:15:30 -07001285 if depTag != procMacroDepTag {
Colin Cross313aa542023-12-13 13:47:44 -08001286 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001287 depPaths.linkDirs = append(depPaths.linkDirs, exportedInfo.LinkDirs...)
1288 depPaths.depFlags = append(depPaths.depFlags, exportedInfo.Flags...)
1289 depPaths.linkObjects = append(depPaths.linkObjects, exportedInfo.LinkObjects...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001290 }
1291
Ivan Lozanoffee3342019-08-27 12:03:00 -07001292 if depTag == dylibDepTag || depTag == rlibDepTag || depTag == procMacroDepTag {
Ivan Lozano8d10fc32021-11-05 16:36:47 -04001293 linkFile := rustDep.UnstrippedOutputFile()
Wen-yi Chu41326c12023-09-22 03:58:59 +00001294 linkDir := linkPathFromFilePath(linkFile)
Matthew Maurerbb3add12020-06-25 09:34:12 -07001295 if lib, ok := mod.compiler.(exportedFlagsProducer); ok {
Wen-yi Chu41326c12023-09-22 03:58:59 +00001296 lib.exportLinkDirs(linkDir)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001297 }
1298 }
Ivan Lozanod106efe2023-09-21 23:30:26 -04001299 if depTag == sourceDepTag {
1300 if _, ok := mod.sourceProvider.(*protobufDecorator); ok && mod.Source() {
1301 if _, ok := rustDep.sourceProvider.(*protobufDecorator); ok {
Colin Cross313aa542023-12-13 13:47:44 -08001302 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, cc.FlagExporterInfoProvider)
Ivan Lozanod106efe2023-09-21 23:30:26 -04001303 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1304 }
1305 }
1306 }
Ivan Lozano89435d12020-07-31 11:01:18 -04001307 } else if ccDep, ok := dep.(cc.LinkableInterface); ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07001308 //Handle C dependencies
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001309 makeLibName := cc.MakeLibName(ctx, mod, ccDep, depName)
Ivan Lozano52767be2019-10-18 14:49:46 -07001310 if _, ok := ccDep.(*Module); !ok {
1311 if ccDep.Module().Target().Os != ctx.Os() {
1312 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
1313 return
1314 }
1315 if ccDep.Module().Target().Arch.ArchType != ctx.Arch().ArchType {
1316 ctx.ModuleErrorf("Arch mismatch between %q and %q", ctx.ModuleName(), depName)
1317 return
1318 }
Ivan Lozano70e0a072019-09-13 14:23:15 -07001319 }
Ivan Lozano2093af22020-08-25 12:48:19 -04001320 linkObject := ccDep.OutputFile()
Ivan Lozano2093af22020-08-25 12:48:19 -04001321 if !linkObject.Valid() {
Colin Crossa86ea0e2023-08-01 09:57:22 -07001322 if !ctx.Config().AllowMissingDependencies() {
1323 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q", depName, ctx.ModuleName())
1324 } else {
1325 ctx.AddMissingDependencies([]string{depName})
1326 }
1327 return
Ivan Lozanoffee3342019-08-27 12:03:00 -07001328 }
1329
Wen-yi Chu41326c12023-09-22 03:58:59 +00001330 linkPath := linkPathFromFilePath(linkObject.Path())
Colin Crossa86ea0e2023-08-01 09:57:22 -07001331
Ivan Lozanoffee3342019-08-27 12:03:00 -07001332 exportDep := false
Colin Cross6e511a92020-07-27 21:26:48 -07001333 switch {
1334 case cc.IsStaticDepTag(depTag):
Ivan Lozano63bb7682021-03-23 15:53:44 -04001335 if cc.IsWholeStaticLib(depTag) {
1336 // rustc will bundle static libraries when they're passed with "-lstatic=<lib>". This will fail
1337 // if the library is not prefixed by "lib".
Ivan Lozanofdadcd72021-11-01 09:04:23 -04001338 if mod.Binary() {
1339 // Binaries may sometimes need to link whole static libraries that don't start with 'lib'.
1340 // Since binaries don't need to 'rebundle' these like libraries and only use these for the
1341 // final linkage, pass the args directly to the linker to handle these cases.
1342 depPaths.depLinkFlags = append(depPaths.depLinkFlags, []string{"-Wl,--whole-archive", linkObject.Path().String(), "-Wl,--no-whole-archive"}...)
1343 } else if libName, ok := libNameFromFilePath(linkObject.Path()); ok {
Ivan Lozanofb6f36f2021-02-05 12:27:08 -05001344 depPaths.depFlags = append(depPaths.depFlags, "-lstatic="+libName)
Ivan Lozano63bb7682021-03-23 15:53:44 -04001345 } else {
1346 ctx.ModuleErrorf("'%q' cannot be listed as a whole_static_library in Rust modules unless the output is prefixed by 'lib'", depName, ctx.ModuleName())
Ivan Lozanofb6f36f2021-02-05 12:27:08 -05001347 }
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001348 }
1349
1350 // Add this to linkObjects to pass the library directly to the linker as well. This propagates
1351 // to dependencies to avoid having to redeclare static libraries for dependents of the dylib variant.
Colin Cross004bd3f2023-10-02 11:39:17 -07001352 depPaths.linkObjects = append(depPaths.linkObjects, linkObject.String())
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001353 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
1354
Colin Cross313aa542023-12-13 13:47:44 -08001355 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, cc.FlagExporterInfoProvider)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001356 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1357 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1358 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1359 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001360 directStaticLibDeps = append(directStaticLibDeps, ccDep)
Justin Yun2b3ed642022-02-16 08:15:07 +09001361
1362 // Record baseLibName for snapshots.
1363 mod.Properties.SnapshotStaticLibs = append(mod.Properties.SnapshotStaticLibs, cc.BaseLibName(depName))
1364
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001365 mod.Properties.AndroidMkStaticLibs = append(mod.Properties.AndroidMkStaticLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07001366 case cc.IsSharedDepTag(depTag):
Jiyong Park7d55b612021-06-11 17:22:09 +09001367 // For the shared lib dependencies, we may link to the stub variant
1368 // of the dependency depending on the context (e.g. if this
1369 // dependency crosses the APEX boundaries).
1370 sharedLibraryInfo, exportedInfo := cc.ChooseStubOrImpl(ctx, dep)
1371
1372 // Re-get linkObject as ChooseStubOrImpl actually tells us which
1373 // object (either from stub or non-stub) to use.
1374 linkObject = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
Colin Crossa86ea0e2023-08-01 09:57:22 -07001375 if !linkObject.Valid() {
1376 if !ctx.Config().AllowMissingDependencies() {
1377 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q", depName, ctx.ModuleName())
1378 } else {
1379 ctx.AddMissingDependencies([]string{depName})
1380 }
1381 return
1382 }
Wen-yi Chu41326c12023-09-22 03:58:59 +00001383 linkPath = linkPathFromFilePath(linkObject.Path())
Jiyong Park7d55b612021-06-11 17:22:09 +09001384
Ivan Lozanoffee3342019-08-27 12:03:00 -07001385 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
Colin Cross004bd3f2023-10-02 11:39:17 -07001386 depPaths.linkObjects = append(depPaths.linkObjects, linkObject.String())
Colin Cross0de8a1e2020-09-18 14:15:30 -07001387 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1388 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1389 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1390 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Jiyong Park7d55b612021-06-11 17:22:09 +09001391 directSharedLibDeps = append(directSharedLibDeps, sharedLibraryInfo)
Ivan Lozano1921e802021-05-20 13:39:16 -04001392
1393 // Record baseLibName for snapshots.
1394 mod.Properties.SnapshotSharedLibs = append(mod.Properties.SnapshotSharedLibs, cc.BaseLibName(depName))
1395
Cole Faustb6e6f992023-08-17 17:42:26 -07001396 directAndroidMkSharedLibs = append(directAndroidMkSharedLibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001397 exportDep = true
Zach Johnson3df4e632020-11-06 11:56:27 -08001398 case cc.IsHeaderDepTag(depTag):
Colin Cross313aa542023-12-13 13:47:44 -08001399 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, cc.FlagExporterInfoProvider)
Zach Johnson3df4e632020-11-06 11:56:27 -08001400 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1401 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1402 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Ivan Lozano1dbfa142024-03-29 14:48:11 +00001403 mod.Properties.AndroidMkHeaderLibs = append(mod.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07001404 case depTag == cc.CrtBeginDepTag:
Colin Crossfe605e12022-01-23 20:46:16 -08001405 depPaths.CrtBegin = append(depPaths.CrtBegin, linkObject.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07001406 case depTag == cc.CrtEndDepTag:
Colin Crossfe605e12022-01-23 20:46:16 -08001407 depPaths.CrtEnd = append(depPaths.CrtEnd, linkObject.Path())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001408 }
1409
1410 // Make sure these dependencies are propagated
Matthew Maurerbb3add12020-06-25 09:34:12 -07001411 if lib, ok := mod.compiler.(exportedFlagsProducer); ok && exportDep {
1412 lib.exportLinkDirs(linkPath)
Colin Cross004bd3f2023-10-02 11:39:17 -07001413 lib.exportLinkObjects(linkObject.String())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001414 }
Colin Cross018cbeb2022-01-24 17:22:45 -08001415 } else {
1416 switch {
1417 case depTag == cc.CrtBeginDepTag:
1418 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
1419 case depTag == cc.CrtEndDepTag:
1420 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
1421 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001422 }
Ivan Lozano89435d12020-07-31 11:01:18 -04001423
1424 if srcDep, ok := dep.(android.SourceFileProducer); ok {
Paul Duffind5cf92e2021-07-09 17:38:55 +01001425 if android.IsSourceDepTagWithOutputTag(depTag, "") {
Ivan Lozano89435d12020-07-31 11:01:18 -04001426 // These are usually genrules which don't have per-target variants.
1427 directSrcDeps = append(directSrcDeps, srcDep)
1428 }
1429 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001430 })
1431
Wen-yi Chu41326c12023-09-22 03:58:59 +00001432 mod.transitiveAndroidMkSharedLibs = android.NewDepSet[string](android.PREORDER, directAndroidMkSharedLibs, transitiveAndroidMkSharedLibs)
1433
1434 var rlibDepFiles RustLibraries
Andrew Walbran52533232024-03-19 11:36:04 +00001435 aliases := mod.compiler.Aliases()
Wen-yi Chu41326c12023-09-22 03:58:59 +00001436 for _, dep := range directRlibDeps {
Andrew Walbran52533232024-03-19 11:36:04 +00001437 crateName := dep.CrateName()
1438 if alias, aliased := aliases[crateName]; aliased {
1439 crateName = alias
1440 }
1441 rlibDepFiles = append(rlibDepFiles, RustLibrary{Path: dep.UnstrippedOutputFile(), CrateName: crateName})
Wen-yi Chu41326c12023-09-22 03:58:59 +00001442 }
1443 var dylibDepFiles RustLibraries
1444 for _, dep := range directDylibDeps {
Andrew Walbran52533232024-03-19 11:36:04 +00001445 crateName := dep.CrateName()
1446 if alias, aliased := aliases[crateName]; aliased {
1447 crateName = alias
1448 }
1449 dylibDepFiles = append(dylibDepFiles, RustLibrary{Path: dep.UnstrippedOutputFile(), CrateName: crateName})
Wen-yi Chu41326c12023-09-22 03:58:59 +00001450 }
1451 var procMacroDepFiles RustLibraries
1452 for _, dep := range directProcMacroDeps {
Andrew Walbran52533232024-03-19 11:36:04 +00001453 crateName := dep.CrateName()
1454 if alias, aliased := aliases[crateName]; aliased {
1455 crateName = alias
1456 }
1457 procMacroDepFiles = append(procMacroDepFiles, RustLibrary{Path: dep.UnstrippedOutputFile(), CrateName: crateName})
Wen-yi Chu41326c12023-09-22 03:58:59 +00001458 }
1459
Colin Cross004bd3f2023-10-02 11:39:17 -07001460 var staticLibDepFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -07001461 for _, dep := range directStaticLibDeps {
Colin Cross004bd3f2023-10-02 11:39:17 -07001462 staticLibDepFiles = append(staticLibDepFiles, dep.OutputFile().Path())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001463 }
1464
Colin Cross004bd3f2023-10-02 11:39:17 -07001465 var sharedLibFiles android.Paths
1466 var sharedLibDepFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -07001467 for _, dep := range directSharedLibDeps {
Colin Cross004bd3f2023-10-02 11:39:17 -07001468 sharedLibFiles = append(sharedLibFiles, dep.SharedLibrary)
Jiyong Park7d55b612021-06-11 17:22:09 +09001469 if dep.TableOfContents.Valid() {
Colin Cross004bd3f2023-10-02 11:39:17 -07001470 sharedLibDepFiles = append(sharedLibDepFiles, dep.TableOfContents.Path())
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001471 } else {
Colin Cross004bd3f2023-10-02 11:39:17 -07001472 sharedLibDepFiles = append(sharedLibDepFiles, dep.SharedLibrary)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001473 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001474 }
1475
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001476 var srcProviderDepFiles android.Paths
1477 for _, dep := range directSrcProvidersDeps {
1478 srcs, _ := dep.OutputFiles("")
1479 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1480 }
1481 for _, dep := range directSrcDeps {
1482 srcs := dep.Srcs()
1483 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1484 }
1485
Wen-yi Chu41326c12023-09-22 03:58:59 +00001486 depPaths.RLibs = append(depPaths.RLibs, rlibDepFiles...)
1487 depPaths.DyLibs = append(depPaths.DyLibs, dylibDepFiles...)
Colin Cross004bd3f2023-10-02 11:39:17 -07001488 depPaths.SharedLibs = append(depPaths.SharedLibs, sharedLibFiles...)
1489 depPaths.SharedLibDeps = append(depPaths.SharedLibDeps, sharedLibDepFiles...)
1490 depPaths.StaticLibs = append(depPaths.StaticLibs, staticLibDepFiles...)
Wen-yi Chu41326c12023-09-22 03:58:59 +00001491 depPaths.ProcMacros = append(depPaths.ProcMacros, procMacroDepFiles...)
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001492 depPaths.SrcDeps = append(depPaths.SrcDeps, srcProviderDepFiles...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001493
1494 // Dedup exported flags from dependencies
Wen-yi Chu41326c12023-09-22 03:58:59 +00001495 depPaths.linkDirs = android.FirstUniqueStrings(depPaths.linkDirs)
Colin Cross004bd3f2023-10-02 11:39:17 -07001496 depPaths.linkObjects = android.FirstUniqueStrings(depPaths.linkObjects)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001497 depPaths.depFlags = android.FirstUniqueStrings(depPaths.depFlags)
Ivan Lozano45901ed2020-07-24 16:05:01 -04001498 depPaths.depClangFlags = android.FirstUniqueStrings(depPaths.depClangFlags)
1499 depPaths.depIncludePaths = android.FirstUniquePaths(depPaths.depIncludePaths)
1500 depPaths.depSystemIncludePaths = android.FirstUniquePaths(depPaths.depSystemIncludePaths)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001501
1502 return depPaths
1503}
1504
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -08001505func (mod *Module) InstallInData() bool {
1506 if mod.compiler == nil {
1507 return false
1508 }
1509 return mod.compiler.inData()
1510}
1511
Matthew Maurer9f59e8d2021-08-19 13:10:05 -07001512func (mod *Module) InstallInRamdisk() bool {
1513 return mod.InRamdisk()
1514}
1515
1516func (mod *Module) InstallInVendorRamdisk() bool {
1517 return mod.InVendorRamdisk()
1518}
1519
1520func (mod *Module) InstallInRecovery() bool {
1521 return mod.InRecovery()
1522}
1523
Wen-yi Chu41326c12023-09-22 03:58:59 +00001524func linkPathFromFilePath(filepath android.Path) string {
1525 return strings.Split(filepath.String(), filepath.Base())[0]
1526}
1527
Spandan Das604f3762023-03-16 22:51:40 +00001528// usePublicApi returns true if the rust variant should link against NDK (publicapi)
1529func (r *Module) usePublicApi() bool {
1530 return r.Device() && r.UseSdk()
1531}
1532
1533// useVendorApi returns true if the rust variant should link against LLNDK (vendorapi)
1534func (r *Module) useVendorApi() bool {
1535 return r.Device() && (r.InVendor() || r.InProduct())
1536}
1537
Ivan Lozanoffee3342019-08-27 12:03:00 -07001538func (mod *Module) DepsMutator(actx android.BottomUpMutatorContext) {
1539 ctx := &depsContext{
1540 BottomUpMutatorContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -07001541 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001542
1543 deps := mod.deps(ctx)
Colin Cross3146c5c2020-09-30 15:34:40 -07001544 var commonDepVariations []blueprint.Variation
Ivan Lozano1921e802021-05-20 13:39:16 -04001545
Kiyoung Kim487689e2022-07-26 09:48:22 +09001546 apiImportInfo := cc.GetApiImports(mod, actx)
Spandan Das604f3762023-03-16 22:51:40 +00001547 if mod.usePublicApi() || mod.useVendorApi() {
1548 for idx, lib := range deps.SharedLibs {
1549 deps.SharedLibs[idx] = cc.GetReplaceModuleName(lib, apiImportInfo.SharedLibs)
1550 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09001551 }
1552
Ivan Lozano1921e802021-05-20 13:39:16 -04001553 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001554 deps.SharedLibs, _ = cc.FilterNdkLibs(mod, ctx.Config(), deps.SharedLibs)
Ivan Lozano1921e802021-05-20 13:39:16 -04001555 }
Ivan Lozanodd055472020-09-28 13:22:45 -04001556
Ivan Lozano2b081132020-09-08 12:46:52 -04001557 stdLinkage := "dylib-std"
Ivan Lozanodd055472020-09-28 13:22:45 -04001558 if mod.compiler.stdLinkage(ctx) == RlibLinkage {
Ivan Lozano2b081132020-09-08 12:46:52 -04001559 stdLinkage = "rlib-std"
1560 }
1561
1562 rlibDepVariations := commonDepVariations
Ivan Lozano1921e802021-05-20 13:39:16 -04001563
Ivan Lozano2b081132020-09-08 12:46:52 -04001564 if lib, ok := mod.compiler.(libraryInterface); !ok || !lib.sysroot() {
1565 rlibDepVariations = append(rlibDepVariations,
1566 blueprint.Variation{Mutator: "rust_stdlinkage", Variation: stdLinkage})
1567 }
1568
Ivan Lozano1921e802021-05-20 13:39:16 -04001569 // rlibs
Ivan Lozano2d407632022-04-07 12:59:11 -04001570 rlibDepVariations = append(rlibDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: rlibVariation})
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001571 for _, lib := range deps.Rlibs {
1572 depTag := rlibDepTag
Ivan Lozano2d407632022-04-07 12:59:11 -04001573 actx.AddVariationDependencies(rlibDepVariations, depTag, lib)
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001574 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001575
1576 // dylibs
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001577 dylibDepVariations := append(commonDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: dylibVariation})
1578 for _, lib := range deps.Dylibs {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001579 actx.AddVariationDependencies(dylibDepVariations, dylibDepTag, lib)
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001580 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001581
Ivan Lozano1921e802021-05-20 13:39:16 -04001582 // rustlibs
Ivan Lozanod106efe2023-09-21 23:30:26 -04001583 if deps.Rustlibs != nil {
1584 if !mod.compiler.Disabled() {
1585 for _, lib := range deps.Rustlibs {
1586 autoDep := mod.compiler.(autoDeppable).autoDep(ctx)
1587 if autoDep.depTag == rlibDepTag {
1588 // Handle the rlib deptag case
Kiyoung Kim37693d02024-04-04 09:56:15 +09001589 actx.AddVariationDependencies(rlibDepVariations, rlibDepTag, lib)
1590
Ivan Lozanod106efe2023-09-21 23:30:26 -04001591 } else {
1592 // autoDep.depTag is a dylib depTag. Not all rustlibs may be available as a dylib however.
1593 // Check for the existence of the dylib deptag variant. Select it if available,
1594 // otherwise select the rlib variant.
1595 autoDepVariations := append(commonDepVariations,
1596 blueprint.Variation{Mutator: "rust_libraries", Variation: autoDep.variation})
1597
Kiyoung Kim37693d02024-04-04 09:56:15 +09001598 if actx.OtherModuleDependencyVariantExists(autoDepVariations, lib) {
1599 actx.AddVariationDependencies(autoDepVariations, autoDep.depTag, lib)
Ivan Lozanod106efe2023-09-21 23:30:26 -04001600
Ivan Lozanod106efe2023-09-21 23:30:26 -04001601 } else {
1602 // If there's no dylib dependency available, try to add the rlib dependency instead.
Kiyoung Kim37693d02024-04-04 09:56:15 +09001603 actx.AddVariationDependencies(rlibDepVariations, rlibDepTag, lib)
1604
Ivan Lozanod106efe2023-09-21 23:30:26 -04001605 }
1606 }
1607 }
1608 } else if _, ok := mod.sourceProvider.(*protobufDecorator); ok {
1609 for _, lib := range deps.Rustlibs {
Ivan Lozanod106efe2023-09-21 23:30:26 -04001610 srcProviderVariations := append(commonDepVariations,
1611 blueprint.Variation{Mutator: "rust_libraries", Variation: "source"})
1612
Kiyoung Kim37693d02024-04-04 09:56:15 +09001613 if actx.OtherModuleDependencyVariantExists(srcProviderVariations, lib) {
Ivan Lozanod106efe2023-09-21 23:30:26 -04001614 actx.AddVariationDependencies(srcProviderVariations, sourceDepTag, lib)
Ivan Lozano2d407632022-04-07 12:59:11 -04001615 }
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001616 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001617 }
Matthew Maurer0f003b12020-06-29 14:34:06 -07001618 }
Ivan Lozanod106efe2023-09-21 23:30:26 -04001619
Ivan Lozano1921e802021-05-20 13:39:16 -04001620 // stdlibs
Ivan Lozano2b081132020-09-08 12:46:52 -04001621 if deps.Stdlibs != nil {
Ivan Lozanodd055472020-09-28 13:22:45 -04001622 if mod.compiler.stdLinkage(ctx) == RlibLinkage {
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001623 for _, lib := range deps.Stdlibs {
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001624 actx.AddVariationDependencies(append(commonDepVariations, []blueprint.Variation{{Mutator: "rust_libraries", Variation: "rlib"}}...),
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001625 rlibDepTag, lib)
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001626 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001627 } else {
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001628 for _, lib := range deps.Stdlibs {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001629 actx.AddVariationDependencies(dylibDepVariations, dylibDepTag, lib)
1630
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001631 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001632 }
1633 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001634
1635 for _, lib := range deps.SharedLibs {
1636 depTag := cc.SharedDepTag()
1637 name, version := cc.StubsLibNameAndVersion(lib)
1638
1639 variations := []blueprint.Variation{
1640 {Mutator: "link", Variation: "shared"},
1641 }
Spandan Das604f3762023-03-16 22:51:40 +00001642 // For core variant, add a dep on the implementation (if it exists) and its .apiimport (if it exists)
1643 // GenerateAndroidBuildActions will pick the correct impl/stub based on the api_domain boundary
1644 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
1645 cc.AddSharedLibDependenciesWithVersions(ctx, mod, variations, depTag, name, version, false)
1646 }
1647
1648 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
1649 cc.AddSharedLibDependenciesWithVersions(ctx, mod, variations, depTag, apiLibraryName, version, false)
1650 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001651 }
1652
1653 for _, lib := range deps.WholeStaticLibs {
1654 depTag := cc.StaticDepTag(true)
Ivan Lozano1921e802021-05-20 13:39:16 -04001655
1656 actx.AddVariationDependencies([]blueprint.Variation{
1657 {Mutator: "link", Variation: "static"},
1658 }, depTag, lib)
1659 }
1660
1661 for _, lib := range deps.StaticLibs {
1662 depTag := cc.StaticDepTag(false)
Ivan Lozano1921e802021-05-20 13:39:16 -04001663
1664 actx.AddVariationDependencies([]blueprint.Variation{
1665 {Mutator: "link", Variation: "static"},
1666 }, depTag, lib)
1667 }
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07001668
Zach Johnson3df4e632020-11-06 11:56:27 -08001669 actx.AddVariationDependencies(nil, cc.HeaderDepTag(), deps.HeaderLibs...)
1670
Colin Cross565cafd2020-09-25 18:47:38 -07001671 crtVariations := cc.GetCrtVariations(ctx, mod)
Colin Crossfe605e12022-01-23 20:46:16 -08001672 for _, crt := range deps.CrtBegin {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001673 actx.AddVariationDependencies(crtVariations, cc.CrtBeginDepTag, crt)
Ivan Lozanof1c84332019-09-20 11:00:37 -07001674 }
Colin Crossfe605e12022-01-23 20:46:16 -08001675 for _, crt := range deps.CrtEnd {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001676 actx.AddVariationDependencies(crtVariations, cc.CrtEndDepTag, crt)
Ivan Lozanof1c84332019-09-20 11:00:37 -07001677 }
1678
Ivan Lozanoc564d2d2020-08-04 15:43:37 -04001679 if mod.sourceProvider != nil {
1680 if bindgen, ok := mod.sourceProvider.(*bindgenDecorator); ok &&
1681 bindgen.Properties.Custom_bindgen != "" {
1682 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), customBindgenDepTag,
1683 bindgen.Properties.Custom_bindgen)
1684 }
1685 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001686
Ivan Lozano4e5f07d2021-11-04 14:09:38 -04001687 actx.AddVariationDependencies([]blueprint.Variation{
1688 {Mutator: "link", Variation: "shared"},
1689 }, dataLibDepTag, deps.DataLibs...)
1690
1691 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
1692
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07001693 // proc_macros are compiler plugins, and so we need the host arch variant as a dependendcy.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001694 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), procMacroDepTag, deps.ProcMacros...)
Vinh Trancde10162023-03-09 22:07:19 -05001695
1696 mod.afdo.addDep(ctx, actx)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001697}
1698
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001699func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07001700 if mod, ok := ctx.Module().(*Module); ok && mod.Enabled(ctx) {
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001701 mod.beginMutator(ctx)
1702 }
1703}
1704
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001705func (mod *Module) beginMutator(actx android.BottomUpMutatorContext) {
1706 ctx := &baseModuleContext{
1707 BaseModuleContext: actx,
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001708 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001709
1710 mod.begin(ctx)
1711}
1712
Ivan Lozanoffee3342019-08-27 12:03:00 -07001713func (mod *Module) Name() string {
1714 name := mod.ModuleBase.Name()
1715 if p, ok := mod.compiler.(interface {
1716 Name(string) string
1717 }); ok {
1718 name = p.Name(name)
1719 }
1720 return name
1721}
1722
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02001723func (mod *Module) disableClippy() {
Ivan Lozano32267c82020-08-04 16:27:16 -04001724 if mod.clippy != nil {
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02001725 mod.clippy.Properties.Clippy_lints = proptools.StringPtr("none")
Ivan Lozano32267c82020-08-04 16:27:16 -04001726 }
1727}
1728
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07001729var _ android.HostToolProvider = (*Module)(nil)
1730
1731func (mod *Module) HostToolPath() android.OptionalPath {
1732 if !mod.Host() {
1733 return android.OptionalPath{}
1734 }
Chih-Hung Hsieha7562702020-08-10 21:50:43 -07001735 if binary, ok := mod.compiler.(*binaryDecorator); ok {
1736 return android.OptionalPathForPath(binary.baseCompiler.path)
Ivan Lozano872d5792022-03-23 17:31:39 -04001737 } else if pm, ok := mod.compiler.(*procMacroDecorator); ok {
1738 // Even though proc-macros aren't strictly "tools", since they target the compiler
1739 // and act as compiler plugins, we treat them similarly.
1740 return android.OptionalPathForPath(pm.baseCompiler.path)
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07001741 }
1742 return android.OptionalPath{}
1743}
1744
Jiyong Park99644e92020-11-17 22:21:02 +09001745var _ android.ApexModule = (*Module)(nil)
1746
Ivan Lozanoa91ba252022-01-11 12:02:06 -05001747func (mod *Module) MinSdkVersion() string {
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05001748 return String(mod.Properties.Min_sdk_version)
1749}
1750
Jiyong Park45bf82e2020-12-15 22:29:02 +09001751// Implements android.ApexModule
Jiyong Park99644e92020-11-17 22:21:02 +09001752func (mod *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Ivan Lozanoa91ba252022-01-11 12:02:06 -05001753 minSdkVersion := mod.MinSdkVersion()
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05001754 if minSdkVersion == "apex_inherit" {
1755 return nil
1756 }
1757 if minSdkVersion == "" {
1758 return fmt.Errorf("min_sdk_version is not specificed")
1759 }
1760
1761 // Not using nativeApiLevelFromUser because the context here is not
1762 // necessarily a native context.
1763 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1764 if err != nil {
1765 return err
1766 }
1767
1768 if ver.GreaterThan(sdkVersion) {
1769 return fmt.Errorf("newer SDK(%v)", ver)
1770 }
Jiyong Park99644e92020-11-17 22:21:02 +09001771 return nil
1772}
1773
Jiyong Park45bf82e2020-12-15 22:29:02 +09001774// Implements android.ApexModule
Jiyong Park99644e92020-11-17 22:21:02 +09001775func (mod *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1776 depTag := ctx.OtherModuleDependencyTag(dep)
1777
1778 if ccm, ok := dep.(*cc.Module); ok {
1779 if ccm.HasStubsVariants() {
1780 if cc.IsSharedDepTag(depTag) {
1781 // dynamic dep to a stubs lib crosses APEX boundary
1782 return false
1783 }
1784 if cc.IsRuntimeDepTag(depTag) {
1785 // runtime dep to a stubs lib also crosses APEX boundary
1786 return false
1787 }
1788
1789 if cc.IsHeaderDepTag(depTag) {
1790 return false
1791 }
1792 }
1793 if mod.Static() && cc.IsSharedDepTag(depTag) {
1794 // shared_lib dependency from a static lib is considered as crossing
1795 // the APEX boundary because the dependency doesn't actually is
1796 // linked; the dependency is used only during the compilation phase.
1797 return false
1798 }
1799 }
1800
Matthew Maurer581b6d82022-09-29 16:46:25 -07001801 if depTag == procMacroDepTag || depTag == customBindgenDepTag {
Jiyong Park99644e92020-11-17 22:21:02 +09001802 return false
1803 }
1804
1805 return true
1806}
1807
1808// Overrides ApexModule.IsInstallabeToApex()
1809func (mod *Module) IsInstallableToApex() bool {
1810 if mod.compiler != nil {
Ivan Lozano45e0e5b2021-11-13 07:42:36 -05001811 if lib, ok := mod.compiler.(libraryInterface); ok && (lib.shared() || lib.dylib()) {
Jiyong Park99644e92020-11-17 22:21:02 +09001812 return true
1813 }
1814 if _, ok := mod.compiler.(*binaryDecorator); ok {
1815 return true
1816 }
1817 }
1818 return false
1819}
1820
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001821// If a library file has a "lib" prefix, extract the library name without the prefix.
1822func libNameFromFilePath(filepath android.Path) (string, bool) {
1823 libName := strings.TrimSuffix(filepath.Base(), filepath.Ext())
1824 if strings.HasPrefix(libName, "lib") {
1825 libName = libName[3:]
1826 return libName, true
1827 }
1828 return "", false
1829}
1830
Sasha Smundaka76acba2022-04-18 20:12:56 -07001831func kytheExtractRustFactory() android.Singleton {
1832 return &kytheExtractRustSingleton{}
1833}
1834
1835type kytheExtractRustSingleton struct {
1836}
1837
1838func (k kytheExtractRustSingleton) GenerateBuildActions(ctx android.SingletonContext) {
1839 var xrefTargets android.Paths
1840 ctx.VisitAllModules(func(module android.Module) {
1841 if rustModule, ok := module.(xref); ok {
1842 xrefTargets = append(xrefTargets, rustModule.XrefRustFiles()...)
1843 }
1844 })
1845 if len(xrefTargets) > 0 {
1846 ctx.Phony("xref_rust", xrefTargets...)
1847 }
1848}
1849
Jihoon Kangf78a8902022-09-01 22:47:07 +00001850func (c *Module) Partition() string {
1851 return ""
1852}
1853
Ivan Lozanoffee3342019-08-27 12:03:00 -07001854var Bool = proptools.Bool
1855var BoolDefault = proptools.BoolDefault
1856var String = proptools.String
1857var StringPtr = proptools.StringPtr
Ivan Lozano43845682020-07-09 21:03:28 -04001858
1859var _ android.OutputFileProducer = (*Module)(nil)