blob: b73f79b0b9adcffec5c059b63b48b22e71014cb3 [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"
Wei Lia1aa2972024-06-21 13:08:51 -070019 "strconv"
Chris Parsons637458d2023-09-19 20:09:00 +000020 "strings"
21
Sasha Smundaka76acba2022-04-18 20:12:56 -070022 "android/soong/bloaty"
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090023
Ivan Lozanoffee3342019-08-27 12:03:00 -070024 "github.com/google/blueprint"
Colin Crossa14fb6a2024-10-23 16:57:06 -070025 "github.com/google/blueprint/depset"
Ivan Lozanoffee3342019-08-27 12:03:00 -070026 "github.com/google/blueprint/proptools"
27
28 "android/soong/android"
29 "android/soong/cc"
Thiébaud Weksteen31f1bb82020-08-27 13:37:29 +020030 cc_config "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070031 "android/soong/fuzz"
Ivan Lozanoffee3342019-08-27 12:03:00 -070032 "android/soong/rust/config"
33)
34
35var pctx = android.NewPackageContext("android/soong/rust")
36
Yu Liu8024b922024-12-20 23:31:32 +000037type LibraryInfo struct {
38 Rlib bool
39 Dylib bool
40}
41
42type CompilerInfo struct {
43 StdLinkageForDevice RustLinkage
44 StdLinkageForNonDevice RustLinkage
45 NoStdlibs bool
46 LibraryInfo *LibraryInfo
47}
48
49type ProtobufDecoratorInfo struct{}
50
51type SourceProviderInfo struct {
Yu Liu727204c2025-01-23 20:58:32 +000052 Srcs android.Paths
Yu Liu8024b922024-12-20 23:31:32 +000053 ProtobufDecoratorInfo *ProtobufDecoratorInfo
54}
55
56type RustInfo struct {
57 AndroidMkSuffix string
58 RustSubName string
59 TransitiveAndroidMkSharedLibs depset.DepSet[string]
60 CompilerInfo *CompilerInfo
61 SnapshotInfo *cc.SnapshotInfo
62 SourceProviderInfo *SourceProviderInfo
63}
64
65var RustInfoProvider = blueprint.NewProvider[*RustInfo]()
66
Ivan Lozanoffee3342019-08-27 12:03:00 -070067func init() {
Ivan Lozanoffee3342019-08-27 12:03:00 -070068 android.RegisterModuleType("rust_defaults", defaultsFactory)
Colin Cross8a49a3d2024-05-20 12:22:27 -070069 android.PreDepsMutators(registerPreDepsMutators)
70 android.PostDepsMutators(registerPostDepsMutators)
Inseob Kim3b244062023-07-11 13:31:36 +090071 pctx.Import("android/soong/android")
Ivan Lozanoffee3342019-08-27 12:03:00 -070072 pctx.Import("android/soong/rust/config")
Thiébaud Weksteen682c9d72020-08-31 10:06:16 +020073 pctx.ImportAs("cc_config", "android/soong/cc/config")
LaMont Jones0c10e4d2023-05-16 00:58:37 +000074 android.InitRegistrationContext.RegisterParallelSingletonType("kythe_rust_extract", kytheExtractRustFactory)
Ivan Lozanoffee3342019-08-27 12:03:00 -070075}
76
Colin Cross8a49a3d2024-05-20 12:22:27 -070077func registerPreDepsMutators(ctx android.RegisterMutatorsContext) {
78 ctx.Transition("rust_libraries", &libraryTransitionMutator{})
79 ctx.Transition("rust_stdlinkage", &libstdTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -070080 ctx.BottomUp("rust_begin", BeginMutator)
Colin Cross8a49a3d2024-05-20 12:22:27 -070081}
82
83func registerPostDepsMutators(ctx android.RegisterMutatorsContext) {
Colin Cross8a962802024-10-09 15:29:27 -070084 ctx.BottomUp("rust_sanitizers", rustSanitizerRuntimeMutator)
Colin Cross8a49a3d2024-05-20 12:22:27 -070085}
86
Ivan Lozanoffee3342019-08-27 12:03:00 -070087type Flags struct {
Ivan Lozano8a23fa42020-06-16 10:26:57 -040088 GlobalRustFlags []string // Flags that apply globally to rust
89 GlobalLinkFlags []string // Flags that apply globally to linker
90 RustFlags []string // Flags that apply to rust
91 LinkFlags []string // Flags that apply to linker
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020092 ClippyFlags []string // Flags that apply to clippy-driver, during the linting
Dan Albert06feee92021-03-19 15:06:02 -070093 RustdocFlags []string // Flags that apply to rustdoc
Ivan Lozanof1c84332019-09-20 11:00:37 -070094 Toolchain config.Toolchain
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -040095 Coverage bool
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020096 Clippy bool
Sasha Smundaka76acba2022-04-18 20:12:56 -070097 EmitXrefs bool // If true, emit rules to aid cross-referencing
Ivan Lozanoffee3342019-08-27 12:03:00 -070098}
99
100type BaseProperties struct {
Liz Kammer884fe9e2023-02-28 14:29:13 -0500101 AndroidMkRlibs []string `blueprint:"mutated"`
102 AndroidMkDylibs []string `blueprint:"mutated"`
103 AndroidMkProcMacroLibs []string `blueprint:"mutated"`
Liz Kammer884fe9e2023-02-28 14:29:13 -0500104 AndroidMkStaticLibs []string `blueprint:"mutated"`
Ivan Lozano1dbfa142024-03-29 14:48:11 +0000105 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Ivan Lozano43845682020-07-09 21:03:28 -0400106
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900107 ImageVariation string `blueprint:"mutated"`
108 VndkVersion string `blueprint:"mutated"`
109 SubName string `blueprint:"mutated"`
Ivan Lozano6a884432020-12-02 09:15:16 -0500110
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400111 // SubName is used by CC for tracking image variants / SDK versions. RustSubName is used for Rust-specific
112 // subnaming which shouldn't be visible to CC modules (such as the rlib stdlinkage subname). This should be
113 // appended before SubName.
114 RustSubName string `blueprint:"mutated"`
115
Ivan Lozano6a884432020-12-02 09:15:16 -0500116 // Set by imageMutator
Jihoon Kang47e91842024-06-19 00:51:16 +0000117 ProductVariantNeeded bool `blueprint:"mutated"`
118 VendorVariantNeeded bool `blueprint:"mutated"`
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500119 CoreVariantNeeded bool `blueprint:"mutated"`
120 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
Matthew Maurerc6868382021-07-13 14:12:37 -0700121 RamdiskVariantNeeded bool `blueprint:"mutated"`
Matthew Maurer460ee942021-02-11 12:31:46 -0800122 RecoveryVariantNeeded bool `blueprint:"mutated"`
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500123 ExtraVariants []string `blueprint:"mutated"`
124
Ivan Lozanoa2268632021-07-22 10:52:06 -0400125 // Allows this module to use non-APEX version of libraries. Useful
126 // for building binaries that are started before APEXes are activated.
127 Bootstrap *bool
128
Ivan Lozano1921e802021-05-20 13:39:16 -0400129 // Used by vendor snapshot to record dependencies from snapshot modules.
130 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900131 SnapshotStaticLibs []string `blueprint:"mutated"`
Ivan Lozanoadd122a2023-07-13 11:01:41 -0400132 SnapshotRlibs []string `blueprint:"mutated"`
133 SnapshotDylibs []string `blueprint:"mutated"`
Ivan Lozano1921e802021-05-20 13:39:16 -0400134
Matthew Maurerc6868382021-07-13 14:12:37 -0700135 // Make this module available when building for ramdisk.
136 // On device without a dedicated recovery partition, the module is only
137 // available after switching root into
138 // /first_stage_ramdisk. To expose the module before switching root, install
139 // the recovery variant instead.
140 Ramdisk_available *bool
141
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500142 // Make this module available when building for vendor ramdisk.
143 // On device without a dedicated recovery partition, the module is only
144 // available after switching root into
145 // /first_stage_ramdisk. To expose the module before switching root, install
Matthew Maurer460ee942021-02-11 12:31:46 -0800146 // the recovery variant instead
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500147 Vendor_ramdisk_available *bool
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400148
Ivan Lozano1921e802021-05-20 13:39:16 -0400149 // Normally Soong uses the directory structure to decide which modules
150 // should be included (framework) or excluded (non-framework) from the
151 // different snapshots (vendor, recovery, etc.), but this property
152 // allows a partner to exclude a module normally thought of as a
153 // framework module from the vendor snapshot.
154 Exclude_from_vendor_snapshot *bool
155
156 // Normally Soong uses the directory structure to decide which modules
157 // should be included (framework) or excluded (non-framework) from the
158 // different snapshots (vendor, recovery, etc.), but this property
159 // allows a partner to exclude a module normally thought of as a
160 // framework module from the recovery snapshot.
161 Exclude_from_recovery_snapshot *bool
162
Matthew Maurer460ee942021-02-11 12:31:46 -0800163 // Make this module available when building for recovery
164 Recovery_available *bool
165
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000166 // The API level that this module is built against. The APIs of this API level will be
167 // visible at build time, but use of any APIs newer than min_sdk_version will render the
168 // module unloadable on older devices. In the future it will be possible to weakly-link new
169 // APIs, making the behavior match Java: such modules will load on older devices, but
170 // calling new APIs on devices that do not support them will result in a crash.
171 //
172 // This property has the same behavior as sdk_version does for Java modules. For those
173 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
174 // does for Java code.
175 //
176 // In addition, setting this property causes two variants to be built, one for the platform
177 // and one for apps.
178 Sdk_version *string
179
180 // Minimum OS API level supported by this C or C++ module. This property becomes the value
181 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
182 // this property is also used to ensure that the min_sdk_version of the containing module is
183 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
184 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
185 // min_sdk_version of the containing APEX. When the module
186 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Ivan Lozano3e9f9e42020-12-04 15:05:43 -0500187 Min_sdk_version *string
188
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000189 // Variant is an SDK variant created by sdkMutator
190 IsSdkVariant bool `blueprint:"mutated"`
191
192 // Set by factories of module types that can only be referenced from variants compiled against
193 // the SDK.
194 AlwaysSdk bool `blueprint:"mutated"`
195
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900196 HideFromMake bool `blueprint:"mutated"`
197 PreventInstall bool `blueprint:"mutated"`
198
199 Installable *bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700200}
201
202type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700203 fuzz.FuzzModule
Ivan Lozanoffee3342019-08-27 12:03:00 -0700204
Ivan Lozano6a884432020-12-02 09:15:16 -0500205 VendorProperties cc.VendorProperties
206
Ivan Lozanoffee3342019-08-27 12:03:00 -0700207 Properties BaseProperties
208
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000209 hod android.HostOrDeviceSupported
210 multilib android.Multilib
211 testModule bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700212
Ivan Lozano6a884432020-12-02 09:15:16 -0500213 makeLinkType string
214
Yi Kong46c6e592022-01-20 22:55:00 +0800215 afdo *afdo
Ivan Lozanoffee3342019-08-27 12:03:00 -0700216 compiler compiler
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400217 coverage *coverage
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200218 clippy *clippy
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500219 sanitize *sanitize
Ivan Lozanoffee3342019-08-27 12:03:00 -0700220 cachedToolchain config.Toolchain
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400221 sourceProvider SourceProvider
Andrei Homescuc7767922020-08-05 06:36:19 -0700222 subAndroidMkOnce map[SubAndroidMkProvider]bool
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400223
Ivan Lozano0a468a42024-05-13 21:03:34 -0400224 exportedLinkDirs []string
225
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400226 // Output file to be installed, may be stripped or unstripped.
227 outputFile android.OptionalPath
228
Sasha Smundaka76acba2022-04-18 20:12:56 -0700229 // Cross-reference input file
230 kytheFiles android.Paths
231
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400232 docTimestampFile android.OptionalPath
Jiyong Park99644e92020-11-17 22:21:02 +0900233
234 hideApexVariantFromMake bool
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500235
236 // For apex variants, this is set as apex.min_sdk_version
237 apexSdkVersion android.ApiLevel
Cole Faustb6e6f992023-08-17 17:42:26 -0700238
Colin Crossa14fb6a2024-10-23 16:57:06 -0700239 transitiveAndroidMkSharedLibs depset.DepSet[string]
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000240
241 // Shared flags among stubs build rules of this module
242 sharedFlags cc.SharedFlags
Ivan Lozanoffee3342019-08-27 12:03:00 -0700243}
244
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500245func (mod *Module) Header() bool {
246 //TODO: If Rust libraries provide header variants, this needs to be updated.
247 return false
248}
249
250func (mod *Module) SetPreventInstall() {
251 mod.Properties.PreventInstall = true
252}
253
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500254func (mod *Module) SetHideFromMake() {
255 mod.Properties.HideFromMake = true
256}
257
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900258func (mod *Module) HiddenFromMake() bool {
259 return mod.Properties.HideFromMake
Ivan Lozanod7586b62021-04-01 09:49:36 -0400260}
261
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500262func (mod *Module) SanitizePropDefined() bool {
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500263 // Because compiler is not set for some Rust modules where sanitize might be set, check that compiler is also not
264 // nil since we need compiler to actually sanitize.
265 return mod.sanitize != nil && mod.compiler != nil
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500266}
267
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500268func (mod *Module) IsPrebuilt() bool {
269 if _, ok := mod.compiler.(*prebuiltLibraryDecorator); ok {
270 return true
271 }
272 return false
273}
274
Ivan Lozano52767be2019-10-18 14:49:46 -0700275func (mod *Module) SelectedStl() string {
276 return ""
277}
278
Ivan Lozano2b262972019-11-21 12:30:50 -0800279func (mod *Module) NonCcVariants() bool {
280 if mod.compiler != nil {
Ivan Lozano0a468a42024-05-13 21:03:34 -0400281 if library, ok := mod.compiler.(libraryInterface); ok {
282 return library.buildRlib() || library.buildDylib()
Ivan Lozano2b262972019-11-21 12:30:50 -0800283 }
284 }
285 panic(fmt.Errorf("NonCcVariants called on non-library module: %q", mod.BaseModuleName()))
286}
287
Ivan Lozano52767be2019-10-18 14:49:46 -0700288func (mod *Module) Static() bool {
289 if mod.compiler != nil {
290 if library, ok := mod.compiler.(libraryInterface); ok {
291 return library.static()
292 }
293 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400294 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700295}
296
297func (mod *Module) Shared() bool {
298 if mod.compiler != nil {
299 if library, ok := mod.compiler.(libraryInterface); ok {
Ivan Lozano89435d12020-07-31 11:01:18 -0400300 return library.shared()
Ivan Lozano52767be2019-10-18 14:49:46 -0700301 }
302 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400303 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700304}
305
Ivan Lozanod7586b62021-04-01 09:49:36 -0400306func (mod *Module) Dylib() bool {
307 if mod.compiler != nil {
308 if library, ok := mod.compiler.(libraryInterface); ok {
309 return library.dylib()
310 }
311 }
312 return false
313}
314
Ivan Lozanod106efe2023-09-21 23:30:26 -0400315func (mod *Module) Source() bool {
316 if mod.compiler != nil {
317 if library, ok := mod.compiler.(libraryInterface); ok && mod.sourceProvider != nil {
318 return library.source()
319 }
320 }
321 return false
322}
323
Ivan Lozanoadd122a2023-07-13 11:01:41 -0400324func (mod *Module) RlibStd() bool {
325 if mod.compiler != nil {
326 if library, ok := mod.compiler.(libraryInterface); ok && library.rlib() {
327 return library.rlibStd()
328 }
329 }
330 panic(fmt.Errorf("RlibStd() called on non-rlib module: %q", mod.BaseModuleName()))
331}
332
Ivan Lozanod7586b62021-04-01 09:49:36 -0400333func (mod *Module) Rlib() bool {
334 if mod.compiler != nil {
335 if library, ok := mod.compiler.(libraryInterface); ok {
336 return library.rlib()
337 }
338 }
339 return false
340}
341
342func (mod *Module) Binary() bool {
Ivan Lozano21fa0a52021-11-01 09:19:45 -0400343 if binary, ok := mod.compiler.(binaryInterface); ok {
344 return binary.binary()
Ivan Lozanod7586b62021-04-01 09:49:36 -0400345 }
346 return false
347}
348
Justin Yun5e035862021-06-29 20:50:37 +0900349func (mod *Module) StaticExecutable() bool {
350 if !mod.Binary() {
351 return false
352 }
Ivan Lozano21fa0a52021-11-01 09:19:45 -0400353 return mod.StaticallyLinked()
Justin Yun5e035862021-06-29 20:50:37 +0900354}
355
Ashutosh Agarwal46e4fad2024-08-27 17:13:12 +0000356func (mod *Module) ApexExclude() bool {
357 if mod.compiler != nil {
358 if library, ok := mod.compiler.(libraryInterface); ok {
359 return library.apexExclude()
360 }
361 }
362 return false
363}
364
Ivan Lozanod7586b62021-04-01 09:49:36 -0400365func (mod *Module) Object() bool {
366 // Rust has no modules which produce only object files.
367 return false
368}
369
Ivan Lozano52767be2019-10-18 14:49:46 -0700370func (mod *Module) Toc() android.OptionalPath {
371 if mod.compiler != nil {
Ivan Lozano7b0781d2021-11-03 15:30:18 -0400372 if lib, ok := mod.compiler.(libraryInterface); ok {
373 return lib.toc()
Ivan Lozano52767be2019-10-18 14:49:46 -0700374 }
375 }
376 panic(fmt.Errorf("Toc() called on non-library module: %q", mod.BaseModuleName()))
377}
378
Colin Crossc511bc52020-04-07 16:50:32 +0000379func (mod *Module) UseSdk() bool {
380 return false
381}
382
Ivan Lozanod7586b62021-04-01 09:49:36 -0400383func (mod *Module) RelativeInstallPath() string {
384 if mod.compiler != nil {
385 return mod.compiler.relativeInstallPath()
386 }
387 return ""
388}
389
Ivan Lozano52767be2019-10-18 14:49:46 -0700390func (mod *Module) UseVndk() bool {
Ivan Lozano6a884432020-12-02 09:15:16 -0500391 return mod.Properties.VndkVersion != ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700392}
393
Jiyong Park7d55b612021-06-11 17:22:09 +0900394func (mod *Module) Bootstrap() bool {
Ivan Lozanoa2268632021-07-22 10:52:06 -0400395 return Bool(mod.Properties.Bootstrap)
Jiyong Park7d55b612021-06-11 17:22:09 +0900396}
397
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400398func (mod *Module) SubName() string {
399 return mod.Properties.SubName
Ivan Lozano52767be2019-10-18 14:49:46 -0700400}
401
Ivan Lozanof1868af2022-04-12 13:08:36 -0400402func (mod *Module) IsVndkPrebuiltLibrary() bool {
403 // Rust modules do not provide VNDK prebuilts
404 return false
405}
406
407func (mod *Module) IsVendorPublicLibrary() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000408 // Rust modules do not currently support vendor_public_library
409 return false
Ivan Lozanof1868af2022-04-12 13:08:36 -0400410}
411
412func (mod *Module) SdkAndPlatformVariantVisibleToMake() bool {
413 // Rust modules to not provide Sdk variants
414 return false
415}
416
Colin Cross127bb8b2020-12-16 16:46:01 -0800417func (c *Module) IsVndkPrivate() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000418 // Rust modules do not currently support VNDK variants
Colin Cross127bb8b2020-12-16 16:46:01 -0800419 return false
420}
421
422func (c *Module) IsLlndk() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000423 // Rust modules do not currently support LLNDK variants
Colin Cross127bb8b2020-12-16 16:46:01 -0800424 return false
425}
426
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400427func (mod *Module) KernelHeadersDecorator() bool {
428 return false
429}
430
Colin Cross1f3f1302021-04-26 18:37:44 -0700431func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000432 // Rust modules do not currently support LLNDK variants
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400433 return false
434}
435
Colin Cross5271fea2021-04-27 13:06:04 -0700436func (m *Module) NeedsVendorPublicLibraryVariants() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000437 // Rust modules do not currently support vendor_public_library
Colin Cross5271fea2021-04-27 13:06:04 -0700438 return false
439}
440
Ivan Lozanod7586b62021-04-01 09:49:36 -0400441func (mod *Module) HasLlndkStubs() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000442 // Rust modules do not currently support LLNDK stubs
Ivan Lozanod7586b62021-04-01 09:49:36 -0400443 return false
444}
445
Ivan Lozano52767be2019-10-18 14:49:46 -0700446func (mod *Module) SdkVersion() string {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000447 return String(mod.Properties.Sdk_version)
Ivan Lozano52767be2019-10-18 14:49:46 -0700448}
449
Colin Crossc511bc52020-04-07 16:50:32 +0000450func (mod *Module) AlwaysSdk() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000451 return mod.Properties.AlwaysSdk
Colin Crossc511bc52020-04-07 16:50:32 +0000452}
453
Jiyong Park2286afd2020-06-16 21:58:53 +0900454func (mod *Module) IsSdkVariant() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000455 return mod.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +0900456}
457
Colin Cross1348ce32020-10-01 13:37:16 -0700458func (mod *Module) SplitPerApiLevel() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000459 return cc.CanUseSdk(mod) && mod.IsCrt()
Colin Cross1348ce32020-10-01 13:37:16 -0700460}
461
Sasha Smundaka76acba2022-04-18 20:12:56 -0700462func (mod *Module) XrefRustFiles() android.Paths {
463 return mod.kytheFiles
464}
465
Ivan Lozanoffee3342019-08-27 12:03:00 -0700466type Deps struct {
Ivan Lozano63bb7682021-03-23 15:53:44 -0400467 Dylibs []string
468 Rlibs []string
469 Rustlibs []string
470 Stdlibs []string
471 ProcMacros []string
472 SharedLibs []string
473 StaticLibs []string
474 WholeStaticLibs []string
475 HeaderLibs []string
Ivan Lozanoffee3342019-08-27 12:03:00 -0700476
Ivan Lozano4e5f07d2021-11-04 14:09:38 -0400477 // Used for data dependencies adjacent to tests
478 DataLibs []string
479 DataBins []string
480
Colin Crossfe605e12022-01-23 20:46:16 -0800481 CrtBegin, CrtEnd []string
Ivan Lozanoffee3342019-08-27 12:03:00 -0700482}
483
484type PathDeps struct {
Colin Cross004bd3f2023-10-02 11:39:17 -0700485 DyLibs RustLibraries
486 RLibs RustLibraries
487 SharedLibs android.Paths
488 SharedLibDeps android.Paths
489 StaticLibs android.Paths
490 ProcMacros RustLibraries
491 AfdoProfiles android.Paths
Ivan Lozanof4589012024-11-20 22:18:11 +0000492 LinkerDeps android.Paths
Ivan Lozano3dfa12d2021-02-04 11:29:41 -0500493
494 // depFlags and depLinkFlags are rustc and linker (clang) flags.
495 depFlags []string
496 depLinkFlags []string
497
Ivan Lozano85f00cf2025-02-11 20:19:19 +0000498 // track cc static-libs that have Rlib dependencies
499 reexportedCcRlibDeps []cc.RustRlibDep
500 ccRlibDeps []cc.RustRlibDep
501
Ivan Lozanofd47b1a2024-05-17 14:13:41 -0400502 // linkDirs are link paths passed via -L to rustc. linkObjects are objects passed directly to the linker
Ivan Lozano3dfa12d2021-02-04 11:29:41 -0500503 // Both of these are exported and propagate to dependencies.
Ivan Lozano1f10f682024-11-08 16:16:50 +0000504 linkDirs []string
505 rustLibObjects []string
506 staticLibObjects []string
507 wholeStaticLibObjects []string
508 sharedLibObjects []string
Ivan Lozanof1c84332019-09-20 11:00:37 -0700509
Ivan Lozano0a468a42024-05-13 21:03:34 -0400510 // exportedLinkDirs are exported linkDirs for direct rlib dependencies to
511 // cc_library_static dependants of rlibs.
512 // Track them separately from linkDirs so superfluous -L flags don't get emitted.
513 exportedLinkDirs []string
514
Ivan Lozano45901ed2020-07-24 16:05:01 -0400515 // Used by bindgen modules which call clang
516 depClangFlags []string
517 depIncludePaths android.Paths
Ivan Lozanoddd0bdb2020-08-28 17:00:26 -0400518 depGeneratedHeaders android.Paths
Ivan Lozano45901ed2020-07-24 16:05:01 -0400519 depSystemIncludePaths android.Paths
520
Colin Crossfe605e12022-01-23 20:46:16 -0800521 CrtBegin android.Paths
522 CrtEnd android.Paths
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700523
524 // Paths to generated source files
Ivan Lozano9d74a522020-12-01 09:25:22 -0500525 SrcDeps android.Paths
526 srcProviderFiles android.Paths
Colin Crossb614cd42024-10-11 12:52:21 -0700527
528 directImplementationDeps android.Paths
529 transitiveImplementationDeps []depset.DepSet[android.Path]
Ivan Lozanoffee3342019-08-27 12:03:00 -0700530}
531
532type RustLibraries []RustLibrary
533
534type RustLibrary struct {
535 Path android.Path
536 CrateName string
537}
538
Matthew Maurerbb3add12020-06-25 09:34:12 -0700539type exportedFlagsProducer interface {
Wen-yi Chu41326c12023-09-22 03:58:59 +0000540 exportLinkDirs(...string)
Ivan Lozano1f10f682024-11-08 16:16:50 +0000541 exportRustLibs(...string)
542 exportStaticLibs(...string)
543 exportWholeStaticLibs(...string)
544 exportSharedLibs(...string)
Matthew Maurerbb3add12020-06-25 09:34:12 -0700545}
546
Sasha Smundaka76acba2022-04-18 20:12:56 -0700547type xref interface {
548 XrefRustFiles() android.Paths
549}
550
Matthew Maurerbb3add12020-06-25 09:34:12 -0700551type flagExporter struct {
Ivan Lozano1f10f682024-11-08 16:16:50 +0000552 linkDirs []string
553 ccLinkDirs []string
554 rustLibPaths []string
555 staticLibObjects []string
556 sharedLibObjects []string
557 wholeStaticLibObjects []string
Matthew Maurerbb3add12020-06-25 09:34:12 -0700558}
559
Wen-yi Chu41326c12023-09-22 03:58:59 +0000560func (flagExporter *flagExporter) exportLinkDirs(dirs ...string) {
561 flagExporter.linkDirs = android.FirstUniqueStrings(append(flagExporter.linkDirs, dirs...))
Matthew Maurerbb3add12020-06-25 09:34:12 -0700562}
563
Ivan Lozano1f10f682024-11-08 16:16:50 +0000564func (flagExporter *flagExporter) exportRustLibs(flags ...string) {
565 flagExporter.rustLibPaths = android.FirstUniqueStrings(append(flagExporter.rustLibPaths, flags...))
566}
567
568func (flagExporter *flagExporter) exportStaticLibs(flags ...string) {
569 flagExporter.staticLibObjects = android.FirstUniqueStrings(append(flagExporter.staticLibObjects, flags...))
570}
571
572func (flagExporter *flagExporter) exportSharedLibs(flags ...string) {
573 flagExporter.sharedLibObjects = android.FirstUniqueStrings(append(flagExporter.sharedLibObjects, flags...))
574}
575
576func (flagExporter *flagExporter) exportWholeStaticLibs(flags ...string) {
577 flagExporter.wholeStaticLibObjects = android.FirstUniqueStrings(append(flagExporter.wholeStaticLibObjects, flags...))
Ivan Lozano2093af22020-08-25 12:48:19 -0400578}
579
Ivan Lozano7fe65ca2025-02-05 02:22:33 +0000580func (flagExporter *flagExporter) setRustProvider(ctx ModuleContext) {
581 android.SetProvider(ctx, RustFlagExporterInfoProvider, RustFlagExporterInfo{
Ivan Lozano1f10f682024-11-08 16:16:50 +0000582 LinkDirs: flagExporter.linkDirs,
583 RustLibObjects: flagExporter.rustLibPaths,
584 StaticLibObjects: flagExporter.staticLibObjects,
585 WholeStaticLibObjects: flagExporter.wholeStaticLibObjects,
586 SharedLibPaths: flagExporter.sharedLibObjects,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700587 })
588}
589
Matthew Maurerbb3add12020-06-25 09:34:12 -0700590var _ exportedFlagsProducer = (*flagExporter)(nil)
591
592func NewFlagExporter() *flagExporter {
Colin Cross0de8a1e2020-09-18 14:15:30 -0700593 return &flagExporter{}
Matthew Maurerbb3add12020-06-25 09:34:12 -0700594}
595
Ivan Lozano7fe65ca2025-02-05 02:22:33 +0000596type RustFlagExporterInfo struct {
Ivan Lozano1f10f682024-11-08 16:16:50 +0000597 Flags []string
598 LinkDirs []string
599 RustLibObjects []string
600 StaticLibObjects []string
601 WholeStaticLibObjects []string
602 SharedLibPaths []string
Colin Cross0de8a1e2020-09-18 14:15:30 -0700603}
604
Ivan Lozano7fe65ca2025-02-05 02:22:33 +0000605var RustFlagExporterInfoProvider = blueprint.NewProvider[RustFlagExporterInfo]()
Colin Cross0de8a1e2020-09-18 14:15:30 -0700606
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400607func (mod *Module) isCoverageVariant() bool {
608 return mod.coverage.Properties.IsCoverageVariant
609}
610
611var _ cc.Coverage = (*Module)(nil)
612
Colin Crosse1a85552024-06-14 12:17:37 -0700613func (mod *Module) IsNativeCoverageNeeded(ctx cc.IsNativeCoverageNeededContext) bool {
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400614 return mod.coverage != nil && mod.coverage.Properties.NeedCoverageVariant
615}
616
Ivan Lozanod7586b62021-04-01 09:49:36 -0400617func (mod *Module) VndkVersion() string {
618 return mod.Properties.VndkVersion
619}
620
Ivan Lozano0a468a42024-05-13 21:03:34 -0400621func (mod *Module) ExportedCrateLinkDirs() []string {
622 return mod.exportedLinkDirs
623}
624
Ivan Lozanod7586b62021-04-01 09:49:36 -0400625func (mod *Module) PreventInstall() bool {
626 return mod.Properties.PreventInstall
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400627}
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000628func (c *Module) ForceDisableSanitizers() {
629 c.sanitize.Properties.ForceDisable = true
630}
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400631
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400632func (mod *Module) MarkAsCoverageVariant(coverage bool) {
633 mod.coverage.Properties.IsCoverageVariant = coverage
634}
635
636func (mod *Module) EnableCoverageIfNeeded() {
637 mod.coverage.Properties.CoverageEnabled = mod.coverage.Properties.NeedCoverageBuild
Ivan Lozanoffee3342019-08-27 12:03:00 -0700638}
639
640func defaultsFactory() android.Module {
641 return DefaultsFactory()
642}
643
644type Defaults struct {
645 android.ModuleBase
646 android.DefaultsModuleBase
647}
648
649func DefaultsFactory(props ...interface{}) android.Module {
650 module := &Defaults{}
651
652 module.AddProperties(props...)
653 module.AddProperties(
654 &BaseProperties{},
Yi Kong46c6e592022-01-20 22:55:00 +0800655 &cc.AfdoProperties{},
Ivan Lozano6a884432020-12-02 09:15:16 -0500656 &cc.VendorProperties{},
Jakub Kotur1d640d02021-01-06 12:40:43 +0100657 &BenchmarkProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400658 &BindgenProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700659 &BaseCompilerProperties{},
660 &BinaryCompilerProperties{},
661 &LibraryCompilerProperties{},
662 &ProcMacroCompilerProperties{},
663 &PrebuiltProperties{},
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400664 &SourceProviderProperties{},
Chih-Hung Hsieh41805be2019-10-31 20:56:47 -0700665 &TestProperties{},
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400666 &cc.CoverageProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400667 &cc.RustBindgenClangProperties{},
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200668 &ClippyProperties{},
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500669 &SanitizeProperties{},
Pawan Waghccb75582023-08-16 23:58:25 +0000670 &fuzz.FuzzProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700671 )
672
673 android.InitDefaultsModule(module)
674 return module
675}
676
677func (mod *Module) CrateName() string {
Ivan Lozanoad8b18b2019-10-31 19:38:29 -0700678 return mod.compiler.crateName()
Ivan Lozanoffee3342019-08-27 12:03:00 -0700679}
680
Ivan Lozano183a3212019-10-18 14:18:45 -0700681func (mod *Module) CcLibrary() bool {
682 if mod.compiler != nil {
Ivan Lozano45e0e5b2021-11-13 07:42:36 -0500683 if _, ok := mod.compiler.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -0700684 return true
685 }
686 }
687 return false
688}
689
690func (mod *Module) CcLibraryInterface() bool {
691 if mod.compiler != nil {
Ivan Lozano89435d12020-07-31 11:01:18 -0400692 // use build{Static,Shared}() instead of {static,shared}() here because this might be called before
693 // VariantIs{Static,Shared} is set.
Ivan Lozano806efd32024-12-11 21:38:53 +0000694 if lib, ok := mod.compiler.(libraryInterface); ok && (lib.buildShared() || lib.buildStatic() || lib.buildRlib()) {
Ivan Lozano183a3212019-10-18 14:18:45 -0700695 return true
696 }
697 }
698 return false
699}
700
Ivan Lozano61c02cc2023-06-09 14:06:44 -0400701func (mod *Module) RustLibraryInterface() bool {
702 if mod.compiler != nil {
703 if _, ok := mod.compiler.(libraryInterface); ok {
704 return true
705 }
706 }
707 return false
708}
709
Ivan Lozano0f9963e2023-02-06 13:31:02 -0500710func (mod *Module) IsFuzzModule() bool {
711 if _, ok := mod.compiler.(*fuzzDecorator); ok {
712 return true
713 }
714 return false
715}
716
717func (mod *Module) FuzzModuleStruct() fuzz.FuzzModule {
718 return mod.FuzzModule
719}
720
721func (mod *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
722 if fuzzer, ok := mod.compiler.(*fuzzDecorator); ok {
723 return fuzzer.fuzzPackagedModule
724 }
725 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", mod.BaseModuleName()))
726}
727
Hamzeh Zawawy38917492023-04-05 22:08:46 +0000728func (mod *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -0500729 if fuzzer, ok := mod.compiler.(*fuzzDecorator); ok {
730 return fuzzer.sharedLibraries
731 }
732 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", mod.BaseModuleName()))
733}
734
Ivan Lozano39b0bf02021-10-14 12:22:09 -0400735func (mod *Module) UnstrippedOutputFile() android.Path {
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400736 if mod.compiler != nil {
737 return mod.compiler.unstrippedOutputFilePath()
Ivan Lozano39b0bf02021-10-14 12:22:09 -0400738 }
739 return nil
740}
741
Ivan Lozano183a3212019-10-18 14:18:45 -0700742func (mod *Module) SetStatic() {
743 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700744 if library, ok := mod.compiler.(libraryInterface); ok {
745 library.setStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700746 return
747 }
748 }
749 panic(fmt.Errorf("SetStatic called on non-library module: %q", mod.BaseModuleName()))
750}
751
752func (mod *Module) SetShared() {
753 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700754 if library, ok := mod.compiler.(libraryInterface); ok {
755 library.setShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700756 return
757 }
758 }
759 panic(fmt.Errorf("SetShared called on non-library module: %q", mod.BaseModuleName()))
760}
761
Ivan Lozano183a3212019-10-18 14:18:45 -0700762func (mod *Module) BuildStaticVariant() bool {
763 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700764 if library, ok := mod.compiler.(libraryInterface); ok {
765 return library.buildStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700766 }
767 }
768 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", mod.BaseModuleName()))
769}
770
Ivan Lozanofd47b1a2024-05-17 14:13:41 -0400771func (mod *Module) BuildRlibVariant() bool {
772 if mod.compiler != nil {
773 if library, ok := mod.compiler.(libraryInterface); ok {
774 return library.buildRlib()
775 }
776 }
777 panic(fmt.Errorf("BuildRlibVariant called on non-library module: %q", mod.BaseModuleName()))
778}
779
Ivan Lozano183a3212019-10-18 14:18:45 -0700780func (mod *Module) BuildSharedVariant() bool {
781 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700782 if library, ok := mod.compiler.(libraryInterface); ok {
783 return library.buildShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700784 }
785 }
786 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", mod.BaseModuleName()))
787}
788
Ivan Lozano183a3212019-10-18 14:18:45 -0700789func (mod *Module) Module() android.Module {
790 return mod
791}
792
Ivan Lozano183a3212019-10-18 14:18:45 -0700793func (mod *Module) OutputFile() android.OptionalPath {
Ivan Lozano8d10fc32021-11-05 16:36:47 -0400794 return mod.outputFile
Ivan Lozano183a3212019-10-18 14:18:45 -0700795}
796
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400797func (mod *Module) CoverageFiles() android.Paths {
798 if mod.compiler != nil {
Joel Galensonfa049382021-01-14 16:03:18 -0800799 return android.Paths{}
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400800 }
801 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", mod.BaseModuleName()))
802}
803
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400804// Rust does not produce gcno files, and therefore does not produce a coverage archive.
805func (mod *Module) CoverageOutputFile() android.OptionalPath {
806 return android.OptionalPath{}
807}
808
809func (mod *Module) IsNdk(config android.Config) bool {
810 return false
811}
812
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000813func (mod *Module) IsStubs() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000814 if lib, ok := mod.compiler.(libraryInterface); ok {
815 return lib.BuildStubs()
816 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000817 return false
818}
819
Spandan Das10c41362024-12-03 01:33:09 +0000820func (mod *Module) HasStubsVariants() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000821 if lib, ok := mod.compiler.(libraryInterface); ok {
822 return lib.HasStubsVariants()
823 }
Spandan Das10c41362024-12-03 01:33:09 +0000824 return false
825}
826
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000827func (mod *Module) ApexSdkVersion() android.ApiLevel {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000828 return mod.apexSdkVersion
829}
830
831func (mod *Module) RustApexExclude() bool {
832 return mod.ApexExclude()
833}
834
835func (mod *Module) getSharedFlags() *cc.SharedFlags {
836 shared := &mod.sharedFlags
837 if shared.FlagsMap == nil {
838 shared.NumSharedFlags = 0
839 shared.FlagsMap = make(map[string]string)
840 }
841 return shared
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000842}
843
844func (mod *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000845 name := mod.BaseModuleName()
846 if versioned, ok := mod.compiler.(cc.VersionedInterface); ok {
847 name = versioned.ImplementationModuleName(name)
848 }
849 return name
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000850}
851
852func (mod *Module) Multilib() string {
853 return mod.Arch().ArchType.Multilib
854}
855
856func (mod *Module) IsCrt() bool {
857 // Rust does not currently provide any crt modules.
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400858 return false
859}
860
Jiyong Park459feca2020-12-15 11:02:21 +0900861func (mod *Module) installable(apexInfo android.ApexInfo) bool {
Jiyong Park2811e072021-09-30 17:25:21 +0900862 if !proptools.BoolDefault(mod.Installable(), mod.EverInstallable()) {
Jiyong Parkbf8147a2021-05-17 13:19:33 +0900863 return false
864 }
865
Jiyong Park459feca2020-12-15 11:02:21 +0900866 // The apex variant is not installable because it is included in the APEX and won't appear
867 // in the system partition as a standalone file.
868 if !apexInfo.IsForPlatform() {
869 return false
870 }
871
Jiyong Parke54f07e2021-04-07 15:08:04 +0900872 return mod.OutputFile().Valid() && !mod.Properties.PreventInstall
Jiyong Park459feca2020-12-15 11:02:21 +0900873}
874
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500875func (ctx moduleContext) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -0800876 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
877 return apexInfo.ApexVariationName
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500878}
879
Ivan Lozano183a3212019-10-18 14:18:45 -0700880var _ cc.LinkableInterface = (*Module)(nil)
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000881var _ cc.VersionedLinkableInterface = (*Module)(nil)
Ivan Lozano183a3212019-10-18 14:18:45 -0700882
Ivan Lozanoffee3342019-08-27 12:03:00 -0700883func (mod *Module) Init() android.Module {
884 mod.AddProperties(&mod.Properties)
Ivan Lozano6a884432020-12-02 09:15:16 -0500885 mod.AddProperties(&mod.VendorProperties)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700886
Yi Kong46c6e592022-01-20 22:55:00 +0800887 if mod.afdo != nil {
888 mod.AddProperties(mod.afdo.props()...)
889 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700890 if mod.compiler != nil {
891 mod.AddProperties(mod.compiler.compilerProps()...)
892 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400893 if mod.coverage != nil {
894 mod.AddProperties(mod.coverage.props()...)
895 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200896 if mod.clippy != nil {
897 mod.AddProperties(mod.clippy.props()...)
898 }
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400899 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -0700900 mod.AddProperties(mod.sourceProvider.SourceProviderProps()...)
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400901 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500902 if mod.sanitize != nil {
903 mod.AddProperties(mod.sanitize.props()...)
904 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400905
Ivan Lozanoffee3342019-08-27 12:03:00 -0700906 android.InitAndroidArchModule(mod, mod.hod, mod.multilib)
Jiyong Park99644e92020-11-17 22:21:02 +0900907 android.InitApexModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700908
909 android.InitDefaultableModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700910 return mod
911}
912
913func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
914 return &Module{
915 hod: hod,
916 multilib: multilib,
917 }
918}
919func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
920 module := newBaseModule(hod, multilib)
Yi Kong46c6e592022-01-20 22:55:00 +0800921 module.afdo = &afdo{}
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400922 module.coverage = &coverage{}
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200923 module.clippy = &clippy{}
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500924 module.sanitize = &sanitize{}
Ivan Lozanoffee3342019-08-27 12:03:00 -0700925 return module
926}
927
928type ModuleContext interface {
929 android.ModuleContext
930 ModuleContextIntf
931}
932
933type BaseModuleContext interface {
934 android.BaseModuleContext
935 ModuleContextIntf
936}
937
938type DepsContext interface {
939 android.BottomUpMutatorContext
940 ModuleContextIntf
941}
942
943type ModuleContextIntf interface {
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200944 RustModule() *Module
Ivan Lozanoffee3342019-08-27 12:03:00 -0700945 toolchain() config.Toolchain
Ivan Lozanoffee3342019-08-27 12:03:00 -0700946}
947
948type depsContext struct {
949 android.BottomUpMutatorContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700950}
951
952type moduleContext struct {
953 android.ModuleContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700954}
955
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200956type baseModuleContext struct {
957 android.BaseModuleContext
958}
959
960func (ctx *moduleContext) RustModule() *Module {
961 return ctx.Module().(*Module)
962}
963
964func (ctx *moduleContext) toolchain() config.Toolchain {
965 return ctx.RustModule().toolchain(ctx)
966}
967
968func (ctx *depsContext) RustModule() *Module {
969 return ctx.Module().(*Module)
970}
971
972func (ctx *depsContext) toolchain() config.Toolchain {
973 return ctx.RustModule().toolchain(ctx)
974}
975
976func (ctx *baseModuleContext) RustModule() *Module {
977 return ctx.Module().(*Module)
978}
979
980func (ctx *baseModuleContext) toolchain() config.Toolchain {
981 return ctx.RustModule().toolchain(ctx)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400982}
983
984func (mod *Module) nativeCoverage() bool {
Matthew Maurera61e31f2021-05-27 11:09:11 -0700985 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
986 if mod.Target().NativeBridge == android.NativeBridgeEnabled {
987 return false
988 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400989 return mod.compiler != nil && mod.compiler.nativeCoverage()
990}
991
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000992func (mod *Module) SetStl(s string) {
993 // STL is a CC concept; do nothing for Rust
994}
995
996func (mod *Module) SetSdkVersion(s string) {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000997 mod.Properties.Sdk_version = StringPtr(s)
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000998}
999
1000func (mod *Module) SetMinSdkVersion(s string) {
1001 mod.Properties.Min_sdk_version = StringPtr(s)
1002}
1003
1004func (mod *Module) VersionedInterface() cc.VersionedInterface {
1005 if _, ok := mod.compiler.(cc.VersionedInterface); ok {
1006 return mod.compiler.(cc.VersionedInterface)
1007 }
1008 return nil
1009}
1010
Ivan Lozanod7586b62021-04-01 09:49:36 -04001011func (mod *Module) EverInstallable() bool {
1012 return mod.compiler != nil &&
1013 // Check to see whether the module is actually ever installable.
1014 mod.compiler.everInstallable()
1015}
1016
1017func (mod *Module) Installable() *bool {
1018 return mod.Properties.Installable
1019}
1020
Ivan Lozano872d5792022-03-23 17:31:39 -04001021func (mod *Module) ProcMacro() bool {
1022 if pm, ok := mod.compiler.(procMacroInterface); ok {
1023 return pm.ProcMacro()
1024 }
1025 return false
1026}
1027
Ivan Lozanoffee3342019-08-27 12:03:00 -07001028func (mod *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
1029 if mod.cachedToolchain == nil {
1030 mod.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
1031 }
1032 return mod.cachedToolchain
1033}
1034
Thiébaud Weksteen31f1bb82020-08-27 13:37:29 +02001035func (mod *Module) ccToolchain(ctx android.BaseModuleContext) cc_config.Toolchain {
1036 return cc_config.FindToolchain(ctx.Os(), ctx.Arch())
1037}
1038
Ivan Lozanoffee3342019-08-27 12:03:00 -07001039func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1040}
1041
1042func (mod *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
1043 ctx := &moduleContext{
1044 ModuleContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -07001045 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001046
Colin Crossff694a82023-12-13 15:54:49 -08001047 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Jiyong Park99644e92020-11-17 22:21:02 +09001048 if !apexInfo.IsForPlatform() {
1049 mod.hideApexVariantFromMake = true
1050 }
1051
Ivan Lozanoffee3342019-08-27 12:03:00 -07001052 toolchain := mod.toolchain(ctx)
Ivan Lozano6a884432020-12-02 09:15:16 -05001053 mod.makeLinkType = cc.GetMakeLinkType(actx, mod)
1054
Ivan Lozanof1868af2022-04-12 13:08:36 -04001055 mod.Properties.SubName = cc.GetSubnameProperty(actx, mod)
Matthew Maurera61e31f2021-05-27 11:09:11 -07001056
Ivan Lozanoffee3342019-08-27 12:03:00 -07001057 if !toolchain.Supported() {
1058 // This toolchain's unsupported, there's nothing to do for this mod.
1059 return
1060 }
1061
1062 deps := mod.depsToPaths(ctx)
Ivan Lozano0a468a42024-05-13 21:03:34 -04001063 // Export linkDirs for CC rust generatedlibs
1064 mod.exportedLinkDirs = append(mod.exportedLinkDirs, deps.exportedLinkDirs...)
1065 mod.exportedLinkDirs = append(mod.exportedLinkDirs, deps.linkDirs...)
1066
Ivan Lozanoffee3342019-08-27 12:03:00 -07001067 flags := Flags{
1068 Toolchain: toolchain,
1069 }
1070
Ivan Lozano67eada32021-09-23 11:50:33 -04001071 // Calculate rustc flags
Yi Kong46c6e592022-01-20 22:55:00 +08001072 if mod.afdo != nil {
Vinh Trancde10162023-03-09 22:07:19 -05001073 flags, deps = mod.afdo.flags(actx, flags, deps)
Yi Kong46c6e592022-01-20 22:55:00 +08001074 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001075 if mod.compiler != nil {
1076 flags = mod.compiler.compilerFlags(ctx, flags)
Ivan Lozano67eada32021-09-23 11:50:33 -04001077 flags = mod.compiler.cfgFlags(ctx, flags)
Jihoon Kang091ffd82024-10-03 01:13:24 +00001078 flags = mod.compiler.featureFlags(ctx, mod, flags)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001079 }
1080 if mod.coverage != nil {
1081 flags, deps = mod.coverage.flags(ctx, flags, deps)
1082 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +02001083 if mod.clippy != nil {
1084 flags, deps = mod.clippy.flags(ctx, flags, deps)
1085 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -05001086 if mod.sanitize != nil {
1087 flags, deps = mod.sanitize.flags(ctx, flags, deps)
1088 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001089
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001090 // SourceProvider needs to call GenerateSource() before compiler calls
1091 // compile() so it can provide the source. A SourceProvider has
1092 // multiple variants (e.g. source, rlib, dylib). Only the "source"
1093 // variant is responsible for effectively generating the source. The
1094 // remaining variants relies on the "source" variant output.
Ivan Lozano26ecd6c2020-07-31 13:40:31 -04001095 if mod.sourceProvider != nil {
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001096 if mod.compiler.(libraryInterface).source() {
1097 mod.sourceProvider.GenerateSource(ctx, deps)
1098 mod.sourceProvider.setSubName(ctx.ModuleSubDir())
1099 } else {
Yu Liu727204c2025-01-23 20:58:32 +00001100 sourceMod := actx.GetDirectDepProxyWithTag(mod.Name(), sourceDepTag)
1101 sourceLib := android.OtherModuleProviderOrDefault(ctx, sourceMod, RustInfoProvider).SourceProviderInfo
1102 mod.sourceProvider.setOutputFiles(sourceLib.Srcs)
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001103 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001104 ctx.CheckbuildFile(mod.sourceProvider.Srcs()...)
Ivan Lozano26ecd6c2020-07-31 13:40:31 -04001105 }
1106
1107 if mod.compiler != nil && !mod.compiler.Disabled() {
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +01001108 mod.compiler.initialize(ctx)
Sasha Smundaka76acba2022-04-18 20:12:56 -07001109 buildOutput := mod.compiler.compile(ctx, flags, deps)
Ivan Lozano8d10fc32021-11-05 16:36:47 -04001110 if ctx.Failed() {
1111 return
1112 }
Sasha Smundaka76acba2022-04-18 20:12:56 -07001113 mod.outputFile = android.OptionalPathForPath(buildOutput.outputFile)
Colin Crossa6182ab2024-08-21 10:47:44 -07001114 ctx.CheckbuildFile(buildOutput.outputFile)
Sasha Smundaka76acba2022-04-18 20:12:56 -07001115 if buildOutput.kytheFile != nil {
1116 mod.kytheFiles = append(mod.kytheFiles, buildOutput.kytheFile)
1117 }
Ivan Lozano8d10fc32021-11-05 16:36:47 -04001118 bloaty.MeasureSizeForPaths(ctx, mod.compiler.strippedOutputFilePath(), android.OptionalPathForPath(mod.compiler.unstrippedOutputFilePath()))
Jiyong Park459feca2020-12-15 11:02:21 +09001119
Dan Albert06feee92021-03-19 15:06:02 -07001120 mod.docTimestampFile = mod.compiler.rustdoc(ctx, flags, deps)
1121
Colin Crossff694a82023-12-13 15:54:49 -08001122 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Ivan Lozano872d5792022-03-23 17:31:39 -04001123 if !proptools.BoolDefault(mod.Installable(), mod.EverInstallable()) && !mod.ProcMacro() {
Jiyong Parkd1e366a2021-10-05 09:12:41 +09001124 // If the module has been specifically configure to not be installed then
1125 // hide from make as otherwise it will break when running inside make as the
1126 // output path to install will not be specified. Not all uninstallable
1127 // modules can be hidden from make as some are needed for resolving make
Ivan Lozano872d5792022-03-23 17:31:39 -04001128 // side dependencies. In particular, proc-macros need to be captured in the
1129 // host snapshot.
Jiyong Parkd1e366a2021-10-05 09:12:41 +09001130 mod.HideFromMake()
Spandan Das034af2c2024-10-30 21:45:09 +00001131 mod.SkipInstall()
Jiyong Parkd1e366a2021-10-05 09:12:41 +09001132 } else if !mod.installable(apexInfo) {
1133 mod.SkipInstall()
1134 }
1135
1136 // Still call install though, the installs will be stored as PackageSpecs to allow
1137 // using the outputs in a genrule.
1138 if mod.OutputFile().Valid() {
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +02001139 mod.compiler.install(ctx)
Jiyong Parkd1e366a2021-10-05 09:12:41 +09001140 if ctx.Failed() {
1141 return
1142 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04001143 // Export your own directory as a linkDir
1144 mod.exportedLinkDirs = append(mod.exportedLinkDirs, linkPathFromFilePath(mod.OutputFile().Path()))
1145
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001146 }
Chris Wailes74be7642021-07-22 16:20:28 -07001147
Colin Crossb614cd42024-10-11 12:52:21 -07001148 android.SetProvider(ctx, cc.ImplementationDepInfoProvider, &cc.ImplementationDepInfo{
1149 ImplementationDeps: depset.New(depset.PREORDER, deps.directImplementationDeps, deps.transitiveImplementationDeps),
1150 })
1151
Chris Wailes74be7642021-07-22 16:20:28 -07001152 ctx.Phony("rust", ctx.RustModule().OutputFile().Path())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001153 }
Wei Lia1aa2972024-06-21 13:08:51 -07001154
Yu Liuf6f85492025-01-13 21:02:36 +00001155 linkableInfo := cc.CreateCommonLinkableInfo(ctx, mod)
Yu Liu8024b922024-12-20 23:31:32 +00001156 linkableInfo.Static = mod.Static()
1157 linkableInfo.Shared = mod.Shared()
1158 linkableInfo.CrateName = mod.CrateName()
1159 linkableInfo.ExportedCrateLinkDirs = mod.ExportedCrateLinkDirs()
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00001160 if lib, ok := mod.compiler.(cc.VersionedInterface); ok {
1161 linkableInfo.StubsVersion = lib.StubsVersion()
1162 }
1163
Yu Liu8024b922024-12-20 23:31:32 +00001164 android.SetProvider(ctx, cc.LinkableInfoProvider, linkableInfo)
1165
1166 rustInfo := &RustInfo{
1167 AndroidMkSuffix: mod.AndroidMkSuffix(),
1168 RustSubName: mod.Properties.RustSubName,
1169 TransitiveAndroidMkSharedLibs: mod.transitiveAndroidMkSharedLibs,
1170 }
1171 if mod.compiler != nil {
1172 rustInfo.CompilerInfo = &CompilerInfo{
1173 NoStdlibs: mod.compiler.noStdlibs(),
1174 StdLinkageForDevice: mod.compiler.stdLinkage(true),
1175 StdLinkageForNonDevice: mod.compiler.stdLinkage(false),
1176 }
1177 if lib, ok := mod.compiler.(libraryInterface); ok {
1178 rustInfo.CompilerInfo.LibraryInfo = &LibraryInfo{
1179 Dylib: lib.dylib(),
1180 Rlib: lib.rlib(),
1181 }
1182 }
1183 if lib, ok := mod.compiler.(cc.SnapshotInterface); ok {
1184 rustInfo.SnapshotInfo = &cc.SnapshotInfo{
1185 SnapshotAndroidMkSuffix: lib.SnapshotAndroidMkSuffix(),
1186 }
1187 }
1188 }
1189 if mod.sourceProvider != nil {
Yu Liu727204c2025-01-23 20:58:32 +00001190 rustInfo.SourceProviderInfo = &SourceProviderInfo{
1191 Srcs: mod.sourceProvider.Srcs(),
1192 }
Yu Liu8024b922024-12-20 23:31:32 +00001193 if _, ok := mod.sourceProvider.(*protobufDecorator); ok {
Yu Liu727204c2025-01-23 20:58:32 +00001194 rustInfo.SourceProviderInfo.ProtobufDecoratorInfo = &ProtobufDecoratorInfo{}
Yu Liu8024b922024-12-20 23:31:32 +00001195 }
1196 }
1197 android.SetProvider(ctx, RustInfoProvider, rustInfo)
Yu Liu986d98c2024-11-12 00:28:11 +00001198
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001199 ccInfo := &cc.CcInfo{
1200 IsPrebuilt: mod.IsPrebuilt(),
1201 }
1202
Ivan Lozano9587f452025-01-08 03:17:19 +00001203 // Define the linker info if compiler != nil because Rust currently
1204 // does compilation and linking in one step. If this changes in the future,
1205 // move this as appropriate.
Cole Faustc9b88c92025-02-06 17:58:26 -08001206 baseCompilerProps := mod.compiler.baseCompilerProps()
Ivan Lozano9587f452025-01-08 03:17:19 +00001207 ccInfo.LinkerInfo = &cc.LinkerInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08001208 WholeStaticLibs: baseCompilerProps.Whole_static_libs.GetOrDefault(ctx, nil),
1209 StaticLibs: baseCompilerProps.Static_libs.GetOrDefault(ctx, nil),
1210 SharedLibs: baseCompilerProps.Shared_libs.GetOrDefault(ctx, nil),
Ivan Lozano9587f452025-01-08 03:17:19 +00001211 }
1212
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001213 android.SetProvider(ctx, cc.CcInfoProvider, ccInfo)
1214
mrziwang0cbd3b02024-06-20 16:39:25 -07001215 mod.setOutputFiles(ctx)
Wei Lia1aa2972024-06-21 13:08:51 -07001216
1217 buildComplianceMetadataInfo(ctx, mod, deps)
Cole Faust58eef4f2025-01-29 15:14:17 -08001218
1219 moduleInfoJSON := ctx.ModuleInfoJSON()
1220 if mod.compiler != nil {
1221 mod.compiler.moduleInfoJSON(ctx, moduleInfoJSON)
1222 }
mrziwang0cbd3b02024-06-20 16:39:25 -07001223}
1224
1225func (mod *Module) setOutputFiles(ctx ModuleContext) {
1226 if mod.sourceProvider != nil && (mod.compiler == nil || mod.compiler.Disabled()) {
1227 ctx.SetOutputFiles(mod.sourceProvider.Srcs(), "")
1228 } else if mod.OutputFile().Valid() {
1229 ctx.SetOutputFiles(android.Paths{mod.OutputFile().Path()}, "")
1230 } else {
1231 ctx.SetOutputFiles(android.Paths{}, "")
1232 }
1233 if mod.compiler != nil {
1234 ctx.SetOutputFiles(android.PathsIfNonNil(mod.compiler.unstrippedOutputFilePath()), "unstripped")
1235 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001236}
1237
Wei Lia1aa2972024-06-21 13:08:51 -07001238func buildComplianceMetadataInfo(ctx *moduleContext, mod *Module, deps PathDeps) {
1239 // Dump metadata that can not be done in android/compliance-metadata.go
1240 metadataInfo := ctx.ComplianceMetadataInfo()
1241 metadataInfo.SetStringValue(android.ComplianceMetadataProp.IS_STATIC_LIB, strconv.FormatBool(mod.Static()))
1242 metadataInfo.SetStringValue(android.ComplianceMetadataProp.BUILT_FILES, mod.outputFile.String())
1243
1244 // Static libs
Yu Liu727204c2025-01-23 20:58:32 +00001245 staticDeps := ctx.GetDirectDepsProxyWithTag(rlibDepTag)
Wei Lia1aa2972024-06-21 13:08:51 -07001246 staticDepNames := make([]string, 0, len(staticDeps))
1247 for _, dep := range staticDeps {
1248 staticDepNames = append(staticDepNames, dep.Name())
1249 }
Yu Liu727204c2025-01-23 20:58:32 +00001250 ccStaticDeps := ctx.GetDirectDepsProxyWithTag(cc.StaticDepTag(false))
Wei Lia1aa2972024-06-21 13:08:51 -07001251 for _, dep := range ccStaticDeps {
1252 staticDepNames = append(staticDepNames, dep.Name())
1253 }
1254
1255 staticDepPaths := make([]string, 0, len(deps.StaticLibs)+len(deps.RLibs))
1256 // C static libraries
1257 for _, dep := range deps.StaticLibs {
1258 staticDepPaths = append(staticDepPaths, dep.String())
1259 }
1260 // Rust static libraries
1261 for _, dep := range deps.RLibs {
1262 staticDepPaths = append(staticDepPaths, dep.Path.String())
1263 }
1264 metadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
1265 metadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEP_FILES, android.FirstUniqueStrings(staticDepPaths))
1266
1267 // C Whole static libs
Yu Liu727204c2025-01-23 20:58:32 +00001268 ccWholeStaticDeps := ctx.GetDirectDepsProxyWithTag(cc.StaticDepTag(true))
Wei Lia1aa2972024-06-21 13:08:51 -07001269 wholeStaticDepNames := make([]string, 0, len(ccWholeStaticDeps))
1270 for _, dep := range ccStaticDeps {
1271 wholeStaticDepNames = append(wholeStaticDepNames, dep.Name())
1272 }
1273 metadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
1274}
1275
Ivan Lozanoffee3342019-08-27 12:03:00 -07001276func (mod *Module) deps(ctx DepsContext) Deps {
1277 deps := Deps{}
1278
1279 if mod.compiler != nil {
1280 deps = mod.compiler.compilerDeps(ctx, deps)
Ivan Lozano26ecd6c2020-07-31 13:40:31 -04001281 }
1282 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -07001283 deps = mod.sourceProvider.SourceProviderDeps(ctx, deps)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001284 }
1285
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001286 if mod.coverage != nil {
1287 deps = mod.coverage.deps(ctx, deps)
1288 }
1289
Ivan Lozano6cd99e62020-02-11 08:24:25 -05001290 if mod.sanitize != nil {
1291 deps = mod.sanitize.deps(ctx, deps)
1292 }
1293
Ivan Lozanoffee3342019-08-27 12:03:00 -07001294 deps.Rlibs = android.LastUniqueStrings(deps.Rlibs)
1295 deps.Dylibs = android.LastUniqueStrings(deps.Dylibs)
Matthew Maurer0f003b12020-06-29 14:34:06 -07001296 deps.Rustlibs = android.LastUniqueStrings(deps.Rustlibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001297 deps.ProcMacros = android.LastUniqueStrings(deps.ProcMacros)
1298 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
1299 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
Andrew Walbran797e4be2022-03-07 15:41:53 +00001300 deps.Stdlibs = android.LastUniqueStrings(deps.Stdlibs)
Ivan Lozano63bb7682021-03-23 15:53:44 -04001301 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001302 return deps
1303
1304}
1305
Ivan Lozanoffee3342019-08-27 12:03:00 -07001306type dependencyTag struct {
1307 blueprint.BaseDependencyTag
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001308 name string
1309 library bool
1310 procMacro bool
Colin Cross65cb3142021-12-10 23:05:02 +00001311 dynamic bool
Ivan Lozanoffee3342019-08-27 12:03:00 -07001312}
1313
Jiyong Park65b62242020-11-25 12:44:59 +09001314// InstallDepNeeded returns true for rlibs, dylibs, and proc macros so that they or their transitive
1315// dependencies (especially C/C++ shared libs) are installed as dependencies of a rust binary.
1316func (d dependencyTag) InstallDepNeeded() bool {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001317 return d.library || d.procMacro
Jiyong Park65b62242020-11-25 12:44:59 +09001318}
1319
1320var _ android.InstallNeededDependencyTag = dependencyTag{}
1321
Colin Cross65cb3142021-12-10 23:05:02 +00001322func (d dependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
1323 if d.library && d.dynamic {
1324 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
1325 }
1326 return nil
1327}
1328
Yu Liuc8884602024-03-15 18:48:38 +00001329func (d dependencyTag) PropagateAconfigValidation() bool {
1330 return d == rlibDepTag || d == sourceDepTag
1331}
1332
1333var _ android.PropagateAconfigValidationDependencyTag = dependencyTag{}
1334
Colin Cross65cb3142021-12-10 23:05:02 +00001335var _ android.LicenseAnnotationsDependencyTag = dependencyTag{}
1336
Ivan Lozanoffee3342019-08-27 12:03:00 -07001337var (
Ivan Lozanoc564d2d2020-08-04 15:43:37 -04001338 customBindgenDepTag = dependencyTag{name: "customBindgenTag"}
1339 rlibDepTag = dependencyTag{name: "rlibTag", library: true}
Colin Cross65cb3142021-12-10 23:05:02 +00001340 dylibDepTag = dependencyTag{name: "dylib", library: true, dynamic: true}
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001341 procMacroDepTag = dependencyTag{name: "procMacro", procMacro: true}
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001342 sourceDepTag = dependencyTag{name: "source"}
Ivan Lozano4e5f07d2021-11-04 14:09:38 -04001343 dataLibDepTag = dependencyTag{name: "data lib"}
1344 dataBinDepTag = dependencyTag{name: "data bin"}
Ivan Lozanoffee3342019-08-27 12:03:00 -07001345)
1346
Jiyong Park99644e92020-11-17 22:21:02 +09001347func IsDylibDepTag(depTag blueprint.DependencyTag) bool {
1348 tag, ok := depTag.(dependencyTag)
1349 return ok && tag == dylibDepTag
1350}
1351
Jiyong Park94e22fd2021-04-08 18:19:15 +09001352func IsRlibDepTag(depTag blueprint.DependencyTag) bool {
1353 tag, ok := depTag.(dependencyTag)
1354 return ok && tag == rlibDepTag
1355}
1356
Matthew Maurer0f003b12020-06-29 14:34:06 -07001357type autoDep struct {
1358 variation string
1359 depTag dependencyTag
1360}
1361
1362var (
Colin Cross8a49a3d2024-05-20 12:22:27 -07001363 sourceVariation = "source"
1364 rlibVariation = "rlib"
1365 dylibVariation = "dylib"
1366 rlibAutoDep = autoDep{variation: rlibVariation, depTag: rlibDepTag}
1367 dylibAutoDep = autoDep{variation: dylibVariation, depTag: dylibDepTag}
Matthew Maurer0f003b12020-06-29 14:34:06 -07001368)
1369
1370type autoDeppable interface {
Liz Kammer356f7d42021-01-26 09:18:53 -05001371 autoDep(ctx android.BottomUpMutatorContext) autoDep
Matthew Maurer0f003b12020-06-29 14:34:06 -07001372}
1373
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001374func (mod *Module) begin(ctx BaseModuleContext) {
1375 if mod.coverage != nil {
1376 mod.coverage.begin(ctx)
1377 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -05001378 if mod.sanitize != nil {
1379 mod.sanitize.begin(ctx)
1380 }
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00001381
1382 if mod.UseSdk() && mod.IsSdkVariant() {
1383 sdkVersion := ""
1384 if ctx.Device() {
1385 sdkVersion = mod.SdkVersion()
1386 }
1387 version, err := cc.NativeApiLevelFromUser(ctx, sdkVersion)
1388 if err != nil {
1389 ctx.PropertyErrorf("sdk_version", err.Error())
1390 mod.Properties.Sdk_version = nil
1391 } else {
1392 mod.Properties.Sdk_version = StringPtr(version.String())
1393 }
1394 }
1395
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001396}
1397
Ivan Lozanofba2aa22021-11-11 09:29:07 -05001398func (mod *Module) Prebuilt() *android.Prebuilt {
Ivan Lozano872d5792022-03-23 17:31:39 -04001399 if p, ok := mod.compiler.(rustPrebuilt); ok {
Ivan Lozanofba2aa22021-11-11 09:29:07 -05001400 return p.prebuilt()
1401 }
1402 return nil
1403}
1404
Kiyoung Kim37693d02024-04-04 09:56:15 +09001405func (mod *Module) Symlinks() []string {
1406 // TODO update this to return the list of symlinks when Rust supports defining symlinks
1407 return nil
1408}
1409
Yu Liu8024b922024-12-20 23:31:32 +00001410func rustMakeLibName(rustInfo *RustInfo, linkableInfo *cc.LinkableInfo, commonInfo *android.CommonModuleInfo, depName string) string {
1411 if rustInfo != nil {
Justin Yun24b246a2023-03-16 10:36:16 +09001412 // Use base module name for snapshots when exporting to Makefile.
Yu Liu8024b922024-12-20 23:31:32 +00001413 if rustInfo.SnapshotInfo != nil {
1414 baseName := linkableInfo.BaseModuleName
1415 return baseName + rustInfo.SnapshotInfo.SnapshotAndroidMkSuffix + rustInfo.AndroidMkSuffix
Justin Yun24b246a2023-03-16 10:36:16 +09001416 }
1417 }
Yu Liu8024b922024-12-20 23:31:32 +00001418 return cc.MakeLibName(nil, linkableInfo, commonInfo, depName)
Justin Yun24b246a2023-03-16 10:36:16 +09001419}
1420
Yu Liu8024b922024-12-20 23:31:32 +00001421func collectIncludedProtos(mod *Module, rustInfo *RustInfo, linkableInfo *cc.LinkableInfo) {
Ivan Lozanod106efe2023-09-21 23:30:26 -04001422 if protoMod, ok := mod.sourceProvider.(*protobufDecorator); ok {
Yu Liu8024b922024-12-20 23:31:32 +00001423 if rustInfo.SourceProviderInfo.ProtobufDecoratorInfo != nil {
1424 protoMod.additionalCrates = append(protoMod.additionalCrates, linkableInfo.CrateName)
Ivan Lozanod106efe2023-09-21 23:30:26 -04001425 }
1426 }
1427}
Andrew Walbran52533232024-03-19 11:36:04 +00001428
Ivan Lozanoffee3342019-08-27 12:03:00 -07001429func (mod *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
1430 var depPaths PathDeps
1431
Yu Liu8024b922024-12-20 23:31:32 +00001432 directRlibDeps := []*cc.LinkableInfo{}
1433 directDylibDeps := []*cc.LinkableInfo{}
1434 directProcMacroDeps := []*cc.LinkableInfo{}
Jiyong Park7d55b612021-06-11 17:22:09 +09001435 directSharedLibDeps := []cc.SharedLibraryInfo{}
Yu Liu8024b922024-12-20 23:31:32 +00001436 directStaticLibDeps := [](*cc.LinkableInfo){}
1437 directSrcProvidersDeps := []*android.ModuleProxy{}
1438 directSrcDeps := []android.SourceFilesInfo{}
Ivan Lozanoffee3342019-08-27 12:03:00 -07001439
Ivan Lozanoe950cda2021-11-09 11:26:04 -05001440 // For the dependency from platform to apex, use the latest stubs
1441 mod.apexSdkVersion = android.FutureApiLevel
Colin Crossff694a82023-12-13 15:54:49 -08001442 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Ivan Lozanoe950cda2021-11-09 11:26:04 -05001443 if !apexInfo.IsForPlatform() {
1444 mod.apexSdkVersion = apexInfo.MinSdkVersion
1445 }
1446
1447 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
1448 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
1449 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
1450 // (b/144430859)
1451 mod.apexSdkVersion = android.FutureApiLevel
1452 }
1453
Spandan Das604f3762023-03-16 22:51:40 +00001454 skipModuleList := map[string]bool{}
1455
Colin Crossa14fb6a2024-10-23 16:57:06 -07001456 var transitiveAndroidMkSharedLibs []depset.DepSet[string]
Cole Faustb6e6f992023-08-17 17:42:26 -07001457 var directAndroidMkSharedLibs []string
Wen-yi Chu41326c12023-09-22 03:58:59 +00001458
Yu Liu8024b922024-12-20 23:31:32 +00001459 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Ivan Lozanoffee3342019-08-27 12:03:00 -07001460 depName := ctx.OtherModuleName(dep)
1461 depTag := ctx.OtherModuleDependencyTag(dep)
Ivan Lozano806efd32024-12-11 21:38:53 +00001462 modStdLinkage := mod.compiler.stdLinkage(ctx.Device())
1463
Spandan Das604f3762023-03-16 22:51:40 +00001464 if _, exists := skipModuleList[depName]; exists {
1465 return
1466 }
A. Cody Schuffelenc183e3a2023-08-14 21:09:47 -07001467
1468 if depTag == android.DarwinUniversalVariantTag {
1469 return
1470 }
1471
Yu Liu8024b922024-12-20 23:31:32 +00001472 rustInfo, hasRustInfo := android.OtherModuleProvider(ctx, dep, RustInfoProvider)
1473 ccInfo, _ := android.OtherModuleProvider(ctx, dep, cc.CcInfoProvider)
1474 linkableInfo, hasLinkableInfo := android.OtherModuleProvider(ctx, dep, cc.LinkableInfoProvider)
1475 commonInfo := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey)
1476 if hasRustInfo && !linkableInfo.Static && !linkableInfo.Shared {
Ivan Lozanoffee3342019-08-27 12:03:00 -07001477 //Handle Rust Modules
Yu Liu8024b922024-12-20 23:31:32 +00001478 makeLibName := rustMakeLibName(rustInfo, linkableInfo, &commonInfo, depName+rustInfo.RustSubName)
Ivan Lozano70e0a072019-09-13 14:23:15 -07001479
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001480 switch {
1481 case depTag == dylibDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00001482 dylib := rustInfo.CompilerInfo.LibraryInfo
1483 if dylib == nil || !dylib.Dylib {
Ivan Lozanoffee3342019-08-27 12:03:00 -07001484 ctx.ModuleErrorf("mod %q not an dylib library", depName)
1485 return
1486 }
Yu Liu8024b922024-12-20 23:31:32 +00001487 directDylibDeps = append(directDylibDeps, linkableInfo)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001488 mod.Properties.AndroidMkDylibs = append(mod.Properties.AndroidMkDylibs, makeLibName)
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001489 mod.Properties.SnapshotDylibs = append(mod.Properties.SnapshotDylibs, cc.BaseLibName(depName))
1490
Colin Crossb614cd42024-10-11 12:52:21 -07001491 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
1492 if info, ok := android.OtherModuleProvider(ctx, dep, cc.ImplementationDepInfoProvider); ok {
1493 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
1494 }
1495
Yu Liu8024b922024-12-20 23:31:32 +00001496 if !rustInfo.CompilerInfo.NoStdlibs {
1497 rustDepStdLinkage := rustInfo.CompilerInfo.StdLinkageForNonDevice
1498 if ctx.Device() {
1499 rustDepStdLinkage = rustInfo.CompilerInfo.StdLinkageForDevice
1500 }
Ivan Lozano806efd32024-12-11 21:38:53 +00001501 if rustDepStdLinkage != modStdLinkage {
1502 ctx.ModuleErrorf("Rust dependency %q has the wrong StdLinkage; expected %#v, got %#v", depName, modStdLinkage, rustDepStdLinkage)
1503 return
1504 }
1505 }
1506
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001507 case depTag == rlibDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00001508 rlib := rustInfo.CompilerInfo.LibraryInfo
1509 if rlib == nil || !rlib.Rlib {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001510 ctx.ModuleErrorf("mod %q not an rlib library", makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001511 return
1512 }
Yu Liu8024b922024-12-20 23:31:32 +00001513 directRlibDeps = append(directRlibDeps, linkableInfo)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001514 mod.Properties.AndroidMkRlibs = append(mod.Properties.AndroidMkRlibs, makeLibName)
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001515 mod.Properties.SnapshotRlibs = append(mod.Properties.SnapshotRlibs, cc.BaseLibName(depName))
1516
Ivan Lozano0a468a42024-05-13 21:03:34 -04001517 // rust_ffi rlibs may export include dirs, so collect those here.
1518 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, cc.FlagExporterInfoProvider)
1519 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
Yu Liu8024b922024-12-20 23:31:32 +00001520 depPaths.exportedLinkDirs = append(depPaths.exportedLinkDirs, linkPathFromFilePath(linkableInfo.OutputFile.Path()))
Ivan Lozano0a468a42024-05-13 21:03:34 -04001521
Colin Crossb614cd42024-10-11 12:52:21 -07001522 // rlibs are not installed, so don't add the output file to directImplementationDeps
1523 if info, ok := android.OtherModuleProvider(ctx, dep, cc.ImplementationDepInfoProvider); ok {
1524 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
1525 }
1526
Yu Liu8024b922024-12-20 23:31:32 +00001527 if !rustInfo.CompilerInfo.NoStdlibs {
1528 rustDepStdLinkage := rustInfo.CompilerInfo.StdLinkageForNonDevice
1529 if ctx.Device() {
1530 rustDepStdLinkage = rustInfo.CompilerInfo.StdLinkageForDevice
1531 }
Ivan Lozano806efd32024-12-11 21:38:53 +00001532 if rustDepStdLinkage != modStdLinkage {
1533 ctx.ModuleErrorf("Rust dependency %q has the wrong StdLinkage; expected %#v, got %#v", depName, modStdLinkage, rustDepStdLinkage)
1534 return
1535 }
1536 }
1537
Ivan Lozano85f00cf2025-02-11 20:19:19 +00001538 if !mod.Rlib() {
1539 depPaths.ccRlibDeps = append(depPaths.ccRlibDeps, exportedInfo.RustRlibDeps...)
1540 } else {
1541 // rlibs need to reexport these
1542 depPaths.reexportedCcRlibDeps = append(depPaths.reexportedCcRlibDeps, exportedInfo.RustRlibDeps...)
1543 }
1544
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001545 case depTag == procMacroDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00001546 directProcMacroDeps = append(directProcMacroDeps, linkableInfo)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001547 mod.Properties.AndroidMkProcMacroLibs = append(mod.Properties.AndroidMkProcMacroLibs, makeLibName)
Ivan Lozano0a468a42024-05-13 21:03:34 -04001548 // proc_macro link dirs need to be exported, so collect those here.
Yu Liu8024b922024-12-20 23:31:32 +00001549 depPaths.exportedLinkDirs = append(depPaths.exportedLinkDirs, linkPathFromFilePath(linkableInfo.OutputFile.Path()))
Ivan Lozanod106efe2023-09-21 23:30:26 -04001550
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001551 case depTag == sourceDepTag:
Ivan Lozanod106efe2023-09-21 23:30:26 -04001552 if _, ok := mod.sourceProvider.(*protobufDecorator); ok {
Yu Liu8024b922024-12-20 23:31:32 +00001553 collectIncludedProtos(mod, rustInfo, linkableInfo)
Ivan Lozanod106efe2023-09-21 23:30:26 -04001554 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001555 case cc.IsStaticDepTag(depTag):
1556 // Rust FFI rlibs should not be declared in a Rust modules
1557 // "static_libs" list as we can't handle them properly at the
1558 // moment (for example, they only produce an rlib-std variant).
1559 // Instead, a normal rust_library variant should be used.
1560 ctx.PropertyErrorf("static_libs",
1561 "found '%s' in static_libs; use a rust_library module in rustlibs instead of a rust_ffi module in static_libs",
1562 depName)
1563
Paul Duffind5cf92e2021-07-09 17:38:55 +01001564 }
1565
Yu Liu8024b922024-12-20 23:31:32 +00001566 transitiveAndroidMkSharedLibs = append(transitiveAndroidMkSharedLibs, rustInfo.TransitiveAndroidMkSharedLibs)
Cole Faustb6e6f992023-08-17 17:42:26 -07001567
Paul Duffind5cf92e2021-07-09 17:38:55 +01001568 if android.IsSourceDepTagWithOutputTag(depTag, "") {
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001569 // Since these deps are added in path_properties.go via AddDependencies, we need to ensure the correct
1570 // OS/Arch variant is used.
1571 var helper string
1572 if ctx.Host() {
1573 helper = "missing 'host_supported'?"
1574 } else {
1575 helper = "device module defined?"
1576 }
1577
Yu Liu8024b922024-12-20 23:31:32 +00001578 if commonInfo.Target.Os != ctx.Os() {
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001579 ctx.ModuleErrorf("OS mismatch on dependency %q (%s)", dep.Name(), helper)
1580 return
Yu Liu8024b922024-12-20 23:31:32 +00001581 } else if commonInfo.Target.Arch.ArchType != ctx.Arch().ArchType {
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001582 ctx.ModuleErrorf("Arch mismatch on dependency %q (%s)", dep.Name(), helper)
1583 return
1584 }
Yu Liu8024b922024-12-20 23:31:32 +00001585 directSrcProvidersDeps = append(directSrcProvidersDeps, &dep)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001586 }
1587
Ivan Lozano7fe65ca2025-02-05 02:22:33 +00001588 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, RustFlagExporterInfoProvider)
Ivan Lozano1f10f682024-11-08 16:16:50 +00001589
1590 //Append the dependencies exported objects, except for proc-macros which target a different arch/OS
Colin Cross0de8a1e2020-09-18 14:15:30 -07001591 if depTag != procMacroDepTag {
Colin Cross0de8a1e2020-09-18 14:15:30 -07001592 depPaths.depFlags = append(depPaths.depFlags, exportedInfo.Flags...)
Ivan Lozano1f10f682024-11-08 16:16:50 +00001593 depPaths.rustLibObjects = append(depPaths.rustLibObjects, exportedInfo.RustLibObjects...)
1594 depPaths.sharedLibObjects = append(depPaths.sharedLibObjects, exportedInfo.SharedLibPaths...)
1595 depPaths.staticLibObjects = append(depPaths.staticLibObjects, exportedInfo.StaticLibObjects...)
1596 depPaths.wholeStaticLibObjects = append(depPaths.wholeStaticLibObjects, exportedInfo.WholeStaticLibObjects...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04001597 depPaths.linkDirs = append(depPaths.linkDirs, exportedInfo.LinkDirs...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001598 }
1599
Ivan Lozanoffee3342019-08-27 12:03:00 -07001600 if depTag == dylibDepTag || depTag == rlibDepTag || depTag == procMacroDepTag {
Yu Liu8024b922024-12-20 23:31:32 +00001601 linkFile := linkableInfo.UnstrippedOutputFile
Wen-yi Chu41326c12023-09-22 03:58:59 +00001602 linkDir := linkPathFromFilePath(linkFile)
Matthew Maurerbb3add12020-06-25 09:34:12 -07001603 if lib, ok := mod.compiler.(exportedFlagsProducer); ok {
Wen-yi Chu41326c12023-09-22 03:58:59 +00001604 lib.exportLinkDirs(linkDir)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001605 }
1606 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04001607
Ivan Lozanod106efe2023-09-21 23:30:26 -04001608 if depTag == sourceDepTag {
1609 if _, ok := mod.sourceProvider.(*protobufDecorator); ok && mod.Source() {
Yu Liu8024b922024-12-20 23:31:32 +00001610 if rustInfo.SourceProviderInfo.ProtobufDecoratorInfo != nil {
Colin Cross313aa542023-12-13 13:47:44 -08001611 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, cc.FlagExporterInfoProvider)
Ivan Lozanod106efe2023-09-21 23:30:26 -04001612 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1613 }
1614 }
1615 }
Yu Liu8024b922024-12-20 23:31:32 +00001616 } else if hasLinkableInfo {
Ivan Lozano52767be2019-10-18 14:49:46 -07001617 //Handle C dependencies
Yu Liu8024b922024-12-20 23:31:32 +00001618 makeLibName := cc.MakeLibName(ccInfo, linkableInfo, &commonInfo, depName)
1619 if !hasRustInfo {
1620 if commonInfo.Target.Os != ctx.Os() {
Ivan Lozano52767be2019-10-18 14:49:46 -07001621 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
1622 return
1623 }
Yu Liu8024b922024-12-20 23:31:32 +00001624 if commonInfo.Target.Arch.ArchType != ctx.Arch().ArchType {
Ivan Lozano52767be2019-10-18 14:49:46 -07001625 ctx.ModuleErrorf("Arch mismatch between %q and %q", ctx.ModuleName(), depName)
1626 return
1627 }
Ivan Lozano70e0a072019-09-13 14:23:15 -07001628 }
Ivan Lozano1f10f682024-11-08 16:16:50 +00001629 ccLibPath := linkableInfo.OutputFile
1630 if !ccLibPath.Valid() {
Colin Crossa86ea0e2023-08-01 09:57:22 -07001631 if !ctx.Config().AllowMissingDependencies() {
1632 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q", depName, ctx.ModuleName())
1633 } else {
1634 ctx.AddMissingDependencies([]string{depName})
1635 }
1636 return
Ivan Lozanoffee3342019-08-27 12:03:00 -07001637 }
1638
Ivan Lozano1f10f682024-11-08 16:16:50 +00001639 linkPath := linkPathFromFilePath(ccLibPath.Path())
Colin Crossa86ea0e2023-08-01 09:57:22 -07001640
Ivan Lozanoffee3342019-08-27 12:03:00 -07001641 exportDep := false
Colin Cross6e511a92020-07-27 21:26:48 -07001642 switch {
1643 case cc.IsStaticDepTag(depTag):
Ivan Lozano63bb7682021-03-23 15:53:44 -04001644 if cc.IsWholeStaticLib(depTag) {
1645 // rustc will bundle static libraries when they're passed with "-lstatic=<lib>". This will fail
1646 // if the library is not prefixed by "lib".
Ivan Lozanofdadcd72021-11-01 09:04:23 -04001647 if mod.Binary() {
Ivan Lozanofdadcd72021-11-01 09:04:23 -04001648 // Since binaries don't need to 'rebundle' these like libraries and only use these for the
1649 // final linkage, pass the args directly to the linker to handle these cases.
Ivan Lozano1f10f682024-11-08 16:16:50 +00001650 depPaths.depLinkFlags = append(depPaths.depLinkFlags, []string{"-Wl,--whole-archive", ccLibPath.Path().String(), "-Wl,--no-whole-archive"}...)
1651 } else if libName, ok := libNameFromFilePath(ccLibPath.Path()); ok {
1652 depPaths.depFlags = append(depPaths.depFlags, "-lstatic:+whole-archive="+libName)
1653 depPaths.depLinkFlags = append(depPaths.depLinkFlags, ccLibPath.Path().String())
Ivan Lozano63bb7682021-03-23 15:53:44 -04001654 } else {
1655 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 -05001656 }
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001657 }
1658
Ivan Lozano1f10f682024-11-08 16:16:50 +00001659 if cc.IsWholeStaticLib(depTag) {
1660 // Add whole staticlibs to wholeStaticLibObjects to propagate to Rust all dependents.
1661 depPaths.wholeStaticLibObjects = append(depPaths.wholeStaticLibObjects, ccLibPath.String())
1662 } else {
1663 // Otherwise add to staticLibObjects, which only propagate through rlibs to their dependents.
1664 depPaths.staticLibObjects = append(depPaths.staticLibObjects, ccLibPath.String())
Ivan Lozano1f10f682024-11-08 16:16:50 +00001665 }
Ivan Lozano85f00cf2025-02-11 20:19:19 +00001666
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001667 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
1668
Colin Cross313aa542023-12-13 13:47:44 -08001669 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, cc.FlagExporterInfoProvider)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001670 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1671 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1672 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1673 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Ivan Lozano85f00cf2025-02-11 20:19:19 +00001674
1675 if !mod.Rlib() {
1676 // rlibs don't need to build the generated static library, so they don't need to track these.
1677 depPaths.ccRlibDeps = append(depPaths.ccRlibDeps, exportedInfo.RustRlibDeps...)
1678 } else {
1679 depPaths.reexportedCcRlibDeps = append(depPaths.reexportedCcRlibDeps, exportedInfo.RustRlibDeps...)
1680 }
1681
Yu Liu8024b922024-12-20 23:31:32 +00001682 directStaticLibDeps = append(directStaticLibDeps, linkableInfo)
Justin Yun2b3ed642022-02-16 08:15:07 +09001683
1684 // Record baseLibName for snapshots.
1685 mod.Properties.SnapshotStaticLibs = append(mod.Properties.SnapshotStaticLibs, cc.BaseLibName(depName))
1686
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001687 mod.Properties.AndroidMkStaticLibs = append(mod.Properties.AndroidMkStaticLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07001688 case cc.IsSharedDepTag(depTag):
Jiyong Park7d55b612021-06-11 17:22:09 +09001689 // For the shared lib dependencies, we may link to the stub variant
1690 // of the dependency depending on the context (e.g. if this
1691 // dependency crosses the APEX boundaries).
1692 sharedLibraryInfo, exportedInfo := cc.ChooseStubOrImpl(ctx, dep)
1693
Colin Crossb614cd42024-10-11 12:52:21 -07001694 if !sharedLibraryInfo.IsStubs {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00001695 // TODO(b/362509506): remove this additional check once all apex_exclude uses are switched to stubs.
1696 if !linkableInfo.RustApexExclude {
1697 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
1698 if info, ok := android.OtherModuleProvider(ctx, dep, cc.ImplementationDepInfoProvider); ok {
1699 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
1700 }
Colin Crossb614cd42024-10-11 12:52:21 -07001701 }
1702 }
1703
Jiyong Park7d55b612021-06-11 17:22:09 +09001704 // Re-get linkObject as ChooseStubOrImpl actually tells us which
1705 // object (either from stub or non-stub) to use.
Ivan Lozano1f10f682024-11-08 16:16:50 +00001706 ccLibPath = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
1707 if !ccLibPath.Valid() {
Colin Crossa86ea0e2023-08-01 09:57:22 -07001708 if !ctx.Config().AllowMissingDependencies() {
1709 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q", depName, ctx.ModuleName())
1710 } else {
1711 ctx.AddMissingDependencies([]string{depName})
1712 }
1713 return
1714 }
Ivan Lozano1f10f682024-11-08 16:16:50 +00001715 linkPath = linkPathFromFilePath(ccLibPath.Path())
Jiyong Park7d55b612021-06-11 17:22:09 +09001716
Ivan Lozanoffee3342019-08-27 12:03:00 -07001717 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
Ivan Lozano1f10f682024-11-08 16:16:50 +00001718 depPaths.sharedLibObjects = append(depPaths.sharedLibObjects, ccLibPath.String())
Colin Cross0de8a1e2020-09-18 14:15:30 -07001719 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1720 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1721 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1722 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Jiyong Park7d55b612021-06-11 17:22:09 +09001723 directSharedLibDeps = append(directSharedLibDeps, sharedLibraryInfo)
Ivan Lozano1921e802021-05-20 13:39:16 -04001724
1725 // Record baseLibName for snapshots.
1726 mod.Properties.SnapshotSharedLibs = append(mod.Properties.SnapshotSharedLibs, cc.BaseLibName(depName))
1727
Cole Faustb6e6f992023-08-17 17:42:26 -07001728 directAndroidMkSharedLibs = append(directAndroidMkSharedLibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001729 exportDep = true
Zach Johnson3df4e632020-11-06 11:56:27 -08001730 case cc.IsHeaderDepTag(depTag):
Colin Cross313aa542023-12-13 13:47:44 -08001731 exportedInfo, _ := android.OtherModuleProvider(ctx, dep, cc.FlagExporterInfoProvider)
Zach Johnson3df4e632020-11-06 11:56:27 -08001732 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1733 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1734 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Ivan Lozano1dbfa142024-03-29 14:48:11 +00001735 mod.Properties.AndroidMkHeaderLibs = append(mod.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07001736 case depTag == cc.CrtBeginDepTag:
Ivan Lozano1f10f682024-11-08 16:16:50 +00001737 depPaths.CrtBegin = append(depPaths.CrtBegin, ccLibPath.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07001738 case depTag == cc.CrtEndDepTag:
Ivan Lozano1f10f682024-11-08 16:16:50 +00001739 depPaths.CrtEnd = append(depPaths.CrtEnd, ccLibPath.Path())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001740 }
1741
Ivan Lozano1f10f682024-11-08 16:16:50 +00001742 // Make sure shared dependencies are propagated
Matthew Maurerbb3add12020-06-25 09:34:12 -07001743 if lib, ok := mod.compiler.(exportedFlagsProducer); ok && exportDep {
1744 lib.exportLinkDirs(linkPath)
Ivan Lozano1f10f682024-11-08 16:16:50 +00001745 lib.exportSharedLibs(ccLibPath.String())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001746 }
Colin Cross018cbeb2022-01-24 17:22:45 -08001747 } else {
1748 switch {
1749 case depTag == cc.CrtBeginDepTag:
1750 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
1751 case depTag == cc.CrtEndDepTag:
1752 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
1753 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001754 }
Ivan Lozano89435d12020-07-31 11:01:18 -04001755
Yu Liuc41eae52025-01-14 01:03:08 +00001756 if srcDep, ok := android.OtherModuleProvider(ctx, dep, android.SourceFilesInfoProvider); ok {
Paul Duffind5cf92e2021-07-09 17:38:55 +01001757 if android.IsSourceDepTagWithOutputTag(depTag, "") {
Ivan Lozano89435d12020-07-31 11:01:18 -04001758 // These are usually genrules which don't have per-target variants.
1759 directSrcDeps = append(directSrcDeps, srcDep)
1760 }
1761 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001762 })
1763
Colin Crossa14fb6a2024-10-23 16:57:06 -07001764 mod.transitiveAndroidMkSharedLibs = depset.New[string](depset.PREORDER, directAndroidMkSharedLibs, transitiveAndroidMkSharedLibs)
Wen-yi Chu41326c12023-09-22 03:58:59 +00001765
1766 var rlibDepFiles RustLibraries
Andrew Walbran52533232024-03-19 11:36:04 +00001767 aliases := mod.compiler.Aliases()
Wen-yi Chu41326c12023-09-22 03:58:59 +00001768 for _, dep := range directRlibDeps {
Yu Liu8024b922024-12-20 23:31:32 +00001769 crateName := dep.CrateName
Andrew Walbran52533232024-03-19 11:36:04 +00001770 if alias, aliased := aliases[crateName]; aliased {
1771 crateName = alias
1772 }
Yu Liu8024b922024-12-20 23:31:32 +00001773 rlibDepFiles = append(rlibDepFiles, RustLibrary{Path: dep.UnstrippedOutputFile, CrateName: crateName})
Wen-yi Chu41326c12023-09-22 03:58:59 +00001774 }
1775 var dylibDepFiles RustLibraries
1776 for _, dep := range directDylibDeps {
Yu Liu8024b922024-12-20 23:31:32 +00001777 crateName := dep.CrateName
Andrew Walbran52533232024-03-19 11:36:04 +00001778 if alias, aliased := aliases[crateName]; aliased {
1779 crateName = alias
1780 }
Yu Liu8024b922024-12-20 23:31:32 +00001781 dylibDepFiles = append(dylibDepFiles, RustLibrary{Path: dep.UnstrippedOutputFile, CrateName: crateName})
Wen-yi Chu41326c12023-09-22 03:58:59 +00001782 }
1783 var procMacroDepFiles RustLibraries
1784 for _, dep := range directProcMacroDeps {
Yu Liu8024b922024-12-20 23:31:32 +00001785 crateName := dep.CrateName
Andrew Walbran52533232024-03-19 11:36:04 +00001786 if alias, aliased := aliases[crateName]; aliased {
1787 crateName = alias
1788 }
Yu Liu8024b922024-12-20 23:31:32 +00001789 procMacroDepFiles = append(procMacroDepFiles, RustLibrary{Path: dep.UnstrippedOutputFile, CrateName: crateName})
Wen-yi Chu41326c12023-09-22 03:58:59 +00001790 }
1791
Colin Cross004bd3f2023-10-02 11:39:17 -07001792 var staticLibDepFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -07001793 for _, dep := range directStaticLibDeps {
Yu Liu8024b922024-12-20 23:31:32 +00001794 staticLibDepFiles = append(staticLibDepFiles, dep.OutputFile.Path())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001795 }
1796
Colin Cross004bd3f2023-10-02 11:39:17 -07001797 var sharedLibFiles android.Paths
1798 var sharedLibDepFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -07001799 for _, dep := range directSharedLibDeps {
Colin Cross004bd3f2023-10-02 11:39:17 -07001800 sharedLibFiles = append(sharedLibFiles, dep.SharedLibrary)
Jiyong Park7d55b612021-06-11 17:22:09 +09001801 if dep.TableOfContents.Valid() {
Colin Cross004bd3f2023-10-02 11:39:17 -07001802 sharedLibDepFiles = append(sharedLibDepFiles, dep.TableOfContents.Path())
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001803 } else {
Colin Cross004bd3f2023-10-02 11:39:17 -07001804 sharedLibDepFiles = append(sharedLibDepFiles, dep.SharedLibrary)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001805 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001806 }
1807
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001808 var srcProviderDepFiles android.Paths
1809 for _, dep := range directSrcProvidersDeps {
Yu Liu8024b922024-12-20 23:31:32 +00001810 srcs := android.OutputFilesForModule(ctx, *dep, "")
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001811 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1812 }
1813 for _, dep := range directSrcDeps {
Yu Liu8024b922024-12-20 23:31:32 +00001814 srcs := dep.Srcs
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001815 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1816 }
1817
Wen-yi Chu41326c12023-09-22 03:58:59 +00001818 depPaths.RLibs = append(depPaths.RLibs, rlibDepFiles...)
1819 depPaths.DyLibs = append(depPaths.DyLibs, dylibDepFiles...)
Colin Cross004bd3f2023-10-02 11:39:17 -07001820 depPaths.SharedLibs = append(depPaths.SharedLibs, sharedLibFiles...)
1821 depPaths.SharedLibDeps = append(depPaths.SharedLibDeps, sharedLibDepFiles...)
1822 depPaths.StaticLibs = append(depPaths.StaticLibs, staticLibDepFiles...)
Wen-yi Chu41326c12023-09-22 03:58:59 +00001823 depPaths.ProcMacros = append(depPaths.ProcMacros, procMacroDepFiles...)
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001824 depPaths.SrcDeps = append(depPaths.SrcDeps, srcProviderDepFiles...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001825
1826 // Dedup exported flags from dependencies
Wen-yi Chu41326c12023-09-22 03:58:59 +00001827 depPaths.linkDirs = android.FirstUniqueStrings(depPaths.linkDirs)
Ivan Lozano1f10f682024-11-08 16:16:50 +00001828 depPaths.rustLibObjects = android.FirstUniqueStrings(depPaths.rustLibObjects)
1829 depPaths.staticLibObjects = android.FirstUniqueStrings(depPaths.staticLibObjects)
1830 depPaths.wholeStaticLibObjects = android.FirstUniqueStrings(depPaths.wholeStaticLibObjects)
1831 depPaths.sharedLibObjects = android.FirstUniqueStrings(depPaths.sharedLibObjects)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001832 depPaths.depFlags = android.FirstUniqueStrings(depPaths.depFlags)
Ivan Lozano45901ed2020-07-24 16:05:01 -04001833 depPaths.depClangFlags = android.FirstUniqueStrings(depPaths.depClangFlags)
1834 depPaths.depIncludePaths = android.FirstUniquePaths(depPaths.depIncludePaths)
1835 depPaths.depSystemIncludePaths = android.FirstUniquePaths(depPaths.depSystemIncludePaths)
Ivan Lozanoad7ba592025-01-23 01:23:43 +00001836 depPaths.depLinkFlags = android.FirstUniqueStrings(depPaths.depLinkFlags)
Ivan Lozano85f00cf2025-02-11 20:19:19 +00001837 depPaths.reexportedCcRlibDeps = android.FirstUniqueFunc(depPaths.reexportedCcRlibDeps, cc.EqRustRlibDeps)
1838 depPaths.ccRlibDeps = android.FirstUniqueFunc(depPaths.ccRlibDeps, cc.EqRustRlibDeps)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001839
1840 return depPaths
1841}
1842
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -08001843func (mod *Module) InstallInData() bool {
1844 if mod.compiler == nil {
1845 return false
1846 }
1847 return mod.compiler.inData()
1848}
1849
Matthew Maurer9f59e8d2021-08-19 13:10:05 -07001850func (mod *Module) InstallInRamdisk() bool {
1851 return mod.InRamdisk()
1852}
1853
1854func (mod *Module) InstallInVendorRamdisk() bool {
1855 return mod.InVendorRamdisk()
1856}
1857
1858func (mod *Module) InstallInRecovery() bool {
1859 return mod.InRecovery()
1860}
1861
Wen-yi Chu41326c12023-09-22 03:58:59 +00001862func linkPathFromFilePath(filepath android.Path) string {
1863 return strings.Split(filepath.String(), filepath.Base())[0]
1864}
1865
Spandan Das604f3762023-03-16 22:51:40 +00001866// usePublicApi returns true if the rust variant should link against NDK (publicapi)
1867func (r *Module) usePublicApi() bool {
1868 return r.Device() && r.UseSdk()
1869}
1870
1871// useVendorApi returns true if the rust variant should link against LLNDK (vendorapi)
1872func (r *Module) useVendorApi() bool {
1873 return r.Device() && (r.InVendor() || r.InProduct())
1874}
1875
Ivan Lozanoffee3342019-08-27 12:03:00 -07001876func (mod *Module) DepsMutator(actx android.BottomUpMutatorContext) {
1877 ctx := &depsContext{
1878 BottomUpMutatorContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -07001879 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001880
1881 deps := mod.deps(ctx)
Colin Cross3146c5c2020-09-30 15:34:40 -07001882 var commonDepVariations []blueprint.Variation
Ivan Lozano1921e802021-05-20 13:39:16 -04001883
1884 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001885 deps.SharedLibs, _ = cc.FilterNdkLibs(mod, ctx.Config(), deps.SharedLibs)
Ivan Lozano1921e802021-05-20 13:39:16 -04001886 }
Ivan Lozanodd055472020-09-28 13:22:45 -04001887
Ivan Lozano2b081132020-09-08 12:46:52 -04001888 stdLinkage := "dylib-std"
Ivan Lozano806efd32024-12-11 21:38:53 +00001889 if mod.compiler.stdLinkage(ctx.Device()) == RlibLinkage {
Ivan Lozano2b081132020-09-08 12:46:52 -04001890 stdLinkage = "rlib-std"
1891 }
1892
1893 rlibDepVariations := commonDepVariations
Ivan Lozano1921e802021-05-20 13:39:16 -04001894
Ivan Lozano2b081132020-09-08 12:46:52 -04001895 if lib, ok := mod.compiler.(libraryInterface); !ok || !lib.sysroot() {
1896 rlibDepVariations = append(rlibDepVariations,
1897 blueprint.Variation{Mutator: "rust_stdlinkage", Variation: stdLinkage})
1898 }
1899
Ivan Lozano1921e802021-05-20 13:39:16 -04001900 // rlibs
Ivan Lozano2d407632022-04-07 12:59:11 -04001901 rlibDepVariations = append(rlibDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: rlibVariation})
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001902 for _, lib := range deps.Rlibs {
1903 depTag := rlibDepTag
Ivan Lozano2d407632022-04-07 12:59:11 -04001904 actx.AddVariationDependencies(rlibDepVariations, depTag, lib)
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001905 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001906
1907 // dylibs
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001908 dylibDepVariations := append(commonDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: dylibVariation})
Ivan Lozano0a468a42024-05-13 21:03:34 -04001909
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001910 for _, lib := range deps.Dylibs {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001911 actx.AddVariationDependencies(dylibDepVariations, dylibDepTag, lib)
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001912 }
Ivan Lozano52767be2019-10-18 14:49:46 -07001913
Ivan Lozano1921e802021-05-20 13:39:16 -04001914 // rustlibs
Ivan Lozanod106efe2023-09-21 23:30:26 -04001915 if deps.Rustlibs != nil {
1916 if !mod.compiler.Disabled() {
1917 for _, lib := range deps.Rustlibs {
1918 autoDep := mod.compiler.(autoDeppable).autoDep(ctx)
1919 if autoDep.depTag == rlibDepTag {
1920 // Handle the rlib deptag case
Kiyoung Kim37693d02024-04-04 09:56:15 +09001921 actx.AddVariationDependencies(rlibDepVariations, rlibDepTag, lib)
1922
Ivan Lozanod106efe2023-09-21 23:30:26 -04001923 } else {
1924 // autoDep.depTag is a dylib depTag. Not all rustlibs may be available as a dylib however.
1925 // Check for the existence of the dylib deptag variant. Select it if available,
1926 // otherwise select the rlib variant.
1927 autoDepVariations := append(commonDepVariations,
1928 blueprint.Variation{Mutator: "rust_libraries", Variation: autoDep.variation})
Kiyoung Kim37693d02024-04-04 09:56:15 +09001929 if actx.OtherModuleDependencyVariantExists(autoDepVariations, lib) {
1930 actx.AddVariationDependencies(autoDepVariations, autoDep.depTag, lib)
Ivan Lozanod106efe2023-09-21 23:30:26 -04001931
Ivan Lozanod106efe2023-09-21 23:30:26 -04001932 } else {
1933 // If there's no dylib dependency available, try to add the rlib dependency instead.
Kiyoung Kim37693d02024-04-04 09:56:15 +09001934 actx.AddVariationDependencies(rlibDepVariations, rlibDepTag, lib)
1935
Ivan Lozanod106efe2023-09-21 23:30:26 -04001936 }
1937 }
1938 }
1939 } else if _, ok := mod.sourceProvider.(*protobufDecorator); ok {
1940 for _, lib := range deps.Rustlibs {
Ivan Lozanod106efe2023-09-21 23:30:26 -04001941 srcProviderVariations := append(commonDepVariations,
Colin Cross8a49a3d2024-05-20 12:22:27 -07001942 blueprint.Variation{Mutator: "rust_libraries", Variation: sourceVariation})
Ivan Lozanod106efe2023-09-21 23:30:26 -04001943
Ivan Lozano0a468a42024-05-13 21:03:34 -04001944 // Only add rustlib dependencies if they're source providers themselves.
1945 // This is used to track which crate names need to be added to the source generated
1946 // in the rust_protobuf mod.rs.
Kiyoung Kim37693d02024-04-04 09:56:15 +09001947 if actx.OtherModuleDependencyVariantExists(srcProviderVariations, lib) {
Ivan Lozanod106efe2023-09-21 23:30:26 -04001948 actx.AddVariationDependencies(srcProviderVariations, sourceDepTag, lib)
Ivan Lozano2d407632022-04-07 12:59:11 -04001949 }
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001950 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001951 }
Matthew Maurer0f003b12020-06-29 14:34:06 -07001952 }
Ivan Lozanod106efe2023-09-21 23:30:26 -04001953
Ivan Lozano1921e802021-05-20 13:39:16 -04001954 // stdlibs
Ivan Lozano2b081132020-09-08 12:46:52 -04001955 if deps.Stdlibs != nil {
Ivan Lozano806efd32024-12-11 21:38:53 +00001956 if mod.compiler.stdLinkage(ctx.Device()) == RlibLinkage {
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001957 for _, lib := range deps.Stdlibs {
Colin Cross8a49a3d2024-05-20 12:22:27 -07001958 actx.AddVariationDependencies(append(commonDepVariations, []blueprint.Variation{{Mutator: "rust_libraries", Variation: "rlib"}}...),
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001959 rlibDepTag, lib)
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001960 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001961 } else {
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001962 for _, lib := range deps.Stdlibs {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001963 actx.AddVariationDependencies(dylibDepVariations, dylibDepTag, lib)
1964
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001965 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001966 }
1967 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001968
1969 for _, lib := range deps.SharedLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08001970 depTag := cc.SharedDepTag()
Ivan Lozano1921e802021-05-20 13:39:16 -04001971 name, version := cc.StubsLibNameAndVersion(lib)
1972
1973 variations := []blueprint.Variation{
1974 {Mutator: "link", Variation: "shared"},
1975 }
Spandan Dasff665182024-09-11 18:48:44 +00001976 cc.AddSharedLibDependenciesWithVersions(ctx, mod, variations, depTag, name, version, false)
Ivan Lozano1921e802021-05-20 13:39:16 -04001977 }
1978
1979 for _, lib := range deps.WholeStaticLibs {
1980 depTag := cc.StaticDepTag(true)
Ivan Lozano1921e802021-05-20 13:39:16 -04001981
1982 actx.AddVariationDependencies([]blueprint.Variation{
1983 {Mutator: "link", Variation: "static"},
1984 }, depTag, lib)
1985 }
1986
1987 for _, lib := range deps.StaticLibs {
1988 depTag := cc.StaticDepTag(false)
Ivan Lozano1921e802021-05-20 13:39:16 -04001989
1990 actx.AddVariationDependencies([]blueprint.Variation{
1991 {Mutator: "link", Variation: "static"},
1992 }, depTag, lib)
1993 }
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07001994
Zach Johnson3df4e632020-11-06 11:56:27 -08001995 actx.AddVariationDependencies(nil, cc.HeaderDepTag(), deps.HeaderLibs...)
1996
Colin Cross565cafd2020-09-25 18:47:38 -07001997 crtVariations := cc.GetCrtVariations(ctx, mod)
Colin Crossfe605e12022-01-23 20:46:16 -08001998 for _, crt := range deps.CrtBegin {
Kiyoung Kim37693d02024-04-04 09:56:15 +09001999 actx.AddVariationDependencies(crtVariations, cc.CrtBeginDepTag, crt)
Ivan Lozanof1c84332019-09-20 11:00:37 -07002000 }
Colin Crossfe605e12022-01-23 20:46:16 -08002001 for _, crt := range deps.CrtEnd {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002002 actx.AddVariationDependencies(crtVariations, cc.CrtEndDepTag, crt)
Ivan Lozanof1c84332019-09-20 11:00:37 -07002003 }
2004
Ivan Lozanoc564d2d2020-08-04 15:43:37 -04002005 if mod.sourceProvider != nil {
2006 if bindgen, ok := mod.sourceProvider.(*bindgenDecorator); ok &&
2007 bindgen.Properties.Custom_bindgen != "" {
2008 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), customBindgenDepTag,
2009 bindgen.Properties.Custom_bindgen)
2010 }
2011 }
Ivan Lozano1921e802021-05-20 13:39:16 -04002012
Ivan Lozano4e5f07d2021-11-04 14:09:38 -04002013 actx.AddVariationDependencies([]blueprint.Variation{
2014 {Mutator: "link", Variation: "shared"},
2015 }, dataLibDepTag, deps.DataLibs...)
2016
2017 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2018
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07002019 // proc_macros are compiler plugins, and so we need the host arch variant as a dependendcy.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002020 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), procMacroDepTag, deps.ProcMacros...)
Vinh Trancde10162023-03-09 22:07:19 -05002021
2022 mod.afdo.addDep(ctx, actx)
Ivan Lozanoffee3342019-08-27 12:03:00 -07002023}
2024
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04002025func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002026 if mod, ok := ctx.Module().(*Module); ok && mod.Enabled(ctx) {
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04002027 mod.beginMutator(ctx)
2028 }
2029}
2030
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04002031func (mod *Module) beginMutator(actx android.BottomUpMutatorContext) {
2032 ctx := &baseModuleContext{
2033 BaseModuleContext: actx,
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04002034 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04002035
2036 mod.begin(ctx)
2037}
2038
Ivan Lozanoffee3342019-08-27 12:03:00 -07002039func (mod *Module) Name() string {
2040 name := mod.ModuleBase.Name()
2041 if p, ok := mod.compiler.(interface {
2042 Name(string) string
2043 }); ok {
2044 name = p.Name(name)
2045 }
2046 return name
2047}
2048
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02002049func (mod *Module) disableClippy() {
Ivan Lozano32267c82020-08-04 16:27:16 -04002050 if mod.clippy != nil {
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02002051 mod.clippy.Properties.Clippy_lints = proptools.StringPtr("none")
Ivan Lozano32267c82020-08-04 16:27:16 -04002052 }
2053}
2054
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07002055var _ android.HostToolProvider = (*Module)(nil)
2056
2057func (mod *Module) HostToolPath() android.OptionalPath {
2058 if !mod.Host() {
2059 return android.OptionalPath{}
2060 }
Chih-Hung Hsieha7562702020-08-10 21:50:43 -07002061 if binary, ok := mod.compiler.(*binaryDecorator); ok {
2062 return android.OptionalPathForPath(binary.baseCompiler.path)
Ivan Lozano872d5792022-03-23 17:31:39 -04002063 } else if pm, ok := mod.compiler.(*procMacroDecorator); ok {
2064 // Even though proc-macros aren't strictly "tools", since they target the compiler
2065 // and act as compiler plugins, we treat them similarly.
2066 return android.OptionalPathForPath(pm.baseCompiler.path)
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07002067 }
2068 return android.OptionalPath{}
2069}
2070
Jiyong Park99644e92020-11-17 22:21:02 +09002071var _ android.ApexModule = (*Module)(nil)
2072
Ivan Lozano24cf0362024-10-04 16:02:38 +00002073// If a module is marked for exclusion from apexes, don't provide apex variants.
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002074// TODO(b/362509506): remove this once all apex_exclude usages are removed.
Ivan Lozano24cf0362024-10-04 16:02:38 +00002075func (m *Module) CanHaveApexVariants() bool {
2076 if m.ApexExclude() {
2077 return false
2078 } else {
2079 return m.ApexModuleBase.CanHaveApexVariants()
2080 }
2081}
2082
Ivan Lozanoa91ba252022-01-11 12:02:06 -05002083func (mod *Module) MinSdkVersion() string {
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05002084 return String(mod.Properties.Min_sdk_version)
2085}
2086
Jiyong Park45bf82e2020-12-15 22:29:02 +09002087// Implements android.ApexModule
Jiyong Park99644e92020-11-17 22:21:02 +09002088func (mod *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Ivan Lozanoa91ba252022-01-11 12:02:06 -05002089 minSdkVersion := mod.MinSdkVersion()
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05002090 if minSdkVersion == "apex_inherit" {
2091 return nil
2092 }
2093 if minSdkVersion == "" {
2094 return fmt.Errorf("min_sdk_version is not specificed")
2095 }
2096
2097 // Not using nativeApiLevelFromUser because the context here is not
2098 // necessarily a native context.
2099 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2100 if err != nil {
2101 return err
2102 }
2103
2104 if ver.GreaterThan(sdkVersion) {
2105 return fmt.Errorf("newer SDK(%v)", ver)
2106 }
Jiyong Park99644e92020-11-17 22:21:02 +09002107 return nil
2108}
2109
Jiyong Park45bf82e2020-12-15 22:29:02 +09002110// Implements android.ApexModule
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002111func (mod *Module) AlwaysRequiresPlatformApexVariant() bool {
2112 // stub libraries and native bridge libraries are always available to platform
2113 // TODO(b/362509506): remove the ApexExclude() check once all apex_exclude uses are switched to stubs.
2114 return mod.IsStubs() || mod.Target().NativeBridge == android.NativeBridgeEnabled || mod.ApexExclude()
2115}
2116
2117// Implements android.ApexModule
Colin Crossf7bbd2f2024-12-05 13:57:10 -08002118func (mod *Module) OutgoingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
Matthew Maurer581b6d82022-09-29 16:46:25 -07002119 if depTag == procMacroDepTag || depTag == customBindgenDepTag {
Jiyong Park99644e92020-11-17 22:21:02 +09002120 return false
2121 }
2122
Colin Cross8acea3e2024-12-12 14:53:30 -08002123 if mod.Static() && cc.IsSharedDepTag(depTag) {
2124 // shared_lib dependency from a static lib is considered as crossing
2125 // the APEX boundary because the dependency doesn't actually is
2126 // linked; the dependency is used only during the compilation phase.
2127 return false
2128 }
2129
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002130 if depTag == cc.StubImplDepTag {
2131 // We don't track from an implementation library to its stubs.
2132 return false
2133 }
2134
2135 if cc.ExcludeInApexDepTag(depTag) {
2136 return false
2137 }
2138
2139 // TODO(b/362509506): remove once all apex_exclude uses are switched to stubs.
2140 if mod.ApexExclude() {
2141 return false
2142 }
2143
Jiyong Park99644e92020-11-17 22:21:02 +09002144 return true
2145}
2146
Colin Crossf7bbd2f2024-12-05 13:57:10 -08002147func (mod *Module) IncomingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002148 // TODO(b/362509506): remove once all apex_exclude uses are switched to stubs.
2149 if mod.ApexExclude() {
2150 return false
2151 }
2152
2153 if mod.HasStubsVariants() {
Colin Crossbd930bc2025-02-03 12:17:42 -08002154 if cc.IsSharedDepTag(depTag) && !cc.IsExplicitImplSharedDepTag(depTag) {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002155 // dynamic dep to a stubs lib crosses APEX boundary
2156 return false
2157 }
2158 if cc.IsRuntimeDepTag(depTag) {
2159 // runtime dep to a stubs lib also crosses APEX boundary
2160 return false
2161 }
2162 if cc.IsHeaderDepTag(depTag) {
2163 return false
2164 }
2165 }
2166 return true
Colin Crossf7bbd2f2024-12-05 13:57:10 -08002167}
2168
Jiyong Park99644e92020-11-17 22:21:02 +09002169// Overrides ApexModule.IsInstallabeToApex()
2170func (mod *Module) IsInstallableToApex() bool {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002171 // TODO(b/362509506): remove once all apex_exclude uses are switched to stubs.
2172 if mod.ApexExclude() {
2173 return false
2174 }
2175
Jiyong Park99644e92020-11-17 22:21:02 +09002176 if mod.compiler != nil {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002177 if lib, ok := mod.compiler.(libraryInterface); ok {
2178 return (lib.shared() || lib.dylib()) && !lib.BuildStubs()
Jiyong Park99644e92020-11-17 22:21:02 +09002179 }
2180 if _, ok := mod.compiler.(*binaryDecorator); ok {
2181 return true
2182 }
2183 }
2184 return false
2185}
2186
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05002187// If a library file has a "lib" prefix, extract the library name without the prefix.
2188func libNameFromFilePath(filepath android.Path) (string, bool) {
2189 libName := strings.TrimSuffix(filepath.Base(), filepath.Ext())
2190 if strings.HasPrefix(libName, "lib") {
2191 libName = libName[3:]
2192 return libName, true
2193 }
2194 return "", false
2195}
2196
Sasha Smundaka76acba2022-04-18 20:12:56 -07002197func kytheExtractRustFactory() android.Singleton {
2198 return &kytheExtractRustSingleton{}
2199}
2200
2201type kytheExtractRustSingleton struct {
2202}
2203
2204func (k kytheExtractRustSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2205 var xrefTargets android.Paths
2206 ctx.VisitAllModules(func(module android.Module) {
2207 if rustModule, ok := module.(xref); ok {
2208 xrefTargets = append(xrefTargets, rustModule.XrefRustFiles()...)
2209 }
2210 })
2211 if len(xrefTargets) > 0 {
2212 ctx.Phony("xref_rust", xrefTargets...)
2213 }
2214}
2215
Jihoon Kangf78a8902022-09-01 22:47:07 +00002216func (c *Module) Partition() string {
2217 return ""
2218}
2219
Ivan Lozanoffee3342019-08-27 12:03:00 -07002220var Bool = proptools.Bool
2221var BoolDefault = proptools.BoolDefault
2222var String = proptools.String
2223var StringPtr = proptools.StringPtr