blob: 0a9869fdc11645f0c0b89564688ccd5421f36c2e [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"
Ivan Lozanoffee3342019-08-27 12:03:00 -070028 "android/soong/rust/config"
29)
30
31var pctx = android.NewPackageContext("android/soong/rust")
32
33func init() {
34 // Only allow rust modules to be defined for certain projects
Ivan Lozanoffee3342019-08-27 12:03:00 -070035
36 android.AddNeverAllowRules(
37 android.NeverAllow().
Ivan Lozano03a94c42021-06-28 11:27:11 -040038 NotIn(append(config.RustAllowedPaths, config.DownstreamRustAllowedPaths...)...).
Ivan Lozanoe169ad72019-09-18 08:42:54 -070039 ModuleType(config.RustModuleTypes...))
Ivan Lozanoffee3342019-08-27 12:03:00 -070040
41 android.RegisterModuleType("rust_defaults", defaultsFactory)
42 android.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
43 ctx.BottomUp("rust_libraries", LibraryMutator).Parallel()
Ivan Lozano2b081132020-09-08 12:46:52 -040044 ctx.BottomUp("rust_stdlinkage", LibstdMutator).Parallel()
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -040045 ctx.BottomUp("rust_begin", BeginMutator).Parallel()
Ivan Lozano6cd99e62020-02-11 08:24:25 -050046
47 })
48 android.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
49 ctx.BottomUp("rust_sanitizers", rustSanitizerRuntimeMutator).Parallel()
Ivan Lozanoffee3342019-08-27 12:03:00 -070050 })
51 pctx.Import("android/soong/rust/config")
Thiébaud Weksteen682c9d72020-08-31 10:06:16 +020052 pctx.ImportAs("cc_config", "android/soong/cc/config")
Ivan Lozanoffee3342019-08-27 12:03:00 -070053}
54
55type Flags struct {
Ivan Lozano8a23fa42020-06-16 10:26:57 -040056 GlobalRustFlags []string // Flags that apply globally to rust
57 GlobalLinkFlags []string // Flags that apply globally to linker
58 RustFlags []string // Flags that apply to rust
59 LinkFlags []string // Flags that apply to linker
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020060 ClippyFlags []string // Flags that apply to clippy-driver, during the linting
Dan Albert06feee92021-03-19 15:06:02 -070061 RustdocFlags []string // Flags that apply to rustdoc
Ivan Lozanof1c84332019-09-20 11:00:37 -070062 Toolchain config.Toolchain
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -040063 Coverage bool
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +020064 Clippy bool
Ivan Lozanoffee3342019-08-27 12:03:00 -070065}
66
67type BaseProperties struct {
68 AndroidMkRlibs []string
69 AndroidMkDylibs []string
70 AndroidMkProcMacroLibs []string
71 AndroidMkSharedLibs []string
72 AndroidMkStaticLibs []string
Ivan Lozano43845682020-07-09 21:03:28 -040073
Ivan Lozano6a884432020-12-02 09:15:16 -050074 ImageVariationPrefix string `blueprint:"mutated"`
75 VndkVersion string `blueprint:"mutated"`
76 SubName string `blueprint:"mutated"`
77
Ivan Lozanoc08897c2021-04-02 12:41:32 -040078 // SubName is used by CC for tracking image variants / SDK versions. RustSubName is used for Rust-specific
79 // subnaming which shouldn't be visible to CC modules (such as the rlib stdlinkage subname). This should be
80 // appended before SubName.
81 RustSubName string `blueprint:"mutated"`
82
Ivan Lozano6a884432020-12-02 09:15:16 -050083 // Set by imageMutator
Ivan Lozanoe6d30982021-02-05 10:57:43 -050084 CoreVariantNeeded bool `blueprint:"mutated"`
85 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
86 ExtraVariants []string `blueprint:"mutated"`
87
Ivan Lozano1921e802021-05-20 13:39:16 -040088 // Used by vendor snapshot to record dependencies from snapshot modules.
89 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +090090 SnapshotStaticLibs []string `blueprint:"mutated"`
Ivan Lozano1921e802021-05-20 13:39:16 -040091
Ivan Lozanoe6d30982021-02-05 10:57:43 -050092 // Make this module available when building for vendor ramdisk.
93 // On device without a dedicated recovery partition, the module is only
94 // available after switching root into
95 // /first_stage_ramdisk. To expose the module before switching root, install
96 // the recovery variant instead (TODO(b/165791368) recovery not yet supported)
97 Vendor_ramdisk_available *bool
Ivan Lozano26ecd6c2020-07-31 13:40:31 -040098
Ivan Lozano1921e802021-05-20 13:39:16 -040099 // Normally Soong uses the directory structure to decide which modules
100 // should be included (framework) or excluded (non-framework) from the
101 // different snapshots (vendor, recovery, etc.), but this property
102 // allows a partner to exclude a module normally thought of as a
103 // framework module from the vendor snapshot.
104 Exclude_from_vendor_snapshot *bool
105
106 // Normally Soong uses the directory structure to decide which modules
107 // should be included (framework) or excluded (non-framework) from the
108 // different snapshots (vendor, recovery, etc.), but this property
109 // allows a partner to exclude a module normally thought of as a
110 // framework module from the recovery snapshot.
111 Exclude_from_recovery_snapshot *bool
112
Ivan Lozano3e9f9e42020-12-04 15:05:43 -0500113 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
114 Min_sdk_version *string
115
Ivan Lozano43845682020-07-09 21:03:28 -0400116 PreventInstall bool
117 HideFromMake bool
Ivan Lozanod7586b62021-04-01 09:49:36 -0400118 Installable *bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700119}
120
121type Module struct {
122 android.ModuleBase
123 android.DefaultableModuleBase
Jiyong Park99644e92020-11-17 22:21:02 +0900124 android.ApexModuleBase
Ivan Lozanoffee3342019-08-27 12:03:00 -0700125
Ivan Lozano6a884432020-12-02 09:15:16 -0500126 VendorProperties cc.VendorProperties
127
Ivan Lozanoffee3342019-08-27 12:03:00 -0700128 Properties BaseProperties
129
130 hod android.HostOrDeviceSupported
131 multilib android.Multilib
132
Ivan Lozano6a884432020-12-02 09:15:16 -0500133 makeLinkType string
134
Ivan Lozanoffee3342019-08-27 12:03:00 -0700135 compiler compiler
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400136 coverage *coverage
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200137 clippy *clippy
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500138 sanitize *sanitize
Ivan Lozanoffee3342019-08-27 12:03:00 -0700139 cachedToolchain config.Toolchain
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400140 sourceProvider SourceProvider
Andrei Homescuc7767922020-08-05 06:36:19 -0700141 subAndroidMkOnce map[SubAndroidMkProvider]bool
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400142
Jiyong Parke54f07e2021-04-07 15:08:04 +0900143 // Unstripped output. This is usually used when this module is linked to another module
144 // as a library. The stripped output which is used for installation can be found via
145 // compiler.strippedOutputFile if it exists.
146 unstrippedOutputFile android.OptionalPath
Dan Albert06feee92021-03-19 15:06:02 -0700147 docTimestampFile android.OptionalPath
Jiyong Park99644e92020-11-17 22:21:02 +0900148
149 hideApexVariantFromMake bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700150}
151
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500152func (mod *Module) Header() bool {
153 //TODO: If Rust libraries provide header variants, this needs to be updated.
154 return false
155}
156
157func (mod *Module) SetPreventInstall() {
158 mod.Properties.PreventInstall = true
159}
160
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500161func (mod *Module) SetHideFromMake() {
162 mod.Properties.HideFromMake = true
163}
164
Ivan Lozanod7586b62021-04-01 09:49:36 -0400165func (c *Module) HiddenFromMake() bool {
166 return c.Properties.HideFromMake
167}
168
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500169func (mod *Module) SanitizePropDefined() bool {
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500170 // Because compiler is not set for some Rust modules where sanitize might be set, check that compiler is also not
171 // nil since we need compiler to actually sanitize.
172 return mod.sanitize != nil && mod.compiler != nil
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500173}
174
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500175func (mod *Module) IsPrebuilt() bool {
176 if _, ok := mod.compiler.(*prebuiltLibraryDecorator); ok {
177 return true
178 }
179 return false
180}
181
Ivan Lozano43845682020-07-09 21:03:28 -0400182func (mod *Module) OutputFiles(tag string) (android.Paths, error) {
183 switch tag {
184 case "":
Andrei Homescu5db69cc2020-08-06 15:27:45 -0700185 if mod.sourceProvider != nil && (mod.compiler == nil || mod.compiler.Disabled()) {
Ivan Lozano43845682020-07-09 21:03:28 -0400186 return mod.sourceProvider.Srcs(), nil
187 } else {
Jiyong Parke54f07e2021-04-07 15:08:04 +0900188 if mod.OutputFile().Valid() {
189 return android.Paths{mod.OutputFile().Path()}, nil
Ivan Lozano43845682020-07-09 21:03:28 -0400190 }
191 return android.Paths{}, nil
192 }
193 default:
194 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
195 }
196}
197
Ivan Lozano52767be2019-10-18 14:49:46 -0700198func (mod *Module) SelectedStl() string {
199 return ""
200}
201
Ivan Lozano2b262972019-11-21 12:30:50 -0800202func (mod *Module) NonCcVariants() bool {
203 if mod.compiler != nil {
Ivan Lozano89435d12020-07-31 11:01:18 -0400204 if _, ok := mod.compiler.(libraryInterface); ok {
205 return false
Ivan Lozano2b262972019-11-21 12:30:50 -0800206 }
207 }
208 panic(fmt.Errorf("NonCcVariants called on non-library module: %q", mod.BaseModuleName()))
209}
210
Ivan Lozano52767be2019-10-18 14:49:46 -0700211func (mod *Module) Static() bool {
212 if mod.compiler != nil {
213 if library, ok := mod.compiler.(libraryInterface); ok {
214 return library.static()
215 }
216 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400217 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700218}
219
220func (mod *Module) Shared() bool {
221 if mod.compiler != nil {
222 if library, ok := mod.compiler.(libraryInterface); ok {
Ivan Lozano89435d12020-07-31 11:01:18 -0400223 return library.shared()
Ivan Lozano52767be2019-10-18 14:49:46 -0700224 }
225 }
Ivan Lozano89435d12020-07-31 11:01:18 -0400226 return false
Ivan Lozano52767be2019-10-18 14:49:46 -0700227}
228
Ivan Lozanod7586b62021-04-01 09:49:36 -0400229func (mod *Module) Dylib() bool {
230 if mod.compiler != nil {
231 if library, ok := mod.compiler.(libraryInterface); ok {
232 return library.dylib()
233 }
234 }
235 return false
236}
237
238func (mod *Module) Rlib() bool {
239 if mod.compiler != nil {
240 if library, ok := mod.compiler.(libraryInterface); ok {
241 return library.rlib()
242 }
243 }
244 return false
245}
246
247func (mod *Module) Binary() bool {
248 if mod.compiler != nil {
249 if _, ok := mod.compiler.(*binaryDecorator); ok {
250 return true
251 }
252 }
253 return false
254}
255
Justin Yun5e035862021-06-29 20:50:37 +0900256func (mod *Module) StaticExecutable() bool {
257 if !mod.Binary() {
258 return false
259 }
260 return Bool(mod.compiler.(*binaryDecorator).Properties.Static_executable)
261}
262
Ivan Lozanod7586b62021-04-01 09:49:36 -0400263func (mod *Module) Object() bool {
264 // Rust has no modules which produce only object files.
265 return false
266}
267
Ivan Lozano52767be2019-10-18 14:49:46 -0700268func (mod *Module) Toc() android.OptionalPath {
269 if mod.compiler != nil {
270 if _, ok := mod.compiler.(libraryInterface); ok {
271 return android.OptionalPath{}
272 }
273 }
274 panic(fmt.Errorf("Toc() called on non-library module: %q", mod.BaseModuleName()))
275}
276
Colin Crossc511bc52020-04-07 16:50:32 +0000277func (mod *Module) UseSdk() bool {
278 return false
279}
280
Ivan Lozanod7586b62021-04-01 09:49:36 -0400281func (mod *Module) RelativeInstallPath() string {
282 if mod.compiler != nil {
283 return mod.compiler.relativeInstallPath()
284 }
285 return ""
286}
287
Ivan Lozano52767be2019-10-18 14:49:46 -0700288func (mod *Module) UseVndk() bool {
Ivan Lozano6a884432020-12-02 09:15:16 -0500289 return mod.Properties.VndkVersion != ""
Ivan Lozano52767be2019-10-18 14:49:46 -0700290}
291
Jiyong Park7d55b612021-06-11 17:22:09 +0900292func (mod *Module) Bootstrap() bool {
293 return false
294}
295
Ivan Lozano52767be2019-10-18 14:49:46 -0700296func (mod *Module) MustUseVendorVariant() bool {
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400297 return true
298}
299
300func (mod *Module) SubName() string {
301 return mod.Properties.SubName
Ivan Lozano52767be2019-10-18 14:49:46 -0700302}
303
304func (mod *Module) IsVndk() bool {
Ivan Lozano6a884432020-12-02 09:15:16 -0500305 // TODO(b/165791368)
Ivan Lozano52767be2019-10-18 14:49:46 -0700306 return false
307}
308
Ivan Lozanof9e21722020-12-02 09:00:51 -0500309func (mod *Module) IsVndkExt() bool {
310 return false
311}
312
Ivan Lozanod7586b62021-04-01 09:49:36 -0400313func (mod *Module) IsVndkSp() bool {
314 return false
315}
316
Colin Cross127bb8b2020-12-16 16:46:01 -0800317func (c *Module) IsVndkPrivate() bool {
318 return false
319}
320
321func (c *Module) IsLlndk() bool {
322 return false
323}
324
325func (c *Module) IsLlndkPublic() bool {
Ivan Lozanof9e21722020-12-02 09:00:51 -0500326 return false
327}
328
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400329func (mod *Module) KernelHeadersDecorator() bool {
330 return false
331}
332
Colin Cross1f3f1302021-04-26 18:37:44 -0700333func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -0400334 return false
335}
336
Colin Cross5271fea2021-04-27 13:06:04 -0700337func (m *Module) NeedsVendorPublicLibraryVariants() bool {
338 return false
339}
340
Ivan Lozanod7586b62021-04-01 09:49:36 -0400341func (mod *Module) HasLlndkStubs() bool {
342 return false
343}
344
345func (mod *Module) StubsVersion() string {
346 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", mod.BaseModuleName()))
347}
348
Ivan Lozano52767be2019-10-18 14:49:46 -0700349func (mod *Module) SdkVersion() string {
350 return ""
351}
352
Jiyong Parkfdaa5f72021-03-19 22:18:04 +0900353func (mod *Module) MinSdkVersion() string {
354 return ""
355}
356
Colin Crossc511bc52020-04-07 16:50:32 +0000357func (mod *Module) AlwaysSdk() bool {
358 return false
359}
360
Jiyong Park2286afd2020-06-16 21:58:53 +0900361func (mod *Module) IsSdkVariant() bool {
362 return false
363}
364
Colin Cross1348ce32020-10-01 13:37:16 -0700365func (mod *Module) SplitPerApiLevel() bool {
366 return false
367}
368
Ivan Lozanoffee3342019-08-27 12:03:00 -0700369type Deps struct {
Ivan Lozano63bb7682021-03-23 15:53:44 -0400370 Dylibs []string
371 Rlibs []string
372 Rustlibs []string
373 Stdlibs []string
374 ProcMacros []string
375 SharedLibs []string
376 StaticLibs []string
377 WholeStaticLibs []string
378 HeaderLibs []string
Ivan Lozanoffee3342019-08-27 12:03:00 -0700379
380 CrtBegin, CrtEnd string
381}
382
383type PathDeps struct {
Ivan Lozanoec6e9912021-01-21 15:23:29 -0500384 DyLibs RustLibraries
385 RLibs RustLibraries
386 SharedLibs android.Paths
387 SharedLibDeps android.Paths
388 StaticLibs android.Paths
389 ProcMacros RustLibraries
Ivan Lozano3dfa12d2021-02-04 11:29:41 -0500390
391 // depFlags and depLinkFlags are rustc and linker (clang) flags.
392 depFlags []string
393 depLinkFlags []string
394
395 // linkDirs are link paths passed via -L to rustc. linkObjects are objects passed directly to the linker.
396 // Both of these are exported and propagate to dependencies.
397 linkDirs []string
398 linkObjects []string
Ivan Lozanof1c84332019-09-20 11:00:37 -0700399
Ivan Lozano45901ed2020-07-24 16:05:01 -0400400 // Used by bindgen modules which call clang
401 depClangFlags []string
402 depIncludePaths android.Paths
Ivan Lozanoddd0bdb2020-08-28 17:00:26 -0400403 depGeneratedHeaders android.Paths
Ivan Lozano45901ed2020-07-24 16:05:01 -0400404 depSystemIncludePaths android.Paths
405
Ivan Lozanof1c84332019-09-20 11:00:37 -0700406 CrtBegin android.OptionalPath
407 CrtEnd android.OptionalPath
Chih-Hung Hsiehbbd25ae2020-05-15 17:36:30 -0700408
409 // Paths to generated source files
Ivan Lozano9d74a522020-12-01 09:25:22 -0500410 SrcDeps android.Paths
411 srcProviderFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -0700412}
413
414type RustLibraries []RustLibrary
415
416type RustLibrary struct {
417 Path android.Path
418 CrateName string
419}
420
421type compiler interface {
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100422 initialize(ctx ModuleContext)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700423 compilerFlags(ctx ModuleContext, flags Flags) Flags
424 compilerProps() []interface{}
425 compile(ctx ModuleContext, flags Flags, deps PathDeps) android.Path
426 compilerDeps(ctx DepsContext, deps Deps) Deps
427 crateName() string
Dan Albert06feee92021-03-19 15:06:02 -0700428 rustdoc(ctx ModuleContext, flags Flags, deps PathDeps) android.OptionalPath
Ivan Lozanoffee3342019-08-27 12:03:00 -0700429
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100430 // Output directory in which source-generated code from dependencies is
431 // copied. This is equivalent to Cargo's OUT_DIR variable.
432 CargoOutDir() android.OptionalPath
Dan Albert06feee92021-03-19 15:06:02 -0700433
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -0800434 inData() bool
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +0200435 install(ctx ModuleContext)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700436 relativeInstallPath() string
Ivan Lozanod7586b62021-04-01 09:49:36 -0400437 everInstallable() bool
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400438
439 nativeCoverage() bool
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400440
441 Disabled() bool
442 SetDisabled()
Ivan Lozano042504f2020-08-18 14:31:23 -0400443
Ivan Lozanodd055472020-09-28 13:22:45 -0400444 stdLinkage(ctx *depsContext) RustLinkage
Jiyong Parke54f07e2021-04-07 15:08:04 +0900445
446 strippedOutputFilePath() android.OptionalPath
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400447}
448
Matthew Maurerbb3add12020-06-25 09:34:12 -0700449type exportedFlagsProducer interface {
Matthew Maurerbb3add12020-06-25 09:34:12 -0700450 exportLinkDirs(...string)
Ivan Lozano2093af22020-08-25 12:48:19 -0400451 exportLinkObjects(...string)
Matthew Maurerbb3add12020-06-25 09:34:12 -0700452}
453
454type flagExporter struct {
Ivan Lozano2093af22020-08-25 12:48:19 -0400455 linkDirs []string
456 linkObjects []string
Matthew Maurerbb3add12020-06-25 09:34:12 -0700457}
458
Matthew Maurerbb3add12020-06-25 09:34:12 -0700459func (flagExporter *flagExporter) exportLinkDirs(dirs ...string) {
460 flagExporter.linkDirs = android.FirstUniqueStrings(append(flagExporter.linkDirs, dirs...))
461}
462
Ivan Lozano2093af22020-08-25 12:48:19 -0400463func (flagExporter *flagExporter) exportLinkObjects(flags ...string) {
464 flagExporter.linkObjects = android.FirstUniqueStrings(append(flagExporter.linkObjects, flags...))
465}
466
Colin Cross0de8a1e2020-09-18 14:15:30 -0700467func (flagExporter *flagExporter) setProvider(ctx ModuleContext) {
468 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Colin Cross0de8a1e2020-09-18 14:15:30 -0700469 LinkDirs: flagExporter.linkDirs,
470 LinkObjects: flagExporter.linkObjects,
471 })
472}
473
Matthew Maurerbb3add12020-06-25 09:34:12 -0700474var _ exportedFlagsProducer = (*flagExporter)(nil)
475
476func NewFlagExporter() *flagExporter {
Colin Cross0de8a1e2020-09-18 14:15:30 -0700477 return &flagExporter{}
Matthew Maurerbb3add12020-06-25 09:34:12 -0700478}
479
Colin Cross0de8a1e2020-09-18 14:15:30 -0700480type FlagExporterInfo struct {
481 Flags []string
482 LinkDirs []string // TODO: this should be android.Paths
483 LinkObjects []string // TODO: this should be android.Paths
484}
485
486var FlagExporterInfoProvider = blueprint.NewProvider(FlagExporterInfo{})
487
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400488func (mod *Module) isCoverageVariant() bool {
489 return mod.coverage.Properties.IsCoverageVariant
490}
491
492var _ cc.Coverage = (*Module)(nil)
493
494func (mod *Module) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
495 return mod.coverage != nil && mod.coverage.Properties.NeedCoverageVariant
496}
497
Ivan Lozanod7586b62021-04-01 09:49:36 -0400498func (mod *Module) VndkVersion() string {
499 return mod.Properties.VndkVersion
500}
501
502func (mod *Module) PreventInstall() bool {
503 return mod.Properties.PreventInstall
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400504}
505
506func (mod *Module) HideFromMake() {
507 mod.Properties.HideFromMake = true
508}
509
510func (mod *Module) MarkAsCoverageVariant(coverage bool) {
511 mod.coverage.Properties.IsCoverageVariant = coverage
512}
513
514func (mod *Module) EnableCoverageIfNeeded() {
515 mod.coverage.Properties.CoverageEnabled = mod.coverage.Properties.NeedCoverageBuild
Ivan Lozanoffee3342019-08-27 12:03:00 -0700516}
517
518func defaultsFactory() android.Module {
519 return DefaultsFactory()
520}
521
522type Defaults struct {
523 android.ModuleBase
524 android.DefaultsModuleBase
525}
526
527func DefaultsFactory(props ...interface{}) android.Module {
528 module := &Defaults{}
529
530 module.AddProperties(props...)
531 module.AddProperties(
532 &BaseProperties{},
Ivan Lozano6a884432020-12-02 09:15:16 -0500533 &cc.VendorProperties{},
Jakub Kotur1d640d02021-01-06 12:40:43 +0100534 &BenchmarkProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400535 &BindgenProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700536 &BaseCompilerProperties{},
537 &BinaryCompilerProperties{},
538 &LibraryCompilerProperties{},
539 &ProcMacroCompilerProperties{},
540 &PrebuiltProperties{},
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400541 &SourceProviderProperties{},
Chih-Hung Hsieh41805be2019-10-31 20:56:47 -0700542 &TestProperties{},
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400543 &cc.CoverageProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -0400544 &cc.RustBindgenClangProperties{},
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200545 &ClippyProperties{},
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500546 &SanitizeProperties{},
Ivan Lozanoffee3342019-08-27 12:03:00 -0700547 )
548
549 android.InitDefaultsModule(module)
550 return module
551}
552
553func (mod *Module) CrateName() string {
Ivan Lozanoad8b18b2019-10-31 19:38:29 -0700554 return mod.compiler.crateName()
Ivan Lozanoffee3342019-08-27 12:03:00 -0700555}
556
Ivan Lozano183a3212019-10-18 14:18:45 -0700557func (mod *Module) CcLibrary() bool {
558 if mod.compiler != nil {
559 if _, ok := mod.compiler.(*libraryDecorator); ok {
560 return true
561 }
562 }
563 return false
564}
565
566func (mod *Module) CcLibraryInterface() bool {
567 if mod.compiler != nil {
Ivan Lozano89435d12020-07-31 11:01:18 -0400568 // use build{Static,Shared}() instead of {static,shared}() here because this might be called before
569 // VariantIs{Static,Shared} is set.
570 if lib, ok := mod.compiler.(libraryInterface); ok && (lib.buildShared() || lib.buildStatic()) {
Ivan Lozano183a3212019-10-18 14:18:45 -0700571 return true
572 }
573 }
574 return false
575}
576
Ivan Lozanoe0833b12019-11-06 19:15:49 -0800577func (mod *Module) IncludeDirs() android.Paths {
Ivan Lozano183a3212019-10-18 14:18:45 -0700578 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700579 if library, ok := mod.compiler.(*libraryDecorator); ok {
Ivan Lozanoe0833b12019-11-06 19:15:49 -0800580 return library.includeDirs
Ivan Lozano183a3212019-10-18 14:18:45 -0700581 }
582 }
583 panic(fmt.Errorf("IncludeDirs called on non-library module: %q", mod.BaseModuleName()))
584}
585
586func (mod *Module) SetStatic() {
587 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700588 if library, ok := mod.compiler.(libraryInterface); ok {
589 library.setStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700590 return
591 }
592 }
593 panic(fmt.Errorf("SetStatic called on non-library module: %q", mod.BaseModuleName()))
594}
595
596func (mod *Module) SetShared() {
597 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700598 if library, ok := mod.compiler.(libraryInterface); ok {
599 library.setShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700600 return
601 }
602 }
603 panic(fmt.Errorf("SetShared called on non-library module: %q", mod.BaseModuleName()))
604}
605
Ivan Lozano183a3212019-10-18 14:18:45 -0700606func (mod *Module) BuildStaticVariant() bool {
607 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700608 if library, ok := mod.compiler.(libraryInterface); ok {
609 return library.buildStatic()
Ivan Lozano183a3212019-10-18 14:18:45 -0700610 }
611 }
612 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", mod.BaseModuleName()))
613}
614
615func (mod *Module) BuildSharedVariant() bool {
616 if mod.compiler != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -0700617 if library, ok := mod.compiler.(libraryInterface); ok {
618 return library.buildShared()
Ivan Lozano183a3212019-10-18 14:18:45 -0700619 }
620 }
621 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", mod.BaseModuleName()))
622}
623
Ivan Lozano183a3212019-10-18 14:18:45 -0700624func (mod *Module) Module() android.Module {
625 return mod
626}
627
Ivan Lozano183a3212019-10-18 14:18:45 -0700628func (mod *Module) OutputFile() android.OptionalPath {
Jiyong Parke54f07e2021-04-07 15:08:04 +0900629 if mod.compiler != nil && mod.compiler.strippedOutputFilePath().Valid() {
630 return mod.compiler.strippedOutputFilePath()
631 }
632 return mod.unstrippedOutputFile
Ivan Lozano183a3212019-10-18 14:18:45 -0700633}
634
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400635func (mod *Module) CoverageFiles() android.Paths {
636 if mod.compiler != nil {
Joel Galensonfa049382021-01-14 16:03:18 -0800637 return android.Paths{}
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400638 }
639 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", mod.BaseModuleName()))
640}
641
Jiyong Park459feca2020-12-15 11:02:21 +0900642func (mod *Module) installable(apexInfo android.ApexInfo) bool {
Jiyong Parkbf8147a2021-05-17 13:19:33 +0900643 if !mod.EverInstallable() {
644 return false
645 }
646
Jiyong Park459feca2020-12-15 11:02:21 +0900647 // The apex variant is not installable because it is included in the APEX and won't appear
648 // in the system partition as a standalone file.
649 if !apexInfo.IsForPlatform() {
650 return false
651 }
652
Jiyong Parke54f07e2021-04-07 15:08:04 +0900653 return mod.OutputFile().Valid() && !mod.Properties.PreventInstall
Jiyong Park459feca2020-12-15 11:02:21 +0900654}
655
Ivan Lozano183a3212019-10-18 14:18:45 -0700656var _ cc.LinkableInterface = (*Module)(nil)
657
Ivan Lozanoffee3342019-08-27 12:03:00 -0700658func (mod *Module) Init() android.Module {
659 mod.AddProperties(&mod.Properties)
Ivan Lozano6a884432020-12-02 09:15:16 -0500660 mod.AddProperties(&mod.VendorProperties)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700661
662 if mod.compiler != nil {
663 mod.AddProperties(mod.compiler.compilerProps()...)
664 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400665 if mod.coverage != nil {
666 mod.AddProperties(mod.coverage.props()...)
667 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200668 if mod.clippy != nil {
669 mod.AddProperties(mod.clippy.props()...)
670 }
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400671 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -0700672 mod.AddProperties(mod.sourceProvider.SourceProviderProps()...)
Ivan Lozano4fef93c2020-07-08 08:39:44 -0400673 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500674 if mod.sanitize != nil {
675 mod.AddProperties(mod.sanitize.props()...)
676 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400677
Ivan Lozanoffee3342019-08-27 12:03:00 -0700678 android.InitAndroidArchModule(mod, mod.hod, mod.multilib)
Jiyong Park99644e92020-11-17 22:21:02 +0900679 android.InitApexModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700680
681 android.InitDefaultableModule(mod)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700682 return mod
683}
684
685func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
686 return &Module{
687 hod: hod,
688 multilib: multilib,
689 }
690}
691func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
692 module := newBaseModule(hod, multilib)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400693 module.coverage = &coverage{}
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200694 module.clippy = &clippy{}
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500695 module.sanitize = &sanitize{}
Ivan Lozanoffee3342019-08-27 12:03:00 -0700696 return module
697}
698
699type ModuleContext interface {
700 android.ModuleContext
701 ModuleContextIntf
702}
703
704type BaseModuleContext interface {
705 android.BaseModuleContext
706 ModuleContextIntf
707}
708
709type DepsContext interface {
710 android.BottomUpMutatorContext
711 ModuleContextIntf
712}
713
714type ModuleContextIntf interface {
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200715 RustModule() *Module
Ivan Lozanoffee3342019-08-27 12:03:00 -0700716 toolchain() config.Toolchain
Ivan Lozanoffee3342019-08-27 12:03:00 -0700717}
718
719type depsContext struct {
720 android.BottomUpMutatorContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700721}
722
723type moduleContext struct {
724 android.ModuleContext
Ivan Lozanoffee3342019-08-27 12:03:00 -0700725}
726
Thiébaud Weksteen1f7f70f2020-06-24 11:32:48 +0200727type baseModuleContext struct {
728 android.BaseModuleContext
729}
730
731func (ctx *moduleContext) RustModule() *Module {
732 return ctx.Module().(*Module)
733}
734
735func (ctx *moduleContext) toolchain() config.Toolchain {
736 return ctx.RustModule().toolchain(ctx)
737}
738
739func (ctx *depsContext) RustModule() *Module {
740 return ctx.Module().(*Module)
741}
742
743func (ctx *depsContext) toolchain() config.Toolchain {
744 return ctx.RustModule().toolchain(ctx)
745}
746
747func (ctx *baseModuleContext) RustModule() *Module {
748 return ctx.Module().(*Module)
749}
750
751func (ctx *baseModuleContext) toolchain() config.Toolchain {
752 return ctx.RustModule().toolchain(ctx)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400753}
754
755func (mod *Module) nativeCoverage() bool {
756 return mod.compiler != nil && mod.compiler.nativeCoverage()
757}
758
Ivan Lozanod7586b62021-04-01 09:49:36 -0400759func (mod *Module) EverInstallable() bool {
760 return mod.compiler != nil &&
761 // Check to see whether the module is actually ever installable.
762 mod.compiler.everInstallable()
763}
764
765func (mod *Module) Installable() *bool {
766 return mod.Properties.Installable
767}
768
Ivan Lozanoffee3342019-08-27 12:03:00 -0700769func (mod *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
770 if mod.cachedToolchain == nil {
771 mod.cachedToolchain = config.FindToolchain(ctx.Os(), ctx.Arch())
772 }
773 return mod.cachedToolchain
774}
775
Thiébaud Weksteen31f1bb82020-08-27 13:37:29 +0200776func (mod *Module) ccToolchain(ctx android.BaseModuleContext) cc_config.Toolchain {
777 return cc_config.FindToolchain(ctx.Os(), ctx.Arch())
778}
779
Ivan Lozanoffee3342019-08-27 12:03:00 -0700780func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
781}
782
783func (mod *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
784 ctx := &moduleContext{
785 ModuleContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -0700786 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700787
Jiyong Park99644e92020-11-17 22:21:02 +0900788 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
789 if !apexInfo.IsForPlatform() {
790 mod.hideApexVariantFromMake = true
791 }
792
Ivan Lozanoffee3342019-08-27 12:03:00 -0700793 toolchain := mod.toolchain(ctx)
Ivan Lozano6a884432020-12-02 09:15:16 -0500794 mod.makeLinkType = cc.GetMakeLinkType(actx, mod)
795
796 // Differentiate static libraries that are vendor available
797 if mod.UseVndk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -0500798 mod.Properties.SubName += cc.VendorSuffix
799 } else if mod.InVendorRamdisk() && !mod.OnlyInVendorRamdisk() {
800 mod.Properties.SubName += cc.VendorRamdiskSuffix
Ivan Lozano6a884432020-12-02 09:15:16 -0500801 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700802
803 if !toolchain.Supported() {
804 // This toolchain's unsupported, there's nothing to do for this mod.
805 return
806 }
807
808 deps := mod.depsToPaths(ctx)
809 flags := Flags{
810 Toolchain: toolchain,
811 }
812
813 if mod.compiler != nil {
814 flags = mod.compiler.compilerFlags(ctx, flags)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400815 }
816 if mod.coverage != nil {
817 flags, deps = mod.coverage.flags(ctx, flags, deps)
818 }
Thiébaud Weksteen92f703b2020-06-22 13:28:02 +0200819 if mod.clippy != nil {
820 flags, deps = mod.clippy.flags(ctx, flags, deps)
821 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500822 if mod.sanitize != nil {
823 flags, deps = mod.sanitize.flags(ctx, flags, deps)
824 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400825
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200826 // SourceProvider needs to call GenerateSource() before compiler calls
827 // compile() so it can provide the source. A SourceProvider has
828 // multiple variants (e.g. source, rlib, dylib). Only the "source"
829 // variant is responsible for effectively generating the source. The
830 // remaining variants relies on the "source" variant output.
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400831 if mod.sourceProvider != nil {
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200832 if mod.compiler.(libraryInterface).source() {
833 mod.sourceProvider.GenerateSource(ctx, deps)
834 mod.sourceProvider.setSubName(ctx.ModuleSubDir())
835 } else {
836 sourceMod := actx.GetDirectDepWithTag(mod.Name(), sourceDepTag)
837 sourceLib := sourceMod.(*Module).compiler.(*libraryDecorator)
Chih-Hung Hsiehc49649c2020-10-01 21:25:05 -0700838 mod.sourceProvider.setOutputFiles(sourceLib.sourceProvider.Srcs())
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200839 }
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400840 }
841
842 if mod.compiler != nil && !mod.compiler.Disabled() {
Thiébaud Weksteenee6a89b2021-02-25 16:30:57 +0100843 mod.compiler.initialize(ctx)
Jiyong Parke54f07e2021-04-07 15:08:04 +0900844 unstrippedOutputFile := mod.compiler.compile(ctx, flags, deps)
Jiyong Parke54f07e2021-04-07 15:08:04 +0900845 mod.unstrippedOutputFile = android.OptionalPathForPath(unstrippedOutputFile)
Thiébaud Weksteene4dd14b2021-04-14 11:18:47 +0200846 bloaty.MeasureSizeForPaths(ctx, mod.compiler.strippedOutputFilePath(), mod.unstrippedOutputFile)
Jiyong Park459feca2020-12-15 11:02:21 +0900847
Dan Albert06feee92021-03-19 15:06:02 -0700848 mod.docTimestampFile = mod.compiler.rustdoc(ctx, flags, deps)
849
Ivan Lozano1921e802021-05-20 13:39:16 -0400850 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
851 // RECOVERY_SNAPSHOT_VERSION is current.
852 if lib, ok := mod.compiler.(snapshotLibraryInterface); ok {
853 if cc.ShouldCollectHeadersForSnapshot(ctx, mod, apexInfo) {
854 lib.collectHeadersForSnapshot(ctx, deps)
855 }
856 }
857
Jiyong Park459feca2020-12-15 11:02:21 +0900858 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
859 if mod.installable(apexInfo) {
Thiébaud Weksteenfabaff62020-08-27 13:48:36 +0200860 mod.compiler.install(ctx)
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400861 }
Ivan Lozanoffee3342019-08-27 12:03:00 -0700862 }
863}
864
865func (mod *Module) deps(ctx DepsContext) Deps {
866 deps := Deps{}
867
868 if mod.compiler != nil {
869 deps = mod.compiler.compilerDeps(ctx, deps)
Ivan Lozano26ecd6c2020-07-31 13:40:31 -0400870 }
871 if mod.sourceProvider != nil {
Andrei Homescuc7767922020-08-05 06:36:19 -0700872 deps = mod.sourceProvider.SourceProviderDeps(ctx, deps)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700873 }
874
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400875 if mod.coverage != nil {
876 deps = mod.coverage.deps(ctx, deps)
877 }
878
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500879 if mod.sanitize != nil {
880 deps = mod.sanitize.deps(ctx, deps)
881 }
882
Ivan Lozanoffee3342019-08-27 12:03:00 -0700883 deps.Rlibs = android.LastUniqueStrings(deps.Rlibs)
884 deps.Dylibs = android.LastUniqueStrings(deps.Dylibs)
Matthew Maurer0f003b12020-06-29 14:34:06 -0700885 deps.Rustlibs = android.LastUniqueStrings(deps.Rustlibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700886 deps.ProcMacros = android.LastUniqueStrings(deps.ProcMacros)
887 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
888 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
Ivan Lozano63bb7682021-03-23 15:53:44 -0400889 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700890 return deps
891
892}
893
Ivan Lozanoffee3342019-08-27 12:03:00 -0700894type dependencyTag struct {
895 blueprint.BaseDependencyTag
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800896 name string
897 library bool
898 procMacro bool
Ivan Lozanoffee3342019-08-27 12:03:00 -0700899}
900
Jiyong Park65b62242020-11-25 12:44:59 +0900901// InstallDepNeeded returns true for rlibs, dylibs, and proc macros so that they or their transitive
902// dependencies (especially C/C++ shared libs) are installed as dependencies of a rust binary.
903func (d dependencyTag) InstallDepNeeded() bool {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800904 return d.library || d.procMacro
Jiyong Park65b62242020-11-25 12:44:59 +0900905}
906
907var _ android.InstallNeededDependencyTag = dependencyTag{}
908
Ivan Lozanoffee3342019-08-27 12:03:00 -0700909var (
Ivan Lozanoc564d2d2020-08-04 15:43:37 -0400910 customBindgenDepTag = dependencyTag{name: "customBindgenTag"}
911 rlibDepTag = dependencyTag{name: "rlibTag", library: true}
912 dylibDepTag = dependencyTag{name: "dylib", library: true}
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800913 procMacroDepTag = dependencyTag{name: "procMacro", procMacro: true}
Ivan Lozanoc564d2d2020-08-04 15:43:37 -0400914 testPerSrcDepTag = dependencyTag{name: "rust_unit_tests"}
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200915 sourceDepTag = dependencyTag{name: "source"}
Ivan Lozanoffee3342019-08-27 12:03:00 -0700916)
917
Jiyong Park99644e92020-11-17 22:21:02 +0900918func IsDylibDepTag(depTag blueprint.DependencyTag) bool {
919 tag, ok := depTag.(dependencyTag)
920 return ok && tag == dylibDepTag
921}
922
Jiyong Park94e22fd2021-04-08 18:19:15 +0900923func IsRlibDepTag(depTag blueprint.DependencyTag) bool {
924 tag, ok := depTag.(dependencyTag)
925 return ok && tag == rlibDepTag
926}
927
Matthew Maurer0f003b12020-06-29 14:34:06 -0700928type autoDep struct {
929 variation string
930 depTag dependencyTag
931}
932
933var (
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +0200934 rlibVariation = "rlib"
935 dylibVariation = "dylib"
936 rlibAutoDep = autoDep{variation: rlibVariation, depTag: rlibDepTag}
937 dylibAutoDep = autoDep{variation: dylibVariation, depTag: dylibDepTag}
Matthew Maurer0f003b12020-06-29 14:34:06 -0700938)
939
940type autoDeppable interface {
Liz Kammer356f7d42021-01-26 09:18:53 -0500941 autoDep(ctx android.BottomUpMutatorContext) autoDep
Matthew Maurer0f003b12020-06-29 14:34:06 -0700942}
943
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400944func (mod *Module) begin(ctx BaseModuleContext) {
945 if mod.coverage != nil {
946 mod.coverage.begin(ctx)
947 }
Ivan Lozano6cd99e62020-02-11 08:24:25 -0500948 if mod.sanitize != nil {
949 mod.sanitize.begin(ctx)
950 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400951}
952
Ivan Lozanoffee3342019-08-27 12:03:00 -0700953func (mod *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
954 var depPaths PathDeps
955
956 directRlibDeps := []*Module{}
957 directDylibDeps := []*Module{}
958 directProcMacroDeps := []*Module{}
Jiyong Park7d55b612021-06-11 17:22:09 +0900959 directSharedLibDeps := []cc.SharedLibraryInfo{}
Ivan Lozano52767be2019-10-18 14:49:46 -0700960 directStaticLibDeps := [](cc.LinkableInterface){}
Ivan Lozano07cbaf42020-07-22 16:09:13 -0400961 directSrcProvidersDeps := []*Module{}
962 directSrcDeps := [](android.SourceFileProducer){}
Ivan Lozanoffee3342019-08-27 12:03:00 -0700963
964 ctx.VisitDirectDeps(func(dep android.Module) {
965 depName := ctx.OtherModuleName(dep)
966 depTag := ctx.OtherModuleDependencyTag(dep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400967
Ivan Lozano89435d12020-07-31 11:01:18 -0400968 if rustDep, ok := dep.(*Module); ok && !rustDep.CcLibraryInterface() {
Ivan Lozanoffee3342019-08-27 12:03:00 -0700969 //Handle Rust Modules
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400970 makeLibName := cc.MakeLibName(ctx, mod, rustDep, depName+rustDep.Properties.RustSubName)
Ivan Lozano70e0a072019-09-13 14:23:15 -0700971
Ivan Lozanoffee3342019-08-27 12:03:00 -0700972 switch depTag {
973 case dylibDepTag:
974 dylib, ok := rustDep.compiler.(libraryInterface)
975 if !ok || !dylib.dylib() {
976 ctx.ModuleErrorf("mod %q not an dylib library", depName)
977 return
978 }
979 directDylibDeps = append(directDylibDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400980 mod.Properties.AndroidMkDylibs = append(mod.Properties.AndroidMkDylibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700981 case rlibDepTag:
Ivan Lozano2b081132020-09-08 12:46:52 -0400982
Ivan Lozanoffee3342019-08-27 12:03:00 -0700983 rlib, ok := rustDep.compiler.(libraryInterface)
984 if !ok || !rlib.rlib() {
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400985 ctx.ModuleErrorf("mod %q not an rlib library", makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700986 return
987 }
988 directRlibDeps = append(directRlibDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400989 mod.Properties.AndroidMkRlibs = append(mod.Properties.AndroidMkRlibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -0700990 case procMacroDepTag:
991 directProcMacroDeps = append(directProcMacroDeps, rustDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -0400992 mod.Properties.AndroidMkProcMacroLibs = append(mod.Properties.AndroidMkProcMacroLibs, makeLibName)
Ivan Lozano07cbaf42020-07-22 16:09:13 -0400993 case android.SourceDepTag:
994 // Since these deps are added in path_properties.go via AddDependencies, we need to ensure the correct
995 // OS/Arch variant is used.
996 var helper string
997 if ctx.Host() {
998 helper = "missing 'host_supported'?"
999 } else {
1000 helper = "device module defined?"
1001 }
1002
1003 if dep.Target().Os != ctx.Os() {
1004 ctx.ModuleErrorf("OS mismatch on dependency %q (%s)", dep.Name(), helper)
1005 return
1006 } else if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
1007 ctx.ModuleErrorf("Arch mismatch on dependency %q (%s)", dep.Name(), helper)
1008 return
1009 }
1010 directSrcProvidersDeps = append(directSrcProvidersDeps, rustDep)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001011 }
1012
Ivan Lozano2bbcacf2020-08-07 09:00:50 -04001013 //Append the dependencies exportedDirs, except for proc-macros which target a different arch/OS
Colin Cross0de8a1e2020-09-18 14:15:30 -07001014 if depTag != procMacroDepTag {
1015 exportedInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
1016 depPaths.linkDirs = append(depPaths.linkDirs, exportedInfo.LinkDirs...)
1017 depPaths.depFlags = append(depPaths.depFlags, exportedInfo.Flags...)
1018 depPaths.linkObjects = append(depPaths.linkObjects, exportedInfo.LinkObjects...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001019 }
1020
Ivan Lozanoffee3342019-08-27 12:03:00 -07001021 if depTag == dylibDepTag || depTag == rlibDepTag || depTag == procMacroDepTag {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001022 linkFile := rustDep.unstrippedOutputFile
Ivan Lozano26ecd6c2020-07-31 13:40:31 -04001023 if !linkFile.Valid() {
1024 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q",
1025 depName, ctx.ModuleName())
1026 return
1027 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001028 linkDir := linkPathFromFilePath(linkFile.Path())
Matthew Maurerbb3add12020-06-25 09:34:12 -07001029 if lib, ok := mod.compiler.(exportedFlagsProducer); ok {
1030 lib.exportLinkDirs(linkDir)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001031 }
1032 }
1033
Ivan Lozano89435d12020-07-31 11:01:18 -04001034 } else if ccDep, ok := dep.(cc.LinkableInterface); ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07001035 //Handle C dependencies
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001036 makeLibName := cc.MakeLibName(ctx, mod, ccDep, depName)
Ivan Lozano52767be2019-10-18 14:49:46 -07001037 if _, ok := ccDep.(*Module); !ok {
1038 if ccDep.Module().Target().Os != ctx.Os() {
1039 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
1040 return
1041 }
1042 if ccDep.Module().Target().Arch.ArchType != ctx.Arch().ArchType {
1043 ctx.ModuleErrorf("Arch mismatch between %q and %q", ctx.ModuleName(), depName)
1044 return
1045 }
Ivan Lozano70e0a072019-09-13 14:23:15 -07001046 }
Ivan Lozano2093af22020-08-25 12:48:19 -04001047 linkObject := ccDep.OutputFile()
1048 linkPath := linkPathFromFilePath(linkObject.Path())
Ivan Lozano6aa66022020-02-06 13:22:43 -05001049
Ivan Lozano2093af22020-08-25 12:48:19 -04001050 if !linkObject.Valid() {
Ivan Lozanoffee3342019-08-27 12:03:00 -07001051 ctx.ModuleErrorf("Invalid output file when adding dep %q to %q", depName, ctx.ModuleName())
1052 }
1053
1054 exportDep := false
Colin Cross6e511a92020-07-27 21:26:48 -07001055 switch {
1056 case cc.IsStaticDepTag(depTag):
Ivan Lozano63bb7682021-03-23 15:53:44 -04001057 if cc.IsWholeStaticLib(depTag) {
1058 // rustc will bundle static libraries when they're passed with "-lstatic=<lib>". This will fail
1059 // if the library is not prefixed by "lib".
Ivan Lozanofb6f36f2021-02-05 12:27:08 -05001060 if libName, ok := libNameFromFilePath(linkObject.Path()); ok {
1061 depPaths.depFlags = append(depPaths.depFlags, "-lstatic="+libName)
Ivan Lozano63bb7682021-03-23 15:53:44 -04001062 } else {
1063 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 -05001064 }
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001065 }
1066
1067 // Add this to linkObjects to pass the library directly to the linker as well. This propagates
1068 // to dependencies to avoid having to redeclare static libraries for dependents of the dylib variant.
Ivan Lozano2093af22020-08-25 12:48:19 -04001069 depPaths.linkObjects = append(depPaths.linkObjects, linkObject.String())
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001070 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
1071
Colin Cross0de8a1e2020-09-18 14:15:30 -07001072 exportedInfo := ctx.OtherModuleProvider(dep, cc.FlagExporterInfoProvider).(cc.FlagExporterInfo)
1073 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1074 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1075 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1076 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001077 directStaticLibDeps = append(directStaticLibDeps, ccDep)
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001078 mod.Properties.AndroidMkStaticLibs = append(mod.Properties.AndroidMkStaticLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07001079 case cc.IsSharedDepTag(depTag):
Jiyong Park7d55b612021-06-11 17:22:09 +09001080 // For the shared lib dependencies, we may link to the stub variant
1081 // of the dependency depending on the context (e.g. if this
1082 // dependency crosses the APEX boundaries).
1083 sharedLibraryInfo, exportedInfo := cc.ChooseStubOrImpl(ctx, dep)
1084
1085 // Re-get linkObject as ChooseStubOrImpl actually tells us which
1086 // object (either from stub or non-stub) to use.
1087 linkObject = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
1088 linkPath = linkPathFromFilePath(linkObject.Path())
1089
Ivan Lozanoffee3342019-08-27 12:03:00 -07001090 depPaths.linkDirs = append(depPaths.linkDirs, linkPath)
Ivan Lozano2093af22020-08-25 12:48:19 -04001091 depPaths.linkObjects = append(depPaths.linkObjects, linkObject.String())
Colin Cross0de8a1e2020-09-18 14:15:30 -07001092 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1093 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1094 depPaths.depClangFlags = append(depPaths.depClangFlags, exportedInfo.Flags...)
1095 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Jiyong Park7d55b612021-06-11 17:22:09 +09001096 directSharedLibDeps = append(directSharedLibDeps, sharedLibraryInfo)
Ivan Lozano1921e802021-05-20 13:39:16 -04001097
1098 // Record baseLibName for snapshots.
1099 mod.Properties.SnapshotSharedLibs = append(mod.Properties.SnapshotSharedLibs, cc.BaseLibName(depName))
Justin Yun5e035862021-06-29 20:50:37 +09001100 mod.Properties.SnapshotStaticLibs = append(mod.Properties.SnapshotStaticLibs, cc.BaseLibName(depName))
Ivan Lozano1921e802021-05-20 13:39:16 -04001101
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001102 mod.Properties.AndroidMkSharedLibs = append(mod.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001103 exportDep = true
Zach Johnson3df4e632020-11-06 11:56:27 -08001104 case cc.IsHeaderDepTag(depTag):
1105 exportedInfo := ctx.OtherModuleProvider(dep, cc.FlagExporterInfoProvider).(cc.FlagExporterInfo)
1106 depPaths.depIncludePaths = append(depPaths.depIncludePaths, exportedInfo.IncludeDirs...)
1107 depPaths.depSystemIncludePaths = append(depPaths.depSystemIncludePaths, exportedInfo.SystemIncludeDirs...)
1108 depPaths.depGeneratedHeaders = append(depPaths.depGeneratedHeaders, exportedInfo.GeneratedHeaders...)
Colin Cross6e511a92020-07-27 21:26:48 -07001109 case depTag == cc.CrtBeginDepTag:
Ivan Lozano2093af22020-08-25 12:48:19 -04001110 depPaths.CrtBegin = linkObject
Colin Cross6e511a92020-07-27 21:26:48 -07001111 case depTag == cc.CrtEndDepTag:
Ivan Lozano2093af22020-08-25 12:48:19 -04001112 depPaths.CrtEnd = linkObject
Ivan Lozanoffee3342019-08-27 12:03:00 -07001113 }
1114
1115 // Make sure these dependencies are propagated
Matthew Maurerbb3add12020-06-25 09:34:12 -07001116 if lib, ok := mod.compiler.(exportedFlagsProducer); ok && exportDep {
1117 lib.exportLinkDirs(linkPath)
Ivan Lozano2093af22020-08-25 12:48:19 -04001118 lib.exportLinkObjects(linkObject.String())
Ivan Lozanoffee3342019-08-27 12:03:00 -07001119 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001120 }
Ivan Lozano89435d12020-07-31 11:01:18 -04001121
1122 if srcDep, ok := dep.(android.SourceFileProducer); ok {
1123 switch depTag {
1124 case android.SourceDepTag:
1125 // These are usually genrules which don't have per-target variants.
1126 directSrcDeps = append(directSrcDeps, srcDep)
1127 }
1128 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001129 })
1130
1131 var rlibDepFiles RustLibraries
1132 for _, dep := range directRlibDeps {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001133 rlibDepFiles = append(rlibDepFiles, RustLibrary{Path: dep.unstrippedOutputFile.Path(), CrateName: dep.CrateName()})
Ivan Lozanoffee3342019-08-27 12:03:00 -07001134 }
1135 var dylibDepFiles RustLibraries
1136 for _, dep := range directDylibDeps {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001137 dylibDepFiles = append(dylibDepFiles, RustLibrary{Path: dep.unstrippedOutputFile.Path(), CrateName: dep.CrateName()})
Ivan Lozanoffee3342019-08-27 12:03:00 -07001138 }
1139 var procMacroDepFiles RustLibraries
1140 for _, dep := range directProcMacroDeps {
Jiyong Parke54f07e2021-04-07 15:08:04 +09001141 procMacroDepFiles = append(procMacroDepFiles, RustLibrary{Path: dep.unstrippedOutputFile.Path(), CrateName: dep.CrateName()})
Ivan Lozanoffee3342019-08-27 12:03:00 -07001142 }
1143
1144 var staticLibDepFiles android.Paths
1145 for _, dep := range directStaticLibDeps {
1146 staticLibDepFiles = append(staticLibDepFiles, dep.OutputFile().Path())
1147 }
1148
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001149 var sharedLibFiles android.Paths
Ivan Lozanoffee3342019-08-27 12:03:00 -07001150 var sharedLibDepFiles android.Paths
1151 for _, dep := range directSharedLibDeps {
Jiyong Park7d55b612021-06-11 17:22:09 +09001152 sharedLibFiles = append(sharedLibFiles, dep.SharedLibrary)
1153 if dep.TableOfContents.Valid() {
1154 sharedLibDepFiles = append(sharedLibDepFiles, dep.TableOfContents.Path())
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001155 } else {
Jiyong Park7d55b612021-06-11 17:22:09 +09001156 sharedLibDepFiles = append(sharedLibDepFiles, dep.SharedLibrary)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001157 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001158 }
1159
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001160 var srcProviderDepFiles android.Paths
1161 for _, dep := range directSrcProvidersDeps {
1162 srcs, _ := dep.OutputFiles("")
1163 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1164 }
1165 for _, dep := range directSrcDeps {
1166 srcs := dep.Srcs()
1167 srcProviderDepFiles = append(srcProviderDepFiles, srcs...)
1168 }
1169
Ivan Lozanoffee3342019-08-27 12:03:00 -07001170 depPaths.RLibs = append(depPaths.RLibs, rlibDepFiles...)
1171 depPaths.DyLibs = append(depPaths.DyLibs, dylibDepFiles...)
1172 depPaths.SharedLibs = append(depPaths.SharedLibs, sharedLibDepFiles...)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001173 depPaths.SharedLibDeps = append(depPaths.SharedLibDeps, sharedLibDepFiles...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001174 depPaths.StaticLibs = append(depPaths.StaticLibs, staticLibDepFiles...)
1175 depPaths.ProcMacros = append(depPaths.ProcMacros, procMacroDepFiles...)
Ivan Lozano07cbaf42020-07-22 16:09:13 -04001176 depPaths.SrcDeps = append(depPaths.SrcDeps, srcProviderDepFiles...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001177
1178 // Dedup exported flags from dependencies
1179 depPaths.linkDirs = android.FirstUniqueStrings(depPaths.linkDirs)
Ivan Lozanoec6e9912021-01-21 15:23:29 -05001180 depPaths.linkObjects = android.FirstUniqueStrings(depPaths.linkObjects)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001181 depPaths.depFlags = android.FirstUniqueStrings(depPaths.depFlags)
Ivan Lozano45901ed2020-07-24 16:05:01 -04001182 depPaths.depClangFlags = android.FirstUniqueStrings(depPaths.depClangFlags)
1183 depPaths.depIncludePaths = android.FirstUniquePaths(depPaths.depIncludePaths)
1184 depPaths.depSystemIncludePaths = android.FirstUniquePaths(depPaths.depSystemIncludePaths)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001185
1186 return depPaths
1187}
1188
Chih-Hung Hsieh9a4a7ba2019-12-12 19:36:05 -08001189func (mod *Module) InstallInData() bool {
1190 if mod.compiler == nil {
1191 return false
1192 }
1193 return mod.compiler.inData()
1194}
1195
Ivan Lozanoffee3342019-08-27 12:03:00 -07001196func linkPathFromFilePath(filepath android.Path) string {
1197 return strings.Split(filepath.String(), filepath.Base())[0]
1198}
Ivan Lozanod648c432020-02-06 12:05:10 -05001199
Ivan Lozanoffee3342019-08-27 12:03:00 -07001200func (mod *Module) DepsMutator(actx android.BottomUpMutatorContext) {
1201 ctx := &depsContext{
1202 BottomUpMutatorContext: actx,
Ivan Lozanoffee3342019-08-27 12:03:00 -07001203 }
Ivan Lozanoffee3342019-08-27 12:03:00 -07001204
1205 deps := mod.deps(ctx)
Colin Cross3146c5c2020-09-30 15:34:40 -07001206 var commonDepVariations []blueprint.Variation
Ivan Lozano1921e802021-05-20 13:39:16 -04001207 var snapshotInfo *cc.SnapshotInfo
1208
1209 if ctx.Os() == android.Android {
1210 deps.SharedLibs, _ = cc.RewriteLibs(mod, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
1211 }
Ivan Lozanodd055472020-09-28 13:22:45 -04001212
Ivan Lozano2b081132020-09-08 12:46:52 -04001213 stdLinkage := "dylib-std"
Ivan Lozanodd055472020-09-28 13:22:45 -04001214 if mod.compiler.stdLinkage(ctx) == RlibLinkage {
Ivan Lozano2b081132020-09-08 12:46:52 -04001215 stdLinkage = "rlib-std"
1216 }
1217
1218 rlibDepVariations := commonDepVariations
Ivan Lozano1921e802021-05-20 13:39:16 -04001219
Ivan Lozano2b081132020-09-08 12:46:52 -04001220 if lib, ok := mod.compiler.(libraryInterface); !ok || !lib.sysroot() {
1221 rlibDepVariations = append(rlibDepVariations,
1222 blueprint.Variation{Mutator: "rust_stdlinkage", Variation: stdLinkage})
1223 }
1224
Ivan Lozano1921e802021-05-20 13:39:16 -04001225 // rlibs
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001226 for _, lib := range deps.Rlibs {
1227 depTag := rlibDepTag
1228 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).Rlibs)
1229
1230 actx.AddVariationDependencies(append(rlibDepVariations, []blueprint.Variation{
1231 {Mutator: "rust_libraries", Variation: rlibVariation},
1232 }...), depTag, lib)
1233 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001234
1235 // dylibs
Ivan Lozano52767be2019-10-18 14:49:46 -07001236 actx.AddVariationDependencies(
1237 append(commonDepVariations, []blueprint.Variation{
Thiébaud Weksteen295c72b2020-09-23 18:10:17 +02001238 {Mutator: "rust_libraries", Variation: dylibVariation}}...),
Ivan Lozano52767be2019-10-18 14:49:46 -07001239 dylibDepTag, deps.Dylibs...)
1240
Ivan Lozano1921e802021-05-20 13:39:16 -04001241 // rustlibs
Ivan Lozano042504f2020-08-18 14:31:23 -04001242 if deps.Rustlibs != nil && !mod.compiler.Disabled() {
1243 autoDep := mod.compiler.(autoDeppable).autoDep(ctx)
Ivan Lozano2b081132020-09-08 12:46:52 -04001244 if autoDep.depTag == rlibDepTag {
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001245 for _, lib := range deps.Rustlibs {
1246 depTag := autoDep.depTag
1247 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).Rlibs)
1248 actx.AddVariationDependencies(append(rlibDepVariations, []blueprint.Variation{
1249 {Mutator: "rust_libraries", Variation: autoDep.variation},
1250 }...), depTag, lib)
1251 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001252 } else {
1253 actx.AddVariationDependencies(
1254 append(commonDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: autoDep.variation}),
1255 autoDep.depTag, deps.Rustlibs...)
1256 }
Matthew Maurer0f003b12020-06-29 14:34:06 -07001257 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001258
1259 // stdlibs
Ivan Lozano2b081132020-09-08 12:46:52 -04001260 if deps.Stdlibs != nil {
Ivan Lozanodd055472020-09-28 13:22:45 -04001261 if mod.compiler.stdLinkage(ctx) == RlibLinkage {
Ivan Lozano3149e6e2021-06-01 15:09:53 -04001262 for _, lib := range deps.Stdlibs {
1263 depTag := rlibDepTag
1264 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).Rlibs)
1265
1266 actx.AddVariationDependencies(append(commonDepVariations, []blueprint.Variation{{Mutator: "rust_libraries", Variation: "rlib"}}...),
1267 depTag, lib)
1268 }
Ivan Lozano2b081132020-09-08 12:46:52 -04001269 } else {
1270 actx.AddVariationDependencies(
1271 append(commonDepVariations, blueprint.Variation{Mutator: "rust_libraries", Variation: "dylib"}),
1272 dylibDepTag, deps.Stdlibs...)
1273 }
1274 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001275
1276 for _, lib := range deps.SharedLibs {
1277 depTag := cc.SharedDepTag()
1278 name, version := cc.StubsLibNameAndVersion(lib)
1279
1280 variations := []blueprint.Variation{
1281 {Mutator: "link", Variation: "shared"},
1282 }
1283 cc.AddSharedLibDependenciesWithVersions(ctx, mod, variations, depTag, name, version, false)
1284 }
1285
1286 for _, lib := range deps.WholeStaticLibs {
1287 depTag := cc.StaticDepTag(true)
1288 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).StaticLibs)
1289
1290 actx.AddVariationDependencies([]blueprint.Variation{
1291 {Mutator: "link", Variation: "static"},
1292 }, depTag, lib)
1293 }
1294
1295 for _, lib := range deps.StaticLibs {
1296 depTag := cc.StaticDepTag(false)
1297 lib = cc.RewriteSnapshotLib(lib, cc.GetSnapshot(mod, &snapshotInfo, actx).StaticLibs)
1298
1299 actx.AddVariationDependencies([]blueprint.Variation{
1300 {Mutator: "link", Variation: "static"},
1301 }, depTag, lib)
1302 }
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07001303
Zach Johnson3df4e632020-11-06 11:56:27 -08001304 actx.AddVariationDependencies(nil, cc.HeaderDepTag(), deps.HeaderLibs...)
1305
Colin Cross565cafd2020-09-25 18:47:38 -07001306 crtVariations := cc.GetCrtVariations(ctx, mod)
Ivan Lozanof1c84332019-09-20 11:00:37 -07001307 if deps.CrtBegin != "" {
Ivan Lozano1921e802021-05-20 13:39:16 -04001308 actx.AddVariationDependencies(crtVariations, cc.CrtBeginDepTag,
1309 cc.RewriteSnapshotLib(deps.CrtBegin, cc.GetSnapshot(mod, &snapshotInfo, actx).Objects))
Ivan Lozanof1c84332019-09-20 11:00:37 -07001310 }
1311 if deps.CrtEnd != "" {
Ivan Lozano1921e802021-05-20 13:39:16 -04001312 actx.AddVariationDependencies(crtVariations, cc.CrtEndDepTag,
1313 cc.RewriteSnapshotLib(deps.CrtEnd, cc.GetSnapshot(mod, &snapshotInfo, actx).Objects))
Ivan Lozanof1c84332019-09-20 11:00:37 -07001314 }
1315
Ivan Lozanoc564d2d2020-08-04 15:43:37 -04001316 if mod.sourceProvider != nil {
1317 if bindgen, ok := mod.sourceProvider.(*bindgenDecorator); ok &&
1318 bindgen.Properties.Custom_bindgen != "" {
1319 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), customBindgenDepTag,
1320 bindgen.Properties.Custom_bindgen)
1321 }
1322 }
Ivan Lozano1921e802021-05-20 13:39:16 -04001323
Ivan Lozano5ca5ef62019-09-23 10:10:40 -07001324 // proc_macros are compiler plugins, and so we need the host arch variant as a dependendcy.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001325 actx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), procMacroDepTag, deps.ProcMacros...)
Ivan Lozanoffee3342019-08-27 12:03:00 -07001326}
1327
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001328func BeginMutator(ctx android.BottomUpMutatorContext) {
1329 if mod, ok := ctx.Module().(*Module); ok && mod.Enabled() {
1330 mod.beginMutator(ctx)
1331 }
1332}
1333
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001334func (mod *Module) beginMutator(actx android.BottomUpMutatorContext) {
1335 ctx := &baseModuleContext{
1336 BaseModuleContext: actx,
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001337 }
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001338
1339 mod.begin(ctx)
1340}
1341
Ivan Lozanoffee3342019-08-27 12:03:00 -07001342func (mod *Module) Name() string {
1343 name := mod.ModuleBase.Name()
1344 if p, ok := mod.compiler.(interface {
1345 Name(string) string
1346 }); ok {
1347 name = p.Name(name)
1348 }
1349 return name
1350}
1351
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02001352func (mod *Module) disableClippy() {
Ivan Lozano32267c82020-08-04 16:27:16 -04001353 if mod.clippy != nil {
Thiébaud Weksteen9e8451e2020-08-13 12:55:59 +02001354 mod.clippy.Properties.Clippy_lints = proptools.StringPtr("none")
Ivan Lozano32267c82020-08-04 16:27:16 -04001355 }
1356}
1357
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07001358var _ android.HostToolProvider = (*Module)(nil)
1359
1360func (mod *Module) HostToolPath() android.OptionalPath {
1361 if !mod.Host() {
1362 return android.OptionalPath{}
1363 }
Chih-Hung Hsieha7562702020-08-10 21:50:43 -07001364 if binary, ok := mod.compiler.(*binaryDecorator); ok {
1365 return android.OptionalPathForPath(binary.baseCompiler.path)
Chih-Hung Hsieh5c4e4892020-05-15 17:36:30 -07001366 }
1367 return android.OptionalPath{}
1368}
1369
Jiyong Park99644e92020-11-17 22:21:02 +09001370var _ android.ApexModule = (*Module)(nil)
1371
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05001372func (mod *Module) minSdkVersion() string {
1373 return String(mod.Properties.Min_sdk_version)
1374}
1375
Jiyong Park45bf82e2020-12-15 22:29:02 +09001376var _ android.ApexModule = (*Module)(nil)
1377
1378// Implements android.ApexModule
Jiyong Park99644e92020-11-17 22:21:02 +09001379func (mod *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Ivan Lozano3e9f9e42020-12-04 15:05:43 -05001380 minSdkVersion := mod.minSdkVersion()
1381 if minSdkVersion == "apex_inherit" {
1382 return nil
1383 }
1384 if minSdkVersion == "" {
1385 return fmt.Errorf("min_sdk_version is not specificed")
1386 }
1387
1388 // Not using nativeApiLevelFromUser because the context here is not
1389 // necessarily a native context.
1390 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
1391 if err != nil {
1392 return err
1393 }
1394
1395 if ver.GreaterThan(sdkVersion) {
1396 return fmt.Errorf("newer SDK(%v)", ver)
1397 }
Jiyong Park99644e92020-11-17 22:21:02 +09001398 return nil
1399}
1400
Jiyong Park45bf82e2020-12-15 22:29:02 +09001401// Implements android.ApexModule
Jiyong Park99644e92020-11-17 22:21:02 +09001402func (mod *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1403 depTag := ctx.OtherModuleDependencyTag(dep)
1404
1405 if ccm, ok := dep.(*cc.Module); ok {
1406 if ccm.HasStubsVariants() {
1407 if cc.IsSharedDepTag(depTag) {
1408 // dynamic dep to a stubs lib crosses APEX boundary
1409 return false
1410 }
1411 if cc.IsRuntimeDepTag(depTag) {
1412 // runtime dep to a stubs lib also crosses APEX boundary
1413 return false
1414 }
1415
1416 if cc.IsHeaderDepTag(depTag) {
1417 return false
1418 }
1419 }
1420 if mod.Static() && cc.IsSharedDepTag(depTag) {
1421 // shared_lib dependency from a static lib is considered as crossing
1422 // the APEX boundary because the dependency doesn't actually is
1423 // linked; the dependency is used only during the compilation phase.
1424 return false
1425 }
1426 }
1427
1428 if depTag == procMacroDepTag {
1429 return false
1430 }
1431
1432 return true
1433}
1434
1435// Overrides ApexModule.IsInstallabeToApex()
1436func (mod *Module) IsInstallableToApex() bool {
1437 if mod.compiler != nil {
1438 if lib, ok := mod.compiler.(*libraryDecorator); ok && (lib.shared() || lib.dylib()) {
1439 return true
1440 }
1441 if _, ok := mod.compiler.(*binaryDecorator); ok {
1442 return true
1443 }
1444 }
1445 return false
1446}
1447
Ivan Lozano3dfa12d2021-02-04 11:29:41 -05001448// If a library file has a "lib" prefix, extract the library name without the prefix.
1449func libNameFromFilePath(filepath android.Path) (string, bool) {
1450 libName := strings.TrimSuffix(filepath.Base(), filepath.Ext())
1451 if strings.HasPrefix(libName, "lib") {
1452 libName = libName[3:]
1453 return libName, true
1454 }
1455 return "", false
1456}
1457
Ivan Lozanoffee3342019-08-27 12:03:00 -07001458var Bool = proptools.Bool
1459var BoolDefault = proptools.BoolDefault
1460var String = proptools.String
1461var StringPtr = proptools.StringPtr
Ivan Lozano43845682020-07-09 21:03:28 -04001462
1463var _ android.OutputFileProducer = (*Module)(nil)