blob: 4a43c3eb4ae9bae666126911b145a2cf8d5a0fb6 [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 (
Ivan Lozano183a3212019-10-18 14:18:45 -070018 "fmt"
Ivan Lozanoffee3342019-08-27 12:03:00 -070019 "strings"
20
21 "github.com/google/blueprint"
22 "github.com/google/blueprint/proptools"
23
24 "android/soong/android"
Thiébaud Weksteene4dd14b2021-04-14 11:18:47 +020025 "android/soong/bloaty"
Ivan Lozanoffee3342019-08-27 12:03:00 -070026 "android/soong/cc"
Thiébaud Weksteen31f1bb82020-08-27 13:37:29 +020027 cc_config "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070028 "android/soong/fuzz"
Ivan Lozanoffee3342019-08-27 12:03:00 -070029 "android/soong/rust/config"
30)
31
32var pctx = android.NewPackageContext("android/soong/rust")
33
34func init() {
35 // Only allow rust modules to be defined for certain projects
Ivan Lozanoffee3342019-08-27 12:03:00 -070036
37 android.AddNeverAllowRules(
38 android.NeverAllow().
Ivan Lozano03a94c42021-06-28 11:27:11 -040039 NotIn(append(config.RustAllowedPaths, config.DownstreamRustAllowedPaths...)...).
Ivan Lozanoe169ad72019-09-18 08:42:54 -070040 ModuleType(config.RustModuleTypes...))
Ivan Lozanoffee3342019-08-27 12:03:00 -070041
42 android.RegisterModuleType("rust_defaults", defaultsFactory)
43 android.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
44 ctx.BottomUp("rust_libraries", LibraryMutator).Parallel()
Ivan Lozano2b081132020-09-08 12:46:52 -040045 ctx.BottomUp("rust_stdlinkage", LibstdMutator).Parallel()
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -040046 ctx.BottomUp("rust_begin", BeginMutator).Parallel()
Ivan Lozano6cd99e62020-02-11 08:24:25 -050047
48 })
49 android.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
50 ctx.BottomUp("rust_sanitizers", rustSanitizerRuntimeMutator).Parallel()
Ivan Lozanoffee3342019-08-27 12:03:00 -070051 })
52 pctx.Import("android/soong/rust/config")
Thiébaud Weksteen682c9d72020-08-31 10:06:16 +020053 pctx.ImportAs("cc_config", "android/soong/cc/config")
Ivan Lozanoffee3342019-08-27 12:03:00 -070054}
55
56type Flags struct {
Ivan Lozano8a23fa42020-06-16 10:26:57 -040057 GlobalRustFlags []string // Flags that apply globally to rust
58 GlobalLinkFlags []string // Flags that apply globally to linker
59 RustFlags []string // Flags that apply to rust
60 LinkFlags []string // Flags that apply to linker
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020061 ClippyFlags []string // Flags that apply to clippy-driver, during the linting
Dan Albert06feee92021-03-19 15:06:02 -070062 RustdocFlags []string // Flags that apply to rustdoc
Ivan Lozanof1c84332019-09-20 11:00:37 -070063 Toolchain config.Toolchain
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -040064 Coverage bool
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020065 Clippy bool
Ivan Lozanoffee3342019-08-27 12:03:00 -070066}
67
68type BaseProperties struct {
69 AndroidMkRlibs []string
70 AndroidMkDylibs []string
71 AndroidMkProcMacroLibs []string
72 AndroidMkSharedLibs []string
73 AndroidMkStaticLibs []string
Ivan Lozano43845682020-07-09 21:03:28 -040074
Ivan Lozano6a884432020-12-02 09:15:16 -050075 ImageVariationPrefix string `blueprint:"mutated"`
76 VndkVersion string `blueprint:"mutated"`
77 SubName string `blueprint:"mutated"`
78
Ivan Lozanoc08897c2021-04-02 12:41:32 -040079 // SubName is used by CC for tracking image variants / SDK versions. RustSubName is used for Rust-specific
80 // subnaming which shouldn't be visible to CC modules (such as the rlib stdlinkage subname). This should be
81 // appended before SubName.
82 RustSubName string `blueprint:"mutated"`
83
Ivan Lozano6a884432020-12-02 09:15:16 -050084 // Set by imageMutator
Ivan Lozanoe6d30982021-02-05 10:57:43 -050085 CoreVariantNeeded bool `blueprint:"mutated"`
86 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
Matthew Maurerc6868382021-07-13 14:12:37 -070087 RamdiskVariantNeeded bool `blueprint:"mutated"`
Matthew Maurer460ee942021-02-11 12:31:46 -080088 RecoveryVariantNeeded bool `blueprint:"mutated"`
Ivan Lozanoe6d30982021-02-05 10:57:43 -050089 ExtraVariants []string `blueprint:"mutated"`
90
Ivan Lozanoa2268632021-07-22 10:52:06 -040091 // Allows this module to use non-APEX version of libraries. Useful
92 // for building binaries that are started before APEXes are activated.
93 Bootstrap *bool
94
Ivan Lozano1921e802021-05-20 13:39:16 -040095 // Used by vendor snapshot to record dependencies from snapshot modules.
96 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +090097 SnapshotStaticLibs []string `blueprint:"mutated"`
Ivan Lozano1921e802021-05-20 13:39:16 -040098
Matthew Maurerc6868382021-07-13 14:12:37 -070099 // Make this module available when building for ramdisk.
100 // On device without a dedicated recovery partition, the module is only
101 // available after switching root into
102 // /first_stage_ramdisk. To expose the module before switching root, install
103 // the recovery variant instead.
104 Ramdisk_available *bool
105
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500106 // Make this module available when building for vendor ramdisk.
107 // On device without a dedicated recovery partition, the module is only
108 // available after switching root into
109 // /first_stage_ramdisk. To expose the module before switching root, install
Matthew Maurer460ee942021-02-11 12:31:46 -0800110 // the recovery variant instead
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500111 Vendor_ramdisk_available *bool
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400112
Ivan Lozano1921e802021-05-20 13:39:16 -0400113 // Normally Soong uses the directory structure to decide which modules
114 // should be included (framework) or excluded (non-framework) from the
115 // different snapshots (vendor, recovery, etc.), but this property
116 // allows a partner to exclude a module normally thought of as a
117 // framework module from the vendor snapshot.
118 Exclude_from_vendor_snapshot *bool
119
120 // Normally Soong uses the directory structure to decide which modules
121 // should be included (framework) or excluded (non-framework) from the
122 // different snapshots (vendor, recovery, etc.), but this property
123 // allows a partner to exclude a module normally thought of as a
124 // framework module from the recovery snapshot.
125 Exclude_from_recovery_snapshot *bool
126
Matthew Maurer460ee942021-02-11 12:31:46 -0800127 // Make this module available when building for recovery
128 Recovery_available *bool
129
Ivan Lozano3e9f9e42020-12-04 15:05:43 -0500130 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
131 Min_sdk_version *string
132
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900133 HideFromMake bool `blueprint:"mutated"`
134 PreventInstall bool `blueprint:"mutated"`
135
136 Installable *bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700137}
138
139type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700140 fuzz.FuzzModule
Ivan Lozanoffee3342019-08-27 12:03:00 -0700141
Ivan Lozano6a884432020-12-02 09:15:16 -0500142 VendorProperties cc.VendorProperties
143
Ivan Lozanoffee3342019-08-27 12:03:00 -0700144 Properties BaseProperties
145
146 hod android.HostOrDeviceSupported
147 multilib android.Multilib
148
Ivan Lozano6a884432020-12-02 09:15:16 -0500149 makeLinkType string
150
Ivan Lozanoffee3342019-08-27 12:03:00 -0700151 compiler compiler
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400152 coverage *coverage
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200153 clippy *clippy
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500154 sanitize *sanitize
Ivan Lozanoffee3342019-08-27 12:03:00 -0700155 cachedToolchain config.Toolchain
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400156 sourceProvider SourceProvider
Andrei Homescuc7767922020-08-05 06:36:19 -0700157 subAndroidMkOnce map[SubAndroidMkProvider]bool
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400158
Jiyong Parke54f07e2021-04-07 15:08:04 +0900159 // Unstripped output. This is usually used when this module is linked to another module
160 // as a library. The stripped output which is used for installation can be found via
161 // compiler.strippedOutputFile if it exists.
162 unstrippedOutputFile android.OptionalPath
Dan Albert06feee92021-03-19 15:06:02 -0700163 docTimestampFile android.OptionalPath
Jiyong Park99644e92020-11-17 22:21:02 +0900164
165 hideApexVariantFromMake bool
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500166
167 // For apex variants, this is set as apex.min_sdk_version
168 apexSdkVersion android.ApiLevel
Ivan Lozanoffee3342019-08-27 12:03:00 -0700169}
170
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500171func (mod *Module) Header() bool {
172 //TODO: If Rust libraries provide header variants, this needs to be updated.
173 return false
174}
175
176func (mod *Module) SetPreventInstall() {
177 mod.Properties.PreventInstall = true
178}
179
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500180func (mod *Module) SetHideFromMake() {
181 mod.Properties.HideFromMake = true
182}
183
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900184func (mod *Module) HiddenFromMake() bool {
185 return mod.Properties.HideFromMake
Ivan Lozanod7586b62021-04-01 09:49:36 -0400186}
187
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500188func (mod *Module) SanitizePropDefined() bool {
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500189 // Because compiler is not set for some Rust modules where sanitize might be set, check that compiler is also not
190 // nil since we need compiler to actually sanitize.
191 return mod.sanitize != nil && mod.compiler != nil
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500192}
193
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500194func (mod *Module) IsPrebuilt() bool {
195 if _, ok := mod.compiler.(*prebuiltLibraryDecorator); ok {
196 return true
197 }
198 return false
199}
200
Ivan Lozano43845682020-07-09 21:03:28 -0400201func (mod *Module) OutputFiles(tag string) (android.Paths, error) {
202 switch tag {
203 case "":
Andrei Homescu5db69cc2020-08-06 15:27:45 -0700204 if mod.sourceProvider != nil && (mod.compiler == nil || mod.compiler.Disabled()) {
Ivan Lozano43845682020-07-09 21:03:28 -0400205 return mod.sourceProvider.Srcs(), nil
206 } else {
Jiyong Parke54f07e2021-04-07 15:08:04 +0900207 if mod.OutputFile().Valid() {
208 return android.Paths{mod.OutputFile().Path()}, nil
Ivan Lozano43845682020-07-09 21:03:28 -0400209 }
210 return android.Paths{}, nil
211 }
212 default:
213 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
214 }
215}
216
Ivan Lozano52767be2019-10-18 14:49:46 -0700217func (mod *Module) SelectedStl() string {
218 return ""
219}
220
Ivan Lozano2b262972019-11-21 12:30:50 -0800221func (mod *Module) NonCcVariants() bool {
222 if mod.compiler != nil {
Ivan Lozano89435d12020-07-31 11:01:18 -0400223 if _, ok := mod.compiler.(libraryInterface); ok {
224 return false
Ivan Lozano2b262972019-11-21 12:30:50 -0800225 }
226 }
227 panic(fmt.Errorf("NonCcVariants called on non-library module: %q", mod.BaseModuleName()))
228}
229
Ivan Lozano52767be2019-10-18 14:49:46 -0700230func (mod *Module) Static() bool {
231 if mod.compiler != nil {
232 if library, ok := mod.compiler.(libraryInterface); ok {
233 return library.static()
234 }
235 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400236 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700237}
238
239func (mod *Module) Shared() bool {
240 if mod.compiler != nil {
241 if library, ok := mod.compiler.(libraryInterface); ok {
Ivan Lozano89435d12020-07-31 11:01:18 -0400242 return library.shared()
Ivan Lozano52767be2019-10-18 14:49:46 -0700243 }
244 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400245 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700246}
247
Ivan Lozanod7586b62021-04-01 09:49:36 -0400248func (mod *Module) Dylib() bool {
249 if mod.compiler != nil {
250 if library, ok := mod.compiler.(libraryInterface); ok {
251 return library.dylib()
252 }
253 }
254 return false
255}
256
257func (mod *Module) Rlib() bool {
258 if mod.compiler != nil {
259 if library, ok := mod.compiler.(libraryInterface); ok {
260 return library.rlib()
261 }
262 }
263 return false
264}
265
266func (mod *Module) Binary() bool {
Ivan Lozano21fa0a52021-11-01 09:19:45 -0400267 if binary, ok := mod.compiler.(binaryInterface); ok {
268 return binary.binary()
Ivan Lozanod7586b62021-04-01 09:49:36 -0400269 }
270 return false
271}
272
Justin Yun5e035862021-06-29 20:50:37 +0900273func (mod *Module) StaticExecutable() bool {
274 if !mod.Binary() {
275 return false
276 }
Ivan Lozano21fa0a52021-11-01 09:19:45 -0400277 return mod.StaticallyLinked()
Justin Yun5e035862021-06-29 20:50:37 +0900278}
279
Ivan Lozanod7586b62021-04-01 09:49:36 -0400280func (mod *Module) Object() bool {
281 // Rust has no modules which produce only object files.
282 return false
283}
284
Ivan Lozano52767be2019-10-18 14:49:46 -0700285func (mod *Module) Toc() android.OptionalPath {
286 if mod.compiler != nil {
Ivan Lozano7b0781d2021-11-03 15:30:18 -0400287 if lib, ok := mod.compiler.(libraryInterface); ok {
288 return lib.toc()
Ivan Lozano52767be2019-10-18 14:49:46 -0700289 }
290 }
291 panic(fmt.Errorf("Toc() called on non-library module: %q", mod.BaseModuleName()))
292}
293
Colin Crossc511bc52020-04-07 16:50:32 +0000294func (mod *Module) UseSdk() bool {
295 return false
296}
297
Ivan Lozanod7586b62021-04-01 09:49:36 -0400298func (mod *Module) RelativeInstallPath() string {
299 if mod.compiler != nil {
300 return mod.compiler.relativeInstallPath()
301 }
302 return ""
303}
304
Ivan Lozano52767be2019-10-18 14:49:46 -0700305func (mod *Module) UseVndk() bool {
Ivan Lozano6a884432020-12-02 09:15:16 -0500306 return mod.Properties.VndkVersion != ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700307}
308
Jiyong Park7d55b612021-06-11 17:22:09 +0900309func (mod *Module) Bootstrap() bool {
Ivan Lozanoa2268632021-07-22 10:52:06 -0400310 return Bool(mod.Properties.Bootstrap)
Jiyong Park7d55b612021-06-11 17:22:09 +0900311}
312
Ivan Lozano52767be2019-10-18 14:49:46 -0700313func (mod *Module) MustUseVendorVariant() bool {
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400314 return true
315}
316
317func (mod *Module) SubName() string {
318 return mod.Properties.SubName
Ivan Lozano52767be2019-10-18 14:49:46 -0700319}
320
321func (mod *Module) IsVndk() bool {
Ivan Lozano6a884432020-12-02 09:15:16 -0500322 // TODO(b/165791368)
Ivan Lozano52767be2019-10-18 14:49:46 -0700323 return false
324}
325
Ivan Lozanof9e21722020-12-02 09:00:51 -0500326func (mod *Module) IsVndkExt() bool {
327 return false
328}
329
Ivan Lozanod7586b62021-04-01 09:49:36 -0400330func (mod *Module) IsVndkSp() bool {
331 return false
332}
333
Colin Cross127bb8b2020-12-16 16:46:01 -0800334func (c *Module) IsVndkPrivate() bool {
335 return false
336}
337
338func (c *Module) IsLlndk() bool {
339 return false
340}
341
342func (c *Module) IsLlndkPublic() bool {
Ivan Lozanof9e21722020-12-02 09:00:51 -0500343 return false
344}
345
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400346func (mod *Module) KernelHeadersDecorator() bool {
347 return false
348}
349
Colin Cross1f3f1302021-04-26 18:37:44 -0700350func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400351 return false
352}
353
Colin Cross5271fea2021-04-27 13:06:04 -0700354func (m *Module) NeedsVendorPublicLibraryVariants() bool {
355 return false
356}
357
Ivan Lozanod7586b62021-04-01 09:49:36 -0400358func (mod *Module) HasLlndkStubs() bool {
359 return false
360}
361
362func (mod *Module) StubsVersion() string {
363 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", mod.BaseModuleName()))
364}
365
Ivan Lozano52767be2019-10-18 14:49:46 -0700366func (mod *Module) SdkVersion() string {
367 return ""
368}
369
Jiyong Parkfdaa5f72021-03-19 22:18:04 +0900370func (mod *Module) MinSdkVersion() string {
371 return ""
372}
373
Colin Crossc511bc52020-04-07 16:50:32 +0000374func (mod *Module) AlwaysSdk() bool {
375 return false
376}
377
Jiyong Park2286afd2020-06-16 21:58:53 +0900378func (mod *Module) IsSdkVariant() bool {
379 return false
380}
381
Colin Cross1348ce32020-10-01 13:37:16 -0700382func (mod *Module) SplitPerApiLevel() bool {
383 return false
384}
385
Ivan Lozanoffee3342019-08-27 12:03:00 -0700386type Deps struct {
Ivan Lozano63bb7682021-03-23 15:53:44 -0400387 Dylibs []string
388 Rlibs []string
389 Rustlibs []string
390 Stdlibs []string
391 ProcMacros []string
392 SharedLibs []string
393 StaticLibs []string
394 WholeStaticLibs []string
395 HeaderLibs []string
Ivan Lozanoffee3342019-08-27 12:03:00 -0700396
397 CrtBegin, CrtEnd string
398}
399
400type PathDeps struct {
Ivan Lozanoec6e9912021-01-21 15:23:29 -0500401 DyLibs RustLibraries
402 RLibs RustLibraries
403 SharedLibs android.Paths
404 SharedLibDeps android.Paths
405 StaticLibs android.Paths
406 ProcMacros RustLibraries
Ivan Lozano3dfa12d2021-02-04 11:29:41 -0500407
408 // depFlags and depLinkFlags are rustc and linker (clang) flags.
409 depFlags []string
410 depLinkFlags []string
411
412 // linkDirs are link paths passed via -L to rustc. linkObjects are objects passed directly to the linker.
413 // Both of these are exported and propagate to dependencies.
414 linkDirs []string
415 linkObjects []string
Ivan Lozanof1c84332019-09-20 11:00:37 -0700416
Ivan Lozano45901ed2020-07-24 16:05:01 -0400417 // Used by bindgen modules which call clang
418 depClangFlags []string
419 depIncludePaths android.Paths
Ivan Lozanoddd0bdb2020-08-28 17:00:26 -0400420 depGeneratedHeaders android.Paths
Ivan Lozano45901ed2020-07-24 16:05:01 -0400421 depSystemIncludePaths android.Paths
422
Ivan Lozanof1c84332019-09-20 11:00:37 -0700423 CrtBegin android.OptionalPath
424 CrtEnd android.OptionalPath
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700425
426 // Paths to generated source files
Ivan Lozano9d74a522020-12-01 09:25:22 -0500427 SrcDeps android.Paths
428 srcProviderFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -0700429}
430
431type RustLibraries []RustLibrary
432
433type RustLibrary struct {
434 Path android.Path
435 CrateName string
436}
437
438type compiler interface {
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100439 initialize(ctx ModuleContext)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700440 compilerFlags(ctx ModuleContext, flags Flags) Flags
Ivan Lozano67eada32021-09-23 11:50:33 -0400441 cfgFlags(ctx ModuleContext, flags Flags) Flags
442 featureFlags(ctx ModuleContext, flags Flags) Flags
Ivan Lozanoffee3342019-08-27 12:03:00 -0700443 compilerProps() []interface{}
444 compile(ctx ModuleContext, flags Flags, deps PathDeps) android.Path
445 compilerDeps(ctx DepsContext, deps Deps) Deps
446 crateName() string
Dan Albert06feee92021-03-19 15:06:02 -0700447 rustdoc(ctx ModuleContext, flags Flags, deps PathDeps) android.OptionalPath
Ivan Lozanoffee3342019-08-27 12:03:00 -0700448
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100449 // Output directory in which source-generated code from dependencies is
450 // copied. This is equivalent to Cargo's OUT_DIR variable.
451 CargoOutDir() android.OptionalPath
Dan Albert06feee92021-03-19 15:06:02 -0700452
Ivan Lozanoa9a1fc02021-08-11 15:13:43 -0400453 // CargoPkgVersion returns the value of the Cargo_pkg_version property.
454 CargoPkgVersion() string
455
456 // CargoEnvCompat returns whether Cargo environment variables should be used.
457 CargoEnvCompat() bool
458
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -0800459 inData() bool
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +0200460 install(ctx ModuleContext)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700461 relativeInstallPath() string
Ivan Lozanod7586b62021-04-01 09:49:36 -0400462 everInstallable() bool
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400463
464 nativeCoverage() bool
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400465
466 Disabled() bool
467 SetDisabled()
Ivan Lozano042504f2020-08-18 14:31:23 -0400468
Ivan Lozanodd055472020-09-28 13:22:45 -0400469 stdLinkage(ctx *depsContext) RustLinkage
Jiyong Parke54f07e2021-04-07 15:08:04 +0900470
471 strippedOutputFilePath() android.OptionalPath
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400472}
473
Matthew Maurerbb3add12020-06-25 09:34:12 -0700474type exportedFlagsProducer interface {
Matthew Maurerbb3add12020-06-25 09:34:12 -0700475 exportLinkDirs(...string)
Ivan Lozano2093af22020-08-25 12:48:19 -0400476 exportLinkObjects(...string)
Matthew Maurerbb3add12020-06-25 09:34:12 -0700477}
478
479type flagExporter struct {
Ivan Lozano2093af22020-08-25 12:48:19 -0400480 linkDirs []string
481 linkObjects []string
Matthew Maurerbb3add12020-06-25 09:34:12 -0700482}
483
Matthew Maurerbb3add12020-06-25 09:34:12 -0700484func (flagExporter *flagExporter) exportLinkDirs(dirs ...string) {
485 flagExporter.linkDirs = android.FirstUniqueStrings(append(flagExporter.linkDirs, dirs...))
486}
487
Ivan Lozano2093af22020-08-25 12:48:19 -0400488func (flagExporter *flagExporter) exportLinkObjects(flags ...string) {
489 flagExporter.linkObjects = android.FirstUniqueStrings(append(flagExporter.linkObjects, flags...))
490}
491
Colin Cross0de8a1e2020-09-18 14:15:30 -0700492func (flagExporter *flagExporter) setProvider(ctx ModuleContext) {
493 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Colin Cross0de8a1e2020-09-18 14:15:30 -0700494 LinkDirs: flagExporter.linkDirs,
495 LinkObjects: flagExporter.linkObjects,
496 })
497}
498
Matthew Maurerbb3add12020-06-25 09:34:12 -0700499var _ exportedFlagsProducer = (*flagExporter)(nil)
500
501func NewFlagExporter() *flagExporter {
Colin Cross0de8a1e2020-09-18 14:15:30 -0700502 return &flagExporter{}
Matthew Maurerbb3add12020-06-25 09:34:12 -0700503}
504
Colin Cross0de8a1e2020-09-18 14:15:30 -0700505type FlagExporterInfo struct {
506 Flags []string
507 LinkDirs []string // TODO: this should be android.Paths
508 LinkObjects []string // TODO: this should be android.Paths
509}
510
511var FlagExporterInfoProvider = blueprint.NewProvider(FlagExporterInfo{})
512
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400513func (mod *Module) isCoverageVariant() bool {
514 return mod.coverage.Properties.IsCoverageVariant
515}
516
517var _ cc.Coverage = (*Module)(nil)
518
519func (mod *Module) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
520 return mod.coverage != nil && mod.coverage.Properties.NeedCoverageVariant
521}
522
Ivan Lozanod7586b62021-04-01 09:49:36 -0400523func (mod *Module) VndkVersion() string {
524 return mod.Properties.VndkVersion
525}
526
527func (mod *Module) PreventInstall() bool {
528 return mod.Properties.PreventInstall
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400529}
530
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400531func (mod *Module) MarkAsCoverageVariant(coverage bool) {
532 mod.coverage.Properties.IsCoverageVariant = coverage
533}
534
535func (mod *Module) EnableCoverageIfNeeded() {
536 mod.coverage.Properties.CoverageEnabled = mod.coverage.Properties.NeedCoverageBuild
Ivan Lozanoffee3342019-08-27 12:03:00 -0700537}
538
539func defaultsFactory() android.Module {
540 return DefaultsFactory()
541}
542
543type Defaults struct {
544 android.ModuleBase
545 android.DefaultsModuleBase
546}
547
548func DefaultsFactory(props ...interface{}) android.Module {
549 module := &Defaults{}
550
551 module.AddProperties(props...)
552 module.AddProperties(
553 &BaseProperties{},
Ivan Lozano6a884432020-12-02 09:15:16 -0500554 &cc.VendorProperties{},
Jakub Kotur1d640d02021-01-06 12:40:43 +0100555 &BenchmarkProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400556 &BindgenProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700557 &BaseCompilerProperties{},
558 &BinaryCompilerProperties{},
559 &LibraryCompilerProperties{},
560 &ProcMacroCompilerProperties{},
561 &PrebuiltProperties{},
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400562 &SourceProviderProperties{},
Chih-Hung Hsieh41805be2019-10-31 20:56:47 -0700563 &TestProperties{},
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400564 &cc.CoverageProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400565 &cc.RustBindgenClangProperties{},
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200566 &ClippyProperties{},
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500567 &SanitizeProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700568 )
569
570 android.InitDefaultsModule(module)
571 return module
572}
573
574func (mod *Module) CrateName() string {
Ivan Lozanoad8b18b2019-10-31 19:38:29 -0700575 return mod.compiler.crateName()
Ivan Lozanoffee3342019-08-27 12:03:00 -0700576}
577
Ivan Lozano183a3212019-10-18 14:18:45 -0700578func (mod *Module) CcLibrary() bool {
579 if mod.compiler != nil {
580 if _, ok := mod.compiler.(*libraryDecorator); ok {
581 return true
582 }
583 }
584 return false
585}
586
587func (mod *Module) CcLibraryInterface() bool {
588 if mod.compiler != nil {
Ivan Lozano89435d12020-07-31 11:01:18 -0400589 // use build{Static,Shared}() instead of {static,shared}() here because this might be called before
590 // VariantIs{Static,Shared} is set.
591 if lib, ok := mod.compiler.(libraryInterface); ok && (lib.buildShared() || lib.buildStatic()) {
Ivan Lozano183a3212019-10-18 14:18:45 -0700592 return true
593 }
594 }
595 return false
596}
597
Ivan Lozano39b0bf02021-10-14 12:22:09 -0400598func (mod *Module) UnstrippedOutputFile() android.Path {
599 if mod.unstrippedOutputFile.Valid() {
600 return mod.unstrippedOutputFile.Path()
601 }
602 return nil
603}
604
Ivan Lozanoe0833b12019-11-06 19:15:49 -0800605func (mod *Module) IncludeDirs() android.Paths {
Ivan Lozano183a3212019-10-18 14:18:45 -0700606 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700607 if library, ok := mod.compiler.(*libraryDecorator); ok {
Ivan Lozanoe0833b12019-11-06 19:15:49 -0800608 return library.includeDirs
Ivan Lozano183a3212019-10-18 14:18:45 -0700609 }
610 }
611 panic(fmt.Errorf("IncludeDirs called on non-library module: %q", mod.BaseModuleName()))
612}
613
614func (mod *Module) SetStatic() {
615 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700616 if library, ok := mod.compiler.(libraryInterface); ok {
617 library.setStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700618 return
619 }
620 }
621 panic(fmt.Errorf("SetStatic called on non-library module: %q", mod.BaseModuleName()))
622}
623
624func (mod *Module) SetShared() {
625 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700626 if library, ok := mod.compiler.(libraryInterface); ok {
627 library.setShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700628 return
629 }
630 }
631 panic(fmt.Errorf("SetShared called on non-library module: %q", mod.BaseModuleName()))
632}
633
Ivan Lozano183a3212019-10-18 14:18:45 -0700634func (mod *Module) BuildStaticVariant() bool {
635 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700636 if library, ok := mod.compiler.(libraryInterface); ok {
637 return library.buildStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700638 }
639 }
640 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", mod.BaseModuleName()))
641}
642
643func (mod *Module) BuildSharedVariant() bool {
644 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700645 if library, ok := mod.compiler.(libraryInterface); ok {
646 return library.buildShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700647 }
648 }
649 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", mod.BaseModuleName()))
650}
651
Ivan Lozano183a3212019-10-18 14:18:45 -0700652func (mod *Module) Module() android.Module {
653 return mod
654}
655
Ivan Lozano183a3212019-10-18 14:18:45 -0700656func (mod *Module) OutputFile() android.OptionalPath {
Jiyong Parke54f07e2021-04-07 15:08:04 +0900657 if mod.compiler != nil && mod.compiler.strippedOutputFilePath().Valid() {
658 return mod.compiler.strippedOutputFilePath()
659 }
660 return mod.unstrippedOutputFile
Ivan Lozano183a3212019-10-18 14:18:45 -0700661}
662
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400663func (mod *Module) CoverageFiles() android.Paths {
664 if mod.compiler != nil {
Joel Galensonfa049382021-01-14 16:03:18 -0800665 return android.Paths{}
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400666 }
667 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", mod.BaseModuleName()))
668}
669
Jiyong Park459feca2020-12-15 11:02:21 +0900670func (mod *Module) installable(apexInfo android.ApexInfo) bool {
Jiyong Park2811e072021-09-30 17:25:21 +0900671 if !proptools.BoolDefault(mod.Installable(), mod.EverInstallable()) {
Jiyong Parkbf8147a2021-05-17 13:19:33 +0900672 return false
673 }
674
Jiyong Park459feca2020-12-15 11:02:21 +0900675 // The apex variant is not installable because it is included in the APEX and won't appear
676 // in the system partition as a standalone file.
677 if !apexInfo.IsForPlatform() {
678 return false
679 }
680
Jiyong Parke54f07e2021-04-07 15:08:04 +0900681 return mod.OutputFile().Valid() && !mod.Properties.PreventInstall
Jiyong Park459feca2020-12-15 11:02:21 +0900682}
683
Ivan Lozanoe950cda2021-11-09 11:26:04 -0500684func (ctx moduleContext) apexVariationName() string {
685 return ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
686}
687
Ivan Lozano183a3212019-10-18 14:18:45 -0700688var _ cc.LinkableInterface = (*Module)(nil)
689
Ivan Lozanoffee3342019-08-27 12:03:00 -0700690func (mod *Module) Init() android.Module {
691 mod.AddProperties(&mod.Properties)
Ivan Lozano6a884432020-12-02 09:15:16 -0500692 mod.AddProperties(&mod.VendorProperties)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700693
694 if mod.compiler != nil {
695 mod.AddProperties(mod.compiler.compilerProps()...)
696 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400697 if mod.coverage != nil {
698 mod.AddProperties(mod.coverage.props()...)
699 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200700 if mod.clippy != nil {
701 mod.AddProperties(mod.clippy.props()...)
702 }
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400703 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -0700704 mod.AddProperties(mod.sourceProvider.SourceProviderProps()...)
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400705 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500706 if mod.sanitize != nil {
707 mod.AddProperties(mod.sanitize.props()...)
708 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400709
Ivan Lozanoffee3342019-08-27 12:03:00 -0700710 android.InitAndroidArchModule(mod, mod.hod, mod.multilib)
Jiyong Park99644e92020-11-17 22:21:02 +0900711 android.InitApexModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700712
713 android.InitDefaultableModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700714 return mod
715}
716
717func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
718 return &Module{
719 hod: hod,
720 multilib: multilib,
721 }
722}
723func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
724 module := newBaseModule(hod, multilib)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400725 module.coverage = &coverage{}
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200726 module.clippy = &clippy{}
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500727 module.sanitize = &sanitize{}
Ivan Lozanoffee3342019-08-27 12:03:00 -0700728 return module
729}
730
731type ModuleContext interface {
732 android.ModuleContext
733 ModuleContextIntf
734}
735
736type BaseModuleContext interface {
737 android.BaseModuleContext
738 ModuleContextIntf
739}
740
741type DepsContext interface {
742 android.BottomUpMutatorContext
743 ModuleContextIntf
744}
745
746type ModuleContextIntf interface {
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200747 RustModule() *Module
Ivan Lozanoffee3342019-08-27 12:03:00 -0700748 toolchain() config.Toolchain
Ivan Lozanoffee3342019-08-27 12:03:00 -0700749}
750
751type depsContext struct {
752 android.BottomUpMutatorContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700753}
754
755type moduleContext struct {
756 android.ModuleContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700757}
758
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200759type baseModuleContext struct {
760 android.BaseModuleContext
761}
762
763func (ctx *moduleContext) RustModule() *Module {
764 return ctx.Module().(*Module)
765}
766
767func (ctx *moduleContext) toolchain() config.Toolchain {
768 return ctx.RustModule().toolchain(ctx)
769}
770
771func (ctx *depsContext) RustModule() *Module {
772 return ctx.Module().(*Module)
773}
774
775func (ctx *depsContext) toolchain() config.Toolchain {
776 return ctx.RustModule().toolchain(ctx)
777}
778
779func (ctx *baseModuleContext) RustModule() *Module {
780 return ctx.Module().(*Module)
781}
782
783func (ctx *baseModuleContext) toolchain() config.Toolchain {
784 return ctx.RustModule().toolchain(ctx)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400785}
786
787func (mod *Module) nativeCoverage() bool {
Matthew Maurera61e31f2021-05-27 11:09:11 -0700788 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
789 if mod.Target().NativeBridge == android.NativeBridgeEnabled {
790 return false
791 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400792 return mod.compiler != nil && mod.compiler.nativeCoverage()
793}
794
Ivan Lozanod7586b62021-04-01 09:49:36 -0400795func (mod *Module) EverInstallable() bool {
796 return mod.compiler != nil &&
797 // Check to see whether the module is actually ever installable.
798 mod.compiler.everInstallable()
799}
800
801func (mod *Module) Installable() *bool {
802 return mod.Properties.Installable
803}
804
Ivan Lozanoffee3342019-08-27 12:03:00 -0700805func (mod *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
806 if mod.cachedToolchain == nil {
807 mod.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
808 }
809 return mod.cachedToolchain
810}
811
Thiébaud Weksteen31f1bb82020-08-27 13:37:29 +0200812func (mod *Module) ccToolchain(ctx android.BaseModuleContext) cc_config.Toolchain {
813 return cc_config.FindToolchain(ctx.Os(), ctx.Arch())
814}
815
Ivan Lozanoffee3342019-08-27 12:03:00 -0700816func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
817}
818
819func (mod *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
820 ctx := &moduleContext{
821 ModuleContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -0700822 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700823
Jiyong Park99644e92020-11-17 22:21:02 +0900824 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
825 if !apexInfo.IsForPlatform() {
826 mod.hideApexVariantFromMake = true
827 }
828
Ivan Lozanoffee3342019-08-27 12:03:00 -0700829 toolchain := mod.toolchain(ctx)
Ivan Lozano6a884432020-12-02 09:15:16 -0500830 mod.makeLinkType = cc.GetMakeLinkType(actx, mod)
831
832 // Differentiate static libraries that are vendor available
833 if mod.UseVndk() {
Matthew Maurer52af5b02021-05-27 10:01:36 -0700834 if mod.InProduct() && !mod.OnlyInProduct() {
835 mod.Properties.SubName += cc.ProductSuffix
836 } else {
837 mod.Properties.SubName += cc.VendorSuffix
838 }
Matthew Maurerc6868382021-07-13 14:12:37 -0700839 } else if mod.InRamdisk() && !mod.OnlyInRamdisk() {
840 mod.Properties.SubName += cc.RamdiskSuffix
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500841 } else if mod.InVendorRamdisk() && !mod.OnlyInVendorRamdisk() {
842 mod.Properties.SubName += cc.VendorRamdiskSuffix
Matthew Maurer460ee942021-02-11 12:31:46 -0800843 } else if mod.InRecovery() && !mod.OnlyInRecovery() {
844 mod.Properties.SubName += cc.RecoverySuffix
Ivan Lozano6a884432020-12-02 09:15:16 -0500845 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700846
Matthew Maurera61e31f2021-05-27 11:09:11 -0700847 if mod.Target().NativeBridge == android.NativeBridgeEnabled {
848 mod.Properties.SubName += cc.NativeBridgeSuffix
849 }
850
Ivan Lozanoffee3342019-08-27 12:03:00 -0700851 if !toolchain.Supported() {
852 // This toolchain's unsupported, there's nothing to do for this mod.
853 return
854 }
855
856 deps := mod.depsToPaths(ctx)
857 flags := Flags{
858 Toolchain: toolchain,
859 }
860
Ivan Lozano67eada32021-09-23 11:50:33 -0400861 // Calculate rustc flags
Ivan Lozanoffee3342019-08-27 12:03:00 -0700862 if mod.compiler != nil {
863 flags = mod.compiler.compilerFlags(ctx, flags)
Ivan Lozano67eada32021-09-23 11:50:33 -0400864 flags = mod.compiler.cfgFlags(ctx, flags)
865 flags = mod.compiler.featureFlags(ctx, flags)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400866 }
867 if mod.coverage != nil {
868 flags, deps = mod.coverage.flags(ctx, flags, deps)
869 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200870 if mod.clippy != nil {
871 flags, deps = mod.clippy.flags(ctx, flags, deps)
872 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500873 if mod.sanitize != nil {
874 flags, deps = mod.sanitize.flags(ctx, flags, deps)
875 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400876
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200877 // SourceProvider needs to call GenerateSource() before compiler calls
878 // compile() so it can provide the source. A SourceProvider has
879 // multiple variants (e.g. source, rlib, dylib). Only the "source"
880 // variant is responsible for effectively generating the source. The
881 // remaining variants relies on the "source" variant output.
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400882 if mod.sourceProvider != nil {
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200883 if mod.compiler.(libraryInterface).source() {
884 mod.sourceProvider.GenerateSource(ctx, deps)
885 mod.sourceProvider.setSubName(ctx.ModuleSubDir())
886 } else {
887 sourceMod := actx.GetDirectDepWithTag(mod.Name(), sourceDepTag)
888 sourceLib := sourceMod.(*Module).compiler.(*libraryDecorator)
Chih-Hung Hsiehc49649c2020-10-01 21:25:05 -0700889 mod.sourceProvider.setOutputFiles(sourceLib.sourceProvider.Srcs())
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200890 }
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400891 }
892
893 if mod.compiler != nil && !mod.compiler.Disabled() {
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100894 mod.compiler.initialize(ctx)
Jiyong Parke54f07e2021-04-07 15:08:04 +0900895 unstrippedOutputFile := mod.compiler.compile(ctx, flags, deps)
Jiyong Parke54f07e2021-04-07 15:08:04 +0900896 mod.unstrippedOutputFile = android.OptionalPathForPath(unstrippedOutputFile)
Thiébaud Weksteene4dd14b2021-04-14 11:18:47 +0200897 bloaty.MeasureSizeForPaths(ctx, mod.compiler.strippedOutputFilePath(), mod.unstrippedOutputFile)
Jiyong Park459feca2020-12-15 11:02:21 +0900898
Dan Albert06feee92021-03-19 15:06:02 -0700899 mod.docTimestampFile = mod.compiler.rustdoc(ctx, flags, deps)
900
Ivan Lozano1921e802021-05-20 13:39:16 -0400901 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
902 // RECOVERY_SNAPSHOT_VERSION is current.
903 if lib, ok := mod.compiler.(snapshotLibraryInterface); ok {
904 if cc.ShouldCollectHeadersForSnapshot(ctx, mod, apexInfo) {
905 lib.collectHeadersForSnapshot(ctx, deps)
906 }
907 }
908
Jiyong Park459feca2020-12-15 11:02:21 +0900909 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900910 if !proptools.BoolDefault(mod.Installable(), mod.EverInstallable()) {
911 // If the module has been specifically configure to not be installed then
912 // hide from make as otherwise it will break when running inside make as the
913 // output path to install will not be specified. Not all uninstallable
914 // modules can be hidden from make as some are needed for resolving make
915 // side dependencies.
916 mod.HideFromMake()
917 } else if !mod.installable(apexInfo) {
918 mod.SkipInstall()
919 }
920
921 // Still call install though, the installs will be stored as PackageSpecs to allow
922 // using the outputs in a genrule.
923 if mod.OutputFile().Valid() {
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +0200924 mod.compiler.install(ctx)
Jiyong Parkd1e366a2021-10-05 09:12:41 +0900925 if ctx.Failed() {
926 return
927 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400928 }
Chris Wailes74be7642021-07-22 16:20:28 -0700929
930 ctx.Phony("rust", ctx.RustModule().OutputFile().Path())
Ivan Lozanoffee3342019-08-27 12:03:00 -0700931 }
932}
933
934func (mod *Module) deps(ctx DepsContext) Deps {
935 deps := Deps{}
936
937 if mod.compiler != nil {
938 deps = mod.compiler.compilerDeps(ctx, deps)
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400939 }
940 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -0700941 deps = mod.sourceProvider.SourceProviderDeps(ctx, deps)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700942 }
943
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400944 if mod.coverage != nil {
945 deps = mod.coverage.deps(ctx, deps)
946 }
947
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500948 if mod.sanitize != nil {
949 deps = mod.sanitize.deps(ctx, deps)
950 }
951
Ivan Lozanoffee3342019-08-27 12:03:00 -0700952 deps.Rlibs = android.LastUniqueStrings(deps.Rlibs)
953 deps.Dylibs = android.LastUniqueStrings(deps.Dylibs)
Matthew Maurer0f003b12020-06-29 14:34:06 -0700954 deps.Rustlibs = android.LastUniqueStrings(deps.Rustlibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700955 deps.ProcMacros = android.LastUniqueStrings(deps.ProcMacros)
956 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
957 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
Ivan Lozano63bb7682021-03-23 15:53:44 -0400958 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700959 return deps
960
961}
962
Ivan Lozanoffee3342019-08-27 12:03:00 -0700963type dependencyTag struct {
964 blueprint.BaseDependencyTag
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800965 name string
966 library bool
967 procMacro bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700968}
969
Jiyong Park65b62242020-11-25 12:44:59 +0900970// InstallDepNeeded returns true for rlibs, dylibs, and proc macros so that they or their transitive
971// dependencies (especially C/C++ shared libs) are installed as dependencies of a rust binary.
972func (d dependencyTag) InstallDepNeeded() bool {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800973 return d.library || d.procMacro
Jiyong Park65b62242020-11-25 12:44:59 +0900974}
975
976var _ android.InstallNeededDependencyTag = dependencyTag{}
977
Ivan Lozanoffee3342019-08-27 12:03:00 -0700978var (
Ivan Lozanoc564d2d2020-08-04 15:43:37 -0400979 customBindgenDepTag = dependencyTag{name: "customBindgenTag"}
980 rlibDepTag = dependencyTag{name: "rlibTag", library: true}
981 dylibDepTag = dependencyTag{name: "dylib", library: true}
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800982 procMacroDepTag = dependencyTag{name: "procMacro", procMacro: true}
Ivan Lozanoc564d2d2020-08-04 15:43:37 -0400983 testPerSrcDepTag = dependencyTag{name: "rust_unit_tests"}
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200984 sourceDepTag = dependencyTag{name: "source"}
Ivan Lozanoffee3342019-08-27 12:03:00 -0700985)
986
Jiyong Park99644e92020-11-17 22:21:02 +0900987func IsDylibDepTag(depTag blueprint.DependencyTag) bool {
988 tag, ok := depTag.(dependencyTag)
989 return ok && tag == dylibDepTag
990}
991
Jiyong Park94e22fd2021-04-08 18:19:15 +0900992func IsRlibDepTag(depTag blueprint.DependencyTag) bool {
993 tag, ok := depTag.(dependencyTag)
994 return ok && tag == rlibDepTag
995}
996
Matthew Maurer0f003b12020-06-29 14:34:06 -0700997type autoDep struct {
998 variation string
999 depTag dependencyTag
1000}
1001
1002var (
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001003 rlibVariation = "rlib"
1004 dylibVariation = "dylib"
1005 rlibAutoDep = autoDep{variation: rlibVariation, depTag: rlibDepTag}
1006 dylibAutoDep = autoDep{variation: dylibVariation, depTag: dylibDepTag}
Matthew Maurer0f003b12020-06-29 14:34:06 -07001007)
1008
1009type autoDeppable interface {
Liz Kammer356f7d42021-01-26 09:18:53 -05001010 autoDep(ctx android.BottomUpMutatorContext) autoDep
Matthew Maurer0f003b12020-06-29 14:34:06 -07001011}
1012
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001013func (mod *Module) begin(ctx BaseModuleContext) {
1014 if mod.coverage != nil {
1015 mod.coverage.begin(ctx)
1016 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -05001017 if mod.sanitize != nil {
1018 mod.sanitize.begin(ctx)
1019 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001020}
1021
Ivan Lozanoffee3342019-08-27 12:03:00 -07001022func (mod *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
1023 var depPaths PathDeps
1024
1025 directRlibDeps := []*Module{}
1026 directDylibDeps := []*Module{}
1027 directProcMacroDeps := []*Module{}
Jiyong Park7d55b612021-06-11 17:22:09 +09001028 directSharedLibDeps := []cc.SharedLibraryInfo{}
Ivan Lozano52767be2019-10-18 14:49:46 -07001029 directStaticLibDeps := [](cc.LinkableInterface){}
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001030 directSrcProvidersDeps := []*Module{}
1031 directSrcDeps := [](android.SourceFileProducer){}
Ivan Lozanoffee3342019-08-27 12:03:00 -07001032
Ivan Lozanoe950cda2021-11-09 11:26:04 -05001033 // For the dependency from platform to apex, use the latest stubs
1034 mod.apexSdkVersion = android.FutureApiLevel
1035 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1036 if !apexInfo.IsForPlatform() {
1037 mod.apexSdkVersion = apexInfo.MinSdkVersion
1038 }
1039
1040 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
1041 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
1042 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
1043 // (b/144430859)
1044 mod.apexSdkVersion = android.FutureApiLevel
1045 }
1046
Ivan Lozanoffee3342019-08-27 12:03:00 -07001047 ctx.VisitDirectDeps(func(dep android.Module) {
1048 depName := ctx.OtherModuleName(dep)
1049 depTag := ctx.OtherModuleDependencyTag(dep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001050
Ivan Lozano89435d12020-07-31 11:01:18 -04001051 if rustDep, ok := dep.(*Module); ok && !rustDep.CcLibraryInterface() {
Ivan Lozanoffee3342019-08-27 12:03:00 -07001052 //Handle Rust Modules
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001053 makeLibName := cc.MakeLibName(ctx, mod, rustDep, depName+rustDep.Properties.RustSubName)
Ivan Lozano70e0a072019-09-13 14:23:15 -07001054
Ivan Lozanoffee3342019-08-27 12:03:00 -07001055 switch depTag {
1056 case dylibDepTag:
1057 dylib, ok := rustDep.compiler.(libraryInterface)
1058 if !ok || !dylib.dylib() {
1059 ctx.ModuleErrorf("mod %q not an dylib library", depName)
1060 return
1061 }
1062 directDylibDeps = append(directDylibDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001063 mod.Properties.AndroidMkDylibs = append(mod.Properties.AndroidMkDylibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001064 case rlibDepTag:
Ivan Lozano2b081132020-09-08 12:46:52 -04001065
Ivan Lozanoffee3342019-08-27 12:03:00 -07001066 rlib, ok := rustDep.compiler.(libraryInterface)
1067 if !ok || !rlib.rlib() {
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001068 ctx.ModuleErrorf("mod %q not an rlib library", makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001069 return
1070 }
1071 directRlibDeps = append(directRlibDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001072 mod.Properties.AndroidMkRlibs = append(mod.Properties.AndroidMkRlibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001073 case procMacroDepTag:
1074 directProcMacroDeps = append(directProcMacroDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001075 mod.Properties.AndroidMkProcMacroLibs = append(mod.Properties.AndroidMkProcMacroLibs, makeLibName)
Paul Duffind5cf92e2021-07-09 17:38:55 +01001076 }
1077
1078 if android.IsSourceDepTagWithOutputTag(depTag, "") {
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001079 // Since these deps are added in path_properties.go via AddDependencies, we need to ensure the correct
1080 // OS/Arch variant is used.
1081 var helper string
1082 if ctx.Host() {
1083 helper = "missing 'host_supported'?"
1084 } else {
1085 helper = "device module defined?"
1086 }
1087
1088 if dep.Target().Os != ctx.Os() {
1089 ctx.ModuleErrorf("OS mismatch on dependency %q (%s)", dep.Name(), helper)
1090 return
1091 } else if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
1092 ctx.ModuleErrorf("Arch mismatch on dependency %q (%s)", dep.Name(), helper)
1093 return
1094 }
1095 directSrcProvidersDeps = append(directSrcProvidersDeps, rustDep)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001096 }
1097
Ivan Lozano2bbcacf2020-08-07 09:00:50 -04001098 //Append the dependencies exportedDirs, except for proc-macros which target a different arch/OS
Colin Cross0de8a1e2020-09-18 14:15:30 -07001099 if depTag != procMacroDepTag {
1100 exportedInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
1101 depPaths.linkDirs = append(depPaths.linkDirs, exportedInfo.LinkDirs...)
1102 depPaths.depFlags = append(depPaths.depFlags, exportedInfo.Flags...)
1103 depPaths.linkObjects = append(depPaths.linkObjects, exportedInfo.LinkObjects...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001104 }
1105
Ivan Lozanoffee3342019-08-27 12:03:00 -07001106 if depTag == dylibDepTag || depTag == rlibDepTag || depTag == procMacroDepTag {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001107 linkFile := rustDep.unstrippedOutputFile
Ivan Lozano26ecd6c2020-07-31 13:40:31 -04001108 if !linkFile.Valid() {
1109 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q",
1110 depName, ctx.ModuleName())
1111 return
1112 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001113 linkDir := linkPathFromFilePath(linkFile.Path())
Matthew Maurerbb3add12020-06-25 09:34:12 -07001114 if lib, ok := mod.compiler.(exportedFlagsProducer); ok {
1115 lib.exportLinkDirs(linkDir)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001116 }
1117 }
1118
Ivan Lozano89435d12020-07-31 11:01:18 -04001119 } else if ccDep, ok := dep.(cc.LinkableInterface); ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07001120 //Handle C dependencies
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001121 makeLibName := cc.MakeLibName(ctx, mod, ccDep, depName)
Ivan Lozano52767be2019-10-18 14:49:46 -07001122 if _, ok := ccDep.(*Module); !ok {
1123 if ccDep.Module().Target().Os != ctx.Os() {
1124 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
1125 return
1126 }
1127 if ccDep.Module().Target().Arch.ArchType != ctx.Arch().ArchType {
1128 ctx.ModuleErrorf("Arch mismatch between %q and %q", ctx.ModuleName(), depName)
1129 return
1130 }
Ivan Lozano70e0a072019-09-13 14:23:15 -07001131 }
Ivan Lozano2093af22020-08-25 12:48:19 -04001132 linkObject := ccDep.OutputFile()
1133 linkPath := linkPathFromFilePath(linkObject.Path())
Ivan Lozano6aa66022020-02-06 13:22:43 -05001134
Ivan Lozano2093af22020-08-25 12:48:19 -04001135 if !linkObject.Valid() {
Ivan Lozanoffee3342019-08-27 12:03:00 -07001136 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q", depName, ctx.ModuleName())
1137 }
1138
1139 exportDep := false
Colin Cross6e511a92020-07-27 21:26:48 -07001140 switch {
1141 case cc.IsStaticDepTag(depTag):
Ivan Lozano63bb7682021-03-23 15:53:44 -04001142 if cc.IsWholeStaticLib(depTag) {
1143 // rustc will bundle static libraries when they're passed with "-lstatic=<lib>". This will fail
1144 // if the library is not prefixed by "lib".
Ivan Lozanofdadcd72021-11-01 09:04:23 -04001145 if mod.Binary() {
1146 // Binaries may sometimes need to link whole static libraries that don't start with 'lib'.
1147 // Since binaries don't need to 'rebundle' these like libraries and only use these for the
1148 // final linkage, pass the args directly to the linker to handle these cases.
1149 depPaths.depLinkFlags = append(depPaths.depLinkFlags, []string{"-Wl,--whole-archive", linkObject.Path().String(), "-Wl,--no-whole-archive"}...)
1150 } else if libName, ok := libNameFromFilePath(linkObject.Path()); ok {
Ivan Lozanofb6f36f2021-02-05 12:27:08 -05001151 depPaths.depFlags = append(depPaths.depFlags, "-lstatic="+libName)
Ivan Lozano63bb7682021-03-23 15:53:44 -04001152 } else {
1153 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 -05001154 }
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001155 }
1156
1157 // Add this to linkObjects to pass the library directly to the linker as well. This propagates
1158 // to dependencies to avoid having to redeclare static libraries for dependents of the dylib variant.
Ivan Lozano2093af22020-08-25 12:48:19 -04001159 depPaths.linkObjects = append(depPaths.linkObjects, linkObject.String())
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001160 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
1161
Colin Cross0de8a1e2020-09-18 14:15:30 -07001162 exportedInfo := ctx.OtherModuleProvider(dep, cc.FlagExporterInfoProvider).(cc.FlagExporterInfo)
1163 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1164 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1165 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1166 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001167 directStaticLibDeps = append(directStaticLibDeps, ccDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001168 mod.Properties.AndroidMkStaticLibs = append(mod.Properties.AndroidMkStaticLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07001169 case cc.IsSharedDepTag(depTag):
Jiyong Park7d55b612021-06-11 17:22:09 +09001170 // For the shared lib dependencies, we may link to the stub variant
1171 // of the dependency depending on the context (e.g. if this
1172 // dependency crosses the APEX boundaries).
1173 sharedLibraryInfo, exportedInfo := cc.ChooseStubOrImpl(ctx, dep)
1174
1175 // Re-get linkObject as ChooseStubOrImpl actually tells us which
1176 // object (either from stub or non-stub) to use.
1177 linkObject = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
1178 linkPath = linkPathFromFilePath(linkObject.Path())
1179
Ivan Lozanoffee3342019-08-27 12:03:00 -07001180 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
Ivan Lozano2093af22020-08-25 12:48:19 -04001181 depPaths.linkObjects = append(depPaths.linkObjects, linkObject.String())
Colin Cross0de8a1e2020-09-18 14:15:30 -07001182 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1183 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1184 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1185 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Jiyong Park7d55b612021-06-11 17:22:09 +09001186 directSharedLibDeps = append(directSharedLibDeps, sharedLibraryInfo)
Ivan Lozano1921e802021-05-20 13:39:16 -04001187
1188 // Record baseLibName for snapshots.
1189 mod.Properties.SnapshotSharedLibs = append(mod.Properties.SnapshotSharedLibs, cc.BaseLibName(depName))
Justin Yun5e035862021-06-29 20:50:37 +09001190 mod.Properties.SnapshotStaticLibs = append(mod.Properties.SnapshotStaticLibs, cc.BaseLibName(depName))
Ivan Lozano1921e802021-05-20 13:39:16 -04001191
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001192 mod.Properties.AndroidMkSharedLibs = append(mod.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001193 exportDep = true
Zach Johnson3df4e632020-11-06 11:56:27 -08001194 case cc.IsHeaderDepTag(depTag):
1195 exportedInfo := ctx.OtherModuleProvider(dep, cc.FlagExporterInfoProvider).(cc.FlagExporterInfo)
1196 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1197 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1198 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Colin Cross6e511a92020-07-27 21:26:48 -07001199 case depTag == cc.CrtBeginDepTag:
Ivan Lozano2093af22020-08-25 12:48:19 -04001200 depPaths.CrtBegin = linkObject
Colin Cross6e511a92020-07-27 21:26:48 -07001201 case depTag == cc.CrtEndDepTag:
Ivan Lozano2093af22020-08-25 12:48:19 -04001202 depPaths.CrtEnd = linkObject
Ivan Lozanoffee3342019-08-27 12:03:00 -07001203 }
1204
1205 // Make sure these dependencies are propagated
Matthew Maurerbb3add12020-06-25 09:34:12 -07001206 if lib, ok := mod.compiler.(exportedFlagsProducer); ok && exportDep {
1207 lib.exportLinkDirs(linkPath)
Ivan Lozano2093af22020-08-25 12:48:19 -04001208 lib.exportLinkObjects(linkObject.String())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001209 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001210 }
Ivan Lozano89435d12020-07-31 11:01:18 -04001211
1212 if srcDep, ok := dep.(android.SourceFileProducer); ok {
Paul Duffind5cf92e2021-07-09 17:38:55 +01001213 if android.IsSourceDepTagWithOutputTag(depTag, "") {
Ivan Lozano89435d12020-07-31 11:01:18 -04001214 // These are usually genrules which don't have per-target variants.
1215 directSrcDeps = append(directSrcDeps, srcDep)
1216 }
1217 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001218 })
1219
1220 var rlibDepFiles RustLibraries
1221 for _, dep := range directRlibDeps {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001222 rlibDepFiles = append(rlibDepFiles, RustLibrary{Path: dep.unstrippedOutputFile.Path(), CrateName: dep.CrateName()})
Ivan Lozanoffee3342019-08-27 12:03:00 -07001223 }
1224 var dylibDepFiles RustLibraries
1225 for _, dep := range directDylibDeps {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001226 dylibDepFiles = append(dylibDepFiles, RustLibrary{Path: dep.unstrippedOutputFile.Path(), CrateName: dep.CrateName()})
Ivan Lozanoffee3342019-08-27 12:03:00 -07001227 }
1228 var procMacroDepFiles RustLibraries
1229 for _, dep := range directProcMacroDeps {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001230 procMacroDepFiles = append(procMacroDepFiles, RustLibrary{Path: dep.unstrippedOutputFile.Path(), CrateName: dep.CrateName()})
Ivan Lozanoffee3342019-08-27 12:03:00 -07001231 }
1232
1233 var staticLibDepFiles android.Paths
1234 for _, dep := range directStaticLibDeps {
1235 staticLibDepFiles = append(staticLibDepFiles, dep.OutputFile().Path())
1236 }
1237
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001238 var sharedLibFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -07001239 var sharedLibDepFiles android.Paths
1240 for _, dep := range directSharedLibDeps {
Jiyong Park7d55b612021-06-11 17:22:09 +09001241 sharedLibFiles = append(sharedLibFiles, dep.SharedLibrary)
1242 if dep.TableOfContents.Valid() {
1243 sharedLibDepFiles = append(sharedLibDepFiles, dep.TableOfContents.Path())
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001244 } else {
Jiyong Park7d55b612021-06-11 17:22:09 +09001245 sharedLibDepFiles = append(sharedLibDepFiles, dep.SharedLibrary)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001246 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001247 }
1248
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001249 var srcProviderDepFiles android.Paths
1250 for _, dep := range directSrcProvidersDeps {
1251 srcs, _ := dep.OutputFiles("")
1252 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1253 }
1254 for _, dep := range directSrcDeps {
1255 srcs := dep.Srcs()
1256 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1257 }
1258
Ivan Lozanoffee3342019-08-27 12:03:00 -07001259 depPaths.RLibs = append(depPaths.RLibs, rlibDepFiles...)
1260 depPaths.DyLibs = append(depPaths.DyLibs, dylibDepFiles...)
1261 depPaths.SharedLibs = append(depPaths.SharedLibs, sharedLibDepFiles...)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001262 depPaths.SharedLibDeps = append(depPaths.SharedLibDeps, sharedLibDepFiles...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001263 depPaths.StaticLibs = append(depPaths.StaticLibs, staticLibDepFiles...)
1264 depPaths.ProcMacros = append(depPaths.ProcMacros, procMacroDepFiles...)
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001265 depPaths.SrcDeps = append(depPaths.SrcDeps, srcProviderDepFiles...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001266
1267 // Dedup exported flags from dependencies
1268 depPaths.linkDirs = android.FirstUniqueStrings(depPaths.linkDirs)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001269 depPaths.linkObjects = android.FirstUniqueStrings(depPaths.linkObjects)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001270 depPaths.depFlags = android.FirstUniqueStrings(depPaths.depFlags)
Ivan Lozano45901ed2020-07-24 16:05:01 -04001271 depPaths.depClangFlags = android.FirstUniqueStrings(depPaths.depClangFlags)
1272 depPaths.depIncludePaths = android.FirstUniquePaths(depPaths.depIncludePaths)
1273 depPaths.depSystemIncludePaths = android.FirstUniquePaths(depPaths.depSystemIncludePaths)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001274
1275 return depPaths
1276}
1277
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -08001278func (mod *Module) InstallInData() bool {
1279 if mod.compiler == nil {
1280 return false
1281 }
1282 return mod.compiler.inData()
1283}
1284
Matthew Maurer9f59e8d2021-08-19 13:10:05 -07001285func (mod *Module) InstallInRamdisk() bool {
1286 return mod.InRamdisk()
1287}
1288
1289func (mod *Module) InstallInVendorRamdisk() bool {
1290 return mod.InVendorRamdisk()
1291}
1292
1293func (mod *Module) InstallInRecovery() bool {
1294 return mod.InRecovery()
1295}
1296
Colin Cross77435572021-11-08 12:37:01 -08001297func (mod *Module) InstallBypassMake() bool {
1298 return true
1299}
1300
Ivan Lozanoffee3342019-08-27 12:03:00 -07001301func linkPathFromFilePath(filepath android.Path) string {
1302 return strings.Split(filepath.String(), filepath.Base())[0]
1303}
Ivan Lozanod648c432020-02-06 12:05:10 -05001304
Ivan Lozanoffee3342019-08-27 12:03:00 -07001305func (mod *Module) DepsMutator(actx android.BottomUpMutatorContext) {
1306 ctx := &depsContext{
1307 BottomUpMutatorContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -07001308 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001309
1310 deps := mod.deps(ctx)
Colin Cross3146c5c2020-09-30 15:34:40 -07001311 var commonDepVariations []blueprint.Variation
Ivan Lozano1921e802021-05-20 13:39:16 -04001312 var snapshotInfo *cc.SnapshotInfo
1313
1314 if ctx.Os() == android.Android {
1315 deps.SharedLibs, _ = cc.RewriteLibs(mod, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
1316 }
Ivan Lozanodd055472020-09-28 13:22:45 -04001317
Ivan Lozano2b081132020-09-08 12:46:52 -04001318 stdLinkage := "dylib-std"
Ivan Lozanodd055472020-09-28 13:22:45 -04001319 if mod.compiler.stdLinkage(ctx) == RlibLinkage {
Ivan Lozano2b081132020-09-08 12:46:52 -04001320 stdLinkage = "rlib-std"
1321 }
1322
1323 rlibDepVariations := commonDepVariations
Ivan Lozano1921e802021-05-20 13:39:16 -04001324
Ivan Lozano2b081132020-09-08 12:46:52 -04001325 if lib, ok := mod.compiler.(libraryInterface); !ok || !lib.sysroot() {
1326 rlibDepVariations = append(rlibDepVariations,
1327 blueprint.Variation{Mutator: "rust_stdlinkage", Variation: stdLinkage})
1328 }
1329
Ivan Lozano1921e802021-05-20 13:39:16 -04001330 // rlibs
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001331 for _, lib := range deps.Rlibs {
1332 depTag := rlibDepTag
1333 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).Rlibs)
1334
1335 actx.AddVariationDependencies(append(rlibDepVariations, []blueprint.Variation{
1336 {Mutator: "rust_libraries", Variation: rlibVariation},
1337 }...), depTag, lib)
1338 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001339
1340 // dylibs
Ivan Lozano52767be2019-10-18 14:49:46 -07001341 actx.AddVariationDependencies(
1342 append(commonDepVariations, []blueprint.Variation{
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001343 {Mutator: "rust_libraries", Variation: dylibVariation}}...),
Ivan Lozano52767be2019-10-18 14:49:46 -07001344 dylibDepTag, deps.Dylibs...)
1345
Ivan Lozano1921e802021-05-20 13:39:16 -04001346 // rustlibs
Ivan Lozano042504f2020-08-18 14:31:23 -04001347 if deps.Rustlibs != nil && !mod.compiler.Disabled() {
1348 autoDep := mod.compiler.(autoDeppable).autoDep(ctx)
Ivan Lozano2b081132020-09-08 12:46:52 -04001349 if autoDep.depTag == rlibDepTag {
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001350 for _, lib := range deps.Rustlibs {
1351 depTag := autoDep.depTag
1352 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).Rlibs)
1353 actx.AddVariationDependencies(append(rlibDepVariations, []blueprint.Variation{
1354 {Mutator: "rust_libraries", Variation: autoDep.variation},
1355 }...), depTag, lib)
1356 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001357 } else {
1358 actx.AddVariationDependencies(
1359 append(commonDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: autoDep.variation}),
1360 autoDep.depTag, deps.Rustlibs...)
1361 }
Matthew Maurer0f003b12020-06-29 14:34:06 -07001362 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001363
1364 // stdlibs
Ivan Lozano2b081132020-09-08 12:46:52 -04001365 if deps.Stdlibs != nil {
Ivan Lozanodd055472020-09-28 13:22:45 -04001366 if mod.compiler.stdLinkage(ctx) == RlibLinkage {
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001367 for _, lib := range deps.Stdlibs {
1368 depTag := rlibDepTag
1369 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).Rlibs)
1370
1371 actx.AddVariationDependencies(append(commonDepVariations, []blueprint.Variation{{Mutator: "rust_libraries", Variation: "rlib"}}...),
1372 depTag, lib)
1373 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001374 } else {
1375 actx.AddVariationDependencies(
1376 append(commonDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: "dylib"}),
1377 dylibDepTag, deps.Stdlibs...)
1378 }
1379 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001380
1381 for _, lib := range deps.SharedLibs {
1382 depTag := cc.SharedDepTag()
1383 name, version := cc.StubsLibNameAndVersion(lib)
1384
1385 variations := []blueprint.Variation{
1386 {Mutator: "link", Variation: "shared"},
1387 }
1388 cc.AddSharedLibDependenciesWithVersions(ctx, mod, variations, depTag, name, version, false)
1389 }
1390
1391 for _, lib := range deps.WholeStaticLibs {
1392 depTag := cc.StaticDepTag(true)
1393 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).StaticLibs)
1394
1395 actx.AddVariationDependencies([]blueprint.Variation{
1396 {Mutator: "link", Variation: "static"},
1397 }, depTag, lib)
1398 }
1399
1400 for _, lib := range deps.StaticLibs {
1401 depTag := cc.StaticDepTag(false)
1402 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).StaticLibs)
1403
1404 actx.AddVariationDependencies([]blueprint.Variation{
1405 {Mutator: "link", Variation: "static"},
1406 }, depTag, lib)
1407 }
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07001408
Zach Johnson3df4e632020-11-06 11:56:27 -08001409 actx.AddVariationDependencies(nil, cc.HeaderDepTag(), deps.HeaderLibs...)
1410
Colin Cross565cafd2020-09-25 18:47:38 -07001411 crtVariations := cc.GetCrtVariations(ctx, mod)
Ivan Lozanof1c84332019-09-20 11:00:37 -07001412 if deps.CrtBegin != "" {
Ivan Lozano1921e802021-05-20 13:39:16 -04001413 actx.AddVariationDependencies(crtVariations, cc.CrtBeginDepTag,
1414 cc.RewriteSnapshotLib(deps.CrtBegin, cc.GetSnapshot(mod, &snapshotInfo, actx).Objects))
Ivan Lozanof1c84332019-09-20 11:00:37 -07001415 }
1416 if deps.CrtEnd != "" {
Ivan Lozano1921e802021-05-20 13:39:16 -04001417 actx.AddVariationDependencies(crtVariations, cc.CrtEndDepTag,
1418 cc.RewriteSnapshotLib(deps.CrtEnd, cc.GetSnapshot(mod, &snapshotInfo, actx).Objects))
Ivan Lozanof1c84332019-09-20 11:00:37 -07001419 }
1420
Ivan Lozanoc564d2d2020-08-04 15:43:37 -04001421 if mod.sourceProvider != nil {
1422 if bindgen, ok := mod.sourceProvider.(*bindgenDecorator); ok &&
1423 bindgen.Properties.Custom_bindgen != "" {
1424 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), customBindgenDepTag,
1425 bindgen.Properties.Custom_bindgen)
1426 }
1427 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001428
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07001429 // proc_macros are compiler plugins, and so we need the host arch variant as a dependendcy.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001430 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), procMacroDepTag, deps.ProcMacros...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001431}
1432
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001433func BeginMutator(ctx android.BottomUpMutatorContext) {
1434 if mod, ok := ctx.Module().(*Module); ok && mod.Enabled() {
1435 mod.beginMutator(ctx)
1436 }
1437}
1438
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001439func (mod *Module) beginMutator(actx android.BottomUpMutatorContext) {
1440 ctx := &baseModuleContext{
1441 BaseModuleContext: actx,
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001442 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001443
1444 mod.begin(ctx)
1445}
1446
Ivan Lozanoffee3342019-08-27 12:03:00 -07001447func (mod *Module) Name() string {
1448 name := mod.ModuleBase.Name()
1449 if p, ok := mod.compiler.(interface {
1450 Name(string) string
1451 }); ok {
1452 name = p.Name(name)
1453 }
1454 return name
1455}
1456
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02001457func (mod *Module) disableClippy() {
Ivan Lozano32267c82020-08-04 16:27:16 -04001458 if mod.clippy != nil {
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02001459 mod.clippy.Properties.Clippy_lints = proptools.StringPtr("none")
Ivan Lozano32267c82020-08-04 16:27:16 -04001460 }
1461}
1462
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07001463var _ android.HostToolProvider = (*Module)(nil)
1464
1465func (mod *Module) HostToolPath() android.OptionalPath {
1466 if !mod.Host() {
1467 return android.OptionalPath{}
1468 }
Chih-Hung Hsieha7562702020-08-10 21:50:43 -07001469 if binary, ok := mod.compiler.(*binaryDecorator); ok {
1470 return android.OptionalPathForPath(binary.baseCompiler.path)
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07001471 }
1472 return android.OptionalPath{}
1473}
1474
Jiyong Park99644e92020-11-17 22:21:02 +09001475var _ android.ApexModule = (*Module)(nil)
1476
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05001477func (mod *Module) minSdkVersion() string {
1478 return String(mod.Properties.Min_sdk_version)
1479}
1480
Jiyong Park45bf82e2020-12-15 22:29:02 +09001481var _ android.ApexModule = (*Module)(nil)
1482
1483// Implements android.ApexModule
Jiyong Park99644e92020-11-17 22:21:02 +09001484func (mod *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05001485 minSdkVersion := mod.minSdkVersion()
1486 if minSdkVersion == "apex_inherit" {
1487 return nil
1488 }
1489 if minSdkVersion == "" {
1490 return fmt.Errorf("min_sdk_version is not specificed")
1491 }
1492
1493 // Not using nativeApiLevelFromUser because the context here is not
1494 // necessarily a native context.
1495 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1496 if err != nil {
1497 return err
1498 }
1499
1500 if ver.GreaterThan(sdkVersion) {
1501 return fmt.Errorf("newer SDK(%v)", ver)
1502 }
Jiyong Park99644e92020-11-17 22:21:02 +09001503 return nil
1504}
1505
Jiyong Park45bf82e2020-12-15 22:29:02 +09001506// Implements android.ApexModule
Jiyong Park99644e92020-11-17 22:21:02 +09001507func (mod *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1508 depTag := ctx.OtherModuleDependencyTag(dep)
1509
1510 if ccm, ok := dep.(*cc.Module); ok {
1511 if ccm.HasStubsVariants() {
1512 if cc.IsSharedDepTag(depTag) {
1513 // dynamic dep to a stubs lib crosses APEX boundary
1514 return false
1515 }
1516 if cc.IsRuntimeDepTag(depTag) {
1517 // runtime dep to a stubs lib also crosses APEX boundary
1518 return false
1519 }
1520
1521 if cc.IsHeaderDepTag(depTag) {
1522 return false
1523 }
1524 }
1525 if mod.Static() && cc.IsSharedDepTag(depTag) {
1526 // shared_lib dependency from a static lib is considered as crossing
1527 // the APEX boundary because the dependency doesn't actually is
1528 // linked; the dependency is used only during the compilation phase.
1529 return false
1530 }
1531 }
1532
1533 if depTag == procMacroDepTag {
1534 return false
1535 }
1536
1537 return true
1538}
1539
1540// Overrides ApexModule.IsInstallabeToApex()
1541func (mod *Module) IsInstallableToApex() bool {
1542 if mod.compiler != nil {
1543 if lib, ok := mod.compiler.(*libraryDecorator); ok && (lib.shared() || lib.dylib()) {
1544 return true
1545 }
1546 if _, ok := mod.compiler.(*binaryDecorator); ok {
1547 return true
1548 }
1549 }
1550 return false
1551}
1552
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001553// If a library file has a "lib" prefix, extract the library name without the prefix.
1554func libNameFromFilePath(filepath android.Path) (string, bool) {
1555 libName := strings.TrimSuffix(filepath.Base(), filepath.Ext())
1556 if strings.HasPrefix(libName, "lib") {
1557 libName = libName[3:]
1558 return libName, true
1559 }
1560 return "", false
1561}
1562
Ivan Lozanoffee3342019-08-27 12:03:00 -07001563var Bool = proptools.Bool
1564var BoolDefault = proptools.BoolDefault
1565var String = proptools.String
1566var StringPtr = proptools.StringPtr
Ivan Lozano43845682020-07-09 21:03:28 -04001567
1568var _ android.OutputFileProducer = (*Module)(nil)