blob: d2b8fa13f095acf26b255bdb9da3221dcf93d923 [file] [log] [blame]
Colin Crossce75d2c2016-10-06 16:12:58 -07001// Copyright 2016 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package android
16
Colin Cross74d73e22017-08-02 11:05:49 -070017import (
18 "fmt"
Jaewoong Jung3e18b192019-06-11 12:25:34 -070019 "reflect"
Paul Duffind23c7262020-12-11 18:13:08 +000020 "strings"
Colin Cross74d73e22017-08-02 11:05:49 -070021
22 "github.com/google/blueprint"
Jaewoong Jung939ebd52019-03-26 15:07:36 -070023 "github.com/google/blueprint/proptools"
Colin Cross74d73e22017-08-02 11:05:49 -070024)
Colin Crossce75d2c2016-10-06 16:12:58 -070025
26// This file implements common functionality for handling modules that may exist as prebuilts,
27// source, or both.
28
Paul Duffin0c4979b2019-12-19 15:11:53 +000029func RegisterPrebuiltMutators(ctx RegistrationContext) {
30 ctx.PreArchMutators(RegisterPrebuiltsPreArchMutators)
31 ctx.PostDepsMutators(RegisterPrebuiltsPostDepsMutators)
32}
33
Paul Duffin80342d72020-06-26 22:08:43 +010034// Marks a dependency tag as possibly preventing a reference to a source from being
35// replaced with the prebuilt.
36type ReplaceSourceWithPrebuilt interface {
37 blueprint.DependencyTag
38
39 // Return true if the dependency defined by this tag should be replaced with the
40 // prebuilt.
41 ReplaceSourceWithPrebuilt() bool
42}
43
Nan Zhang2502e122017-03-09 18:43:01 -080044type prebuiltDependencyTag struct {
45 blueprint.BaseDependencyTag
46}
47
Jiyong Park03b68dd2019-07-26 23:20:40 +090048var PrebuiltDepTag prebuiltDependencyTag
Colin Crossce75d2c2016-10-06 16:12:58 -070049
Paul Duffin78ac5b92020-01-14 12:42:08 +000050// Mark this tag so dependencies that use it are excluded from visibility enforcement.
51func (t prebuiltDependencyTag) ExcludeFromVisibilityEnforcement() {}
52
Paul Duffindddd5462020-04-07 15:25:44 +010053// Mark this tag so dependencies that use it are excluded from APEX contents.
54func (t prebuiltDependencyTag) ExcludeFromApexContents() {}
55
56var _ ExcludeFromVisibilityEnforcementTag = PrebuiltDepTag
57var _ ExcludeFromApexContentsTag = PrebuiltDepTag
58
Paul Duffinbf4de042022-09-27 12:41:52 +010059// UserSuppliedPrebuiltProperties contains the prebuilt properties that can be specified in an
60// Android.bp file.
61type UserSuppliedPrebuiltProperties struct {
Colin Cross74d73e22017-08-02 11:05:49 -070062 // When prefer is set to true the prebuilt will be used instead of any source module with
63 // a matching name.
Nan Zhang0007d812017-11-07 10:57:05 -080064 Prefer *bool `android:"arch_variant"`
Colin Crossce75d2c2016-10-06 16:12:58 -070065
Paul Duffin0c52c7b2021-07-06 17:15:25 +010066 // When specified this names a Soong config variable that controls the prefer property.
67 //
68 // If the value of the named Soong config variable is true then prefer is set to false and vice
69 // versa. If the Soong config variable is not set then it defaults to false, so prefer defaults
70 // to true.
71 //
72 // If specified then the prefer property is ignored in favor of the value of the Soong config
73 // variable.
74 Use_source_config_var *ConfigVarProperties
Paul Duffinbf4de042022-09-27 12:41:52 +010075}
76
77// CopyUserSuppliedPropertiesFromPrebuilt copies the user supplied prebuilt properties from the
78// prebuilt properties.
79func (u *UserSuppliedPrebuiltProperties) CopyUserSuppliedPropertiesFromPrebuilt(p *Prebuilt) {
80 *u = p.properties.UserSuppliedPrebuiltProperties
81}
82
83type PrebuiltProperties struct {
84 UserSuppliedPrebuiltProperties
Paul Duffin0c52c7b2021-07-06 17:15:25 +010085
Colin Cross74d73e22017-08-02 11:05:49 -070086 SourceExists bool `blueprint:"mutated"`
87 UsePrebuilt bool `blueprint:"mutated"`
Martin Stjernholm009a9dc2020-03-05 17:34:13 +000088
89 // Set if the module has been renamed to remove the "prebuilt_" prefix.
90 PrebuiltRenamedToSource bool `blueprint:"mutated"`
Colin Cross74d73e22017-08-02 11:05:49 -070091}
92
Paul Duffin0c52c7b2021-07-06 17:15:25 +010093// Properties that can be used to select a Soong config variable.
94type ConfigVarProperties struct {
95 // Allow instances of this struct to be used as a property value in a BpPropertySet.
96 BpPrintableBase
97
98 // The name of the configuration namespace.
99 //
100 // As passed to add_soong_config_namespace in Make.
101 Config_namespace *string
102
103 // The name of the configuration variable.
104 //
105 // As passed to add_soong_config_var_value in Make.
106 Var_name *string
107}
108
Colin Cross74d73e22017-08-02 11:05:49 -0700109type Prebuilt struct {
110 properties PrebuiltProperties
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700111
Martin Stjernholme65c3ae2021-11-23 01:24:06 +0000112 // nil if the prebuilt has no srcs property at all. See InitPrebuiltModuleWithoutSrcs.
113 srcsSupplier PrebuiltSrcsSupplier
114
115 // "-" if the prebuilt has no srcs property at all. See InitPrebuiltModuleWithoutSrcs.
Paul Duffindcb4bd62020-03-12 23:43:52 +0000116 srcsPropertyName string
Colin Crossce75d2c2016-10-06 16:12:58 -0700117}
118
Paul Duffind23c7262020-12-11 18:13:08 +0000119// RemoveOptionalPrebuiltPrefix returns the result of removing the "prebuilt_" prefix from the
120// supplied name if it has one, or returns the name unmodified if it does not.
121func RemoveOptionalPrebuiltPrefix(name string) string {
122 return strings.TrimPrefix(name, "prebuilt_")
123}
124
Trevor Radcliffe5d6fa4d2022-05-17 21:59:36 +0000125// RemoveOptionalPrebuiltPrefixFromBazelLabel removes the "prebuilt_" prefix from the *target name* of a Bazel label.
126// This differs from RemoveOptionalPrebuiltPrefix in that it does not remove it from the start of the string, but
127// instead removes it from the target name itself.
128func RemoveOptionalPrebuiltPrefixFromBazelLabel(label string) string {
129 splitLabel := strings.Split(label, ":")
130 bazelModuleNameNoPrebuilt := RemoveOptionalPrebuiltPrefix(splitLabel[1])
131 return strings.Join([]string{
132 splitLabel[0],
133 bazelModuleNameNoPrebuilt,
134 }, ":")
135}
136
Colin Crossce75d2c2016-10-06 16:12:58 -0700137func (p *Prebuilt) Name(name string) string {
Paul Duffin864116c2021-04-02 10:24:13 +0100138 return PrebuiltNameFromSource(name)
139}
140
141// PrebuiltNameFromSource returns the result of prepending the "prebuilt_" prefix to the supplied
142// name.
143func PrebuiltNameFromSource(name string) string {
Colin Crossce75d2c2016-10-06 16:12:58 -0700144 return "prebuilt_" + name
145}
146
Paul Duffin50061512020-01-21 16:31:05 +0000147func (p *Prebuilt) ForcePrefer() {
148 p.properties.Prefer = proptools.BoolPtr(true)
149}
150
Paul Duffin38b57852020-05-13 16:08:09 +0100151func (p *Prebuilt) Prefer() bool {
152 return proptools.Bool(p.properties.Prefer)
153}
154
Paul Duffin56dc66e2021-03-01 13:18:44 +0000155// SingleSourcePathFromSupplier invokes the supplied supplier for the current module in the
156// supplied context to retrieve a list of file paths, ensures that the returned list of file paths
157// contains a single value and then assumes that is a module relative file path and converts it to
158// a Path accordingly.
159//
160// Any issues, such as nil supplier or not exactly one file path will be reported as errors on the
161// supplied context and this will return nil.
162func SingleSourcePathFromSupplier(ctx ModuleContext, srcsSupplier PrebuiltSrcsSupplier, srcsPropertyName string) Path {
163 if srcsSupplier != nil {
164 srcs := srcsSupplier(ctx, ctx.Module())
Paul Duffindcb4bd62020-03-12 23:43:52 +0000165
166 if len(srcs) == 0 {
Paul Duffin56dc66e2021-03-01 13:18:44 +0000167 ctx.PropertyErrorf(srcsPropertyName, "missing prebuilt source file")
Jaewoong Jung939ebd52019-03-26 15:07:36 -0700168 return nil
169 }
Colin Crossce75d2c2016-10-06 16:12:58 -0700170
Paul Duffindcb4bd62020-03-12 23:43:52 +0000171 if len(srcs) > 1 {
Paul Duffin56dc66e2021-03-01 13:18:44 +0000172 ctx.PropertyErrorf(srcsPropertyName, "multiple prebuilt source files")
Jaewoong Jung939ebd52019-03-26 15:07:36 -0700173 return nil
174 }
Colin Crossce75d2c2016-10-06 16:12:58 -0700175
Jaewoong Jung939ebd52019-03-26 15:07:36 -0700176 // Return the singleton source after expanding any filegroup in the
177 // sources.
Paul Duffindcb4bd62020-03-12 23:43:52 +0000178 src := srcs[0]
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700179 return PathForModuleSrc(ctx, src)
Paul Duffindcb4bd62020-03-12 23:43:52 +0000180 } else {
181 ctx.ModuleErrorf("prebuilt source was not set")
182 return nil
Jaewoong Jung939ebd52019-03-26 15:07:36 -0700183 }
Colin Cross74d73e22017-08-02 11:05:49 -0700184}
185
Paul Duffin56dc66e2021-03-01 13:18:44 +0000186// The below source-related functions and the srcs, src fields are based on an assumption that
187// prebuilt modules have a static source property at the moment. Currently there is only one
188// exception, android_app_import, which chooses a source file depending on the product's DPI
189// preference configs. We'll want to add native support for dynamic source cases if we end up having
190// more modules like this.
191func (p *Prebuilt) SingleSourcePath(ctx ModuleContext) Path {
192 return SingleSourcePathFromSupplier(ctx, p.srcsSupplier, p.srcsPropertyName)
193}
194
Jiyong Park4d277042019-04-23 18:00:10 +0900195func (p *Prebuilt) UsePrebuilt() bool {
196 return p.properties.UsePrebuilt
197}
198
Paul Duffindcb4bd62020-03-12 23:43:52 +0000199// Called to provide the srcs value for the prebuilt module.
200//
Paul Duffinc04fb9e2021-03-01 12:25:10 +0000201// This can be called with a context for any module not just the prebuilt one itself. It can also be
202// called concurrently.
203//
Paul Duffindcb4bd62020-03-12 23:43:52 +0000204// Return the src value or nil if it is not available.
Paul Duffinc04fb9e2021-03-01 12:25:10 +0000205type PrebuiltSrcsSupplier func(ctx BaseModuleContext, prebuilt Module) []string
Paul Duffindcb4bd62020-03-12 23:43:52 +0000206
Martin Stjernholme65c3ae2021-11-23 01:24:06 +0000207func initPrebuiltModuleCommon(module PrebuiltInterface) *Prebuilt {
208 p := module.Prebuilt()
209 module.AddProperties(&p.properties)
Martin Stjernholme65c3ae2021-11-23 01:24:06 +0000210 return p
211}
212
213// Initialize the module as a prebuilt module that has no dedicated property that lists its
214// sources. SingleSourcePathFromSupplier should not be called for this module.
215//
216// This is the case e.g. for header modules, which provides the headers in source form
217// regardless whether they are prebuilt or not.
218func InitPrebuiltModuleWithoutSrcs(module PrebuiltInterface) {
219 p := initPrebuiltModuleCommon(module)
220 p.srcsPropertyName = "-"
221}
222
Paul Duffindcb4bd62020-03-12 23:43:52 +0000223// Initialize the module as a prebuilt module that uses the provided supplier to access the
224// prebuilt sources of the module.
225//
226// The supplier will be called multiple times and must return the same values each time it
227// is called. If it returns an empty array (or nil) then the prebuilt module will not be used
228// as a replacement for a source module with the same name even if prefer = true.
229//
230// If the Prebuilt.SingleSourcePath() is called on the module then this must return an array
231// containing exactly one source file.
232//
233// The provided property name is used to provide helpful error messages in the event that
234// a problem arises, e.g. calling SingleSourcePath() when more than one source is provided.
235func InitPrebuiltModuleWithSrcSupplier(module PrebuiltInterface, srcsSupplier PrebuiltSrcsSupplier, srcsPropertyName string) {
Paul Duffindcb4bd62020-03-12 23:43:52 +0000236 if srcsSupplier == nil {
237 panic(fmt.Errorf("srcsSupplier must not be nil"))
238 }
239 if srcsPropertyName == "" {
240 panic(fmt.Errorf("srcsPropertyName must not be empty"))
241 }
242
Martin Stjernholme65c3ae2021-11-23 01:24:06 +0000243 p := initPrebuiltModuleCommon(module)
Paul Duffindcb4bd62020-03-12 23:43:52 +0000244 p.srcsSupplier = srcsSupplier
245 p.srcsPropertyName = srcsPropertyName
246}
247
248func InitPrebuiltModule(module PrebuiltInterface, srcs *[]string) {
249 if srcs == nil {
250 panic(fmt.Errorf("srcs must not be nil"))
251 }
252
Paul Duffinc04fb9e2021-03-01 12:25:10 +0000253 srcsSupplier := func(ctx BaseModuleContext, _ Module) []string {
Paul Duffindcb4bd62020-03-12 23:43:52 +0000254 return *srcs
255 }
256
257 InitPrebuiltModuleWithSrcSupplier(module, srcsSupplier, "srcs")
Colin Crossce75d2c2016-10-06 16:12:58 -0700258}
259
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700260func InitSingleSourcePrebuiltModule(module PrebuiltInterface, srcProps interface{}, srcField string) {
Paul Duffindcb4bd62020-03-12 23:43:52 +0000261 srcPropsValue := reflect.ValueOf(srcProps).Elem()
262 srcStructField, _ := srcPropsValue.Type().FieldByName(srcField)
263 if !srcPropsValue.IsValid() || srcStructField.Name == "" {
264 panic(fmt.Errorf("invalid single source prebuilt %+v", module))
265 }
266
267 if srcPropsValue.Kind() != reflect.Struct && srcPropsValue.Kind() != reflect.Interface {
268 panic(fmt.Errorf("invalid single source prebuilt %+v", srcProps))
269 }
270
271 srcFieldIndex := srcStructField.Index
272 srcPropertyName := proptools.PropertyNameForField(srcField)
273
Paul Duffinc04fb9e2021-03-01 12:25:10 +0000274 srcsSupplier := func(ctx BaseModuleContext, _ Module) []string {
Jaewoong Jung729c0bd2020-12-08 19:11:54 -0800275 if !module.Enabled() {
Jaewoong Jung84f1b802020-12-04 11:51:29 -0800276 return nil
277 }
Paul Duffindcb4bd62020-03-12 23:43:52 +0000278 value := srcPropsValue.FieldByIndex(srcFieldIndex)
279 if value.Kind() == reflect.Ptr {
280 value = value.Elem()
281 }
282 if value.Kind() != reflect.String {
Martin Stjernholm25a69de2021-09-09 02:48:30 +0100283 panic(fmt.Errorf("prebuilt src field %q in %T in module %s should be a string or a pointer to one but was %v", srcField, srcProps, module, value))
Paul Duffindcb4bd62020-03-12 23:43:52 +0000284 }
285 src := value.String()
286 if src == "" {
287 return nil
288 }
289 return []string{src}
290 }
291
292 InitPrebuiltModuleWithSrcSupplier(module, srcsSupplier, srcPropertyName)
Jaewoong Jung939ebd52019-03-26 15:07:36 -0700293}
294
Colin Crossce75d2c2016-10-06 16:12:58 -0700295type PrebuiltInterface interface {
296 Module
297 Prebuilt() *Prebuilt
Colin Crossce75d2c2016-10-06 16:12:58 -0700298}
299
Paul Duffine1d38372021-04-02 10:35:24 +0100300// IsModulePreferred returns true if the given module is preferred.
301//
302// A source module is preferred if there is no corresponding prebuilt module or the prebuilt module
303// does not have "prefer: true".
304//
305// A prebuilt module is preferred if there is no corresponding source module or the prebuilt module
306// has "prefer: true".
307func IsModulePreferred(module Module) bool {
308 if module.IsReplacedByPrebuilt() {
309 // A source module that has been replaced by a prebuilt counterpart.
310 return false
311 }
Paul Duffinf7c99f52021-04-28 10:41:21 +0100312 if p := GetEmbeddedPrebuilt(module); p != nil {
313 return p.UsePrebuilt()
Paul Duffine1d38372021-04-02 10:35:24 +0100314 }
315 return true
316}
317
Paul Duffinf7c99f52021-04-28 10:41:21 +0100318// IsModulePrebuilt returns true if the module implements PrebuiltInterface and
319// has been initialized as a prebuilt and so returns a non-nil value from the
320// PrebuiltInterface.Prebuilt() method.
321func IsModulePrebuilt(module Module) bool {
322 return GetEmbeddedPrebuilt(module) != nil
323}
324
325// GetEmbeddedPrebuilt returns a pointer to the embedded Prebuilt structure or
326// nil if the module does not implement PrebuiltInterface or has not been
327// initialized as a prebuilt module.
328func GetEmbeddedPrebuilt(module Module) *Prebuilt {
329 if p, ok := module.(PrebuiltInterface); ok {
330 return p.Prebuilt()
331 }
332
333 return nil
334}
335
Martin Stjernholmdbd814d2022-01-12 23:18:30 +0000336// PrebuiltGetPreferred returns the module that is preferred for the given
337// module. That is either the module itself or the prebuilt counterpart that has
338// taken its place. The given module must be a direct dependency of the current
339// context module, and it must be the source module if both source and prebuilt
340// exist.
341//
342// This function is for use on dependencies after PrebuiltPostDepsMutator has
343// run - any dependency that is registered before that will already reference
344// the right module. This function is only safe to call after all mutators that
345// may call CreateVariations, e.g. in GenerateAndroidBuildActions.
346func PrebuiltGetPreferred(ctx BaseModuleContext, module Module) Module {
347 if !module.IsReplacedByPrebuilt() {
348 return module
349 }
350 if IsModulePrebuilt(module) {
351 // If we're given a prebuilt then assume there's no source module around.
352 return module
353 }
354
355 sourceModDepFound := false
356 var prebuiltMod Module
357
358 ctx.WalkDeps(func(child, parent Module) bool {
359 if prebuiltMod != nil {
360 return false
361 }
362 if parent == ctx.Module() {
363 // First level: Only recurse if the module is found as a direct dependency.
364 sourceModDepFound = child == module
365 return sourceModDepFound
366 }
367 // Second level: Follow PrebuiltDepTag to the prebuilt.
368 if t := ctx.OtherModuleDependencyTag(child); t == PrebuiltDepTag {
369 prebuiltMod = child
370 }
371 return false
372 })
373
374 if prebuiltMod == nil {
375 if !sourceModDepFound {
376 panic(fmt.Errorf("Failed to find source module as a direct dependency: %s", module))
377 } else {
378 panic(fmt.Errorf("Failed to find prebuilt for source module: %s", module))
379 }
380 }
381 return prebuiltMod
382}
383
Colin Cross5ea9bcc2017-07-27 15:41:32 -0700384func RegisterPrebuiltsPreArchMutators(ctx RegisterMutatorsContext) {
Martin Stjernholm009a9dc2020-03-05 17:34:13 +0000385 ctx.BottomUp("prebuilt_rename", PrebuiltRenameMutator).Parallel()
Colin Crosscec81712017-07-13 14:43:27 -0700386}
387
Colin Cross5ea9bcc2017-07-27 15:41:32 -0700388func RegisterPrebuiltsPostDepsMutators(ctx RegisterMutatorsContext) {
Martin Stjernholm009a9dc2020-03-05 17:34:13 +0000389 ctx.BottomUp("prebuilt_source", PrebuiltSourceDepsMutator).Parallel()
Spandan Das1c4d94d2023-10-26 22:38:34 +0000390 ctx.BottomUp("prebuilt_select", PrebuiltSelectModuleMutator).Parallel()
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700391 ctx.BottomUp("prebuilt_postdeps", PrebuiltPostDepsMutator).Parallel()
Colin Crosscec81712017-07-13 14:43:27 -0700392}
393
Spandan Das3576e762024-01-03 18:57:03 +0000394// Returns the name of the source module corresponding to a prebuilt module
395// For source modules, it returns its own name
396type baseModuleName interface {
397 BaseModuleName() string
398}
399
Martin Stjernholm009a9dc2020-03-05 17:34:13 +0000400// PrebuiltRenameMutator ensures that there always is a module with an
401// undecorated name.
402func PrebuiltRenameMutator(ctx BottomUpMutatorContext) {
Paul Duffinf7c99f52021-04-28 10:41:21 +0100403 m := ctx.Module()
404 if p := GetEmbeddedPrebuilt(m); p != nil {
Spandan Das3576e762024-01-03 18:57:03 +0000405 bmn, _ := m.(baseModuleName)
406 name := bmn.BaseModuleName()
Martin Stjernholm009a9dc2020-03-05 17:34:13 +0000407 if !ctx.OtherModuleExists(name) {
408 ctx.Rename(name)
Paul Duffinf7c99f52021-04-28 10:41:21 +0100409 p.properties.PrebuiltRenamedToSource = true
Martin Stjernholm009a9dc2020-03-05 17:34:13 +0000410 }
411 }
412}
413
414// PrebuiltSourceDepsMutator adds dependencies to the prebuilt module from the
415// corresponding source module, if one exists for the same variant.
Spandan Das1c4d94d2023-10-26 22:38:34 +0000416// Add a dependency from the prebuilt to `all_apex_contributions`
417// The metadata will be used for source vs prebuilts selection
Martin Stjernholm009a9dc2020-03-05 17:34:13 +0000418func PrebuiltSourceDepsMutator(ctx BottomUpMutatorContext) {
Paul Duffinf7c99f52021-04-28 10:41:21 +0100419 m := ctx.Module()
420 // If this module is a prebuilt, is enabled and has not been renamed to source then add a
421 // dependency onto the source if it is present.
422 if p := GetEmbeddedPrebuilt(m); p != nil && m.Enabled() && !p.properties.PrebuiltRenamedToSource {
Spandan Das3576e762024-01-03 18:57:03 +0000423 bmn, _ := m.(baseModuleName)
424 name := bmn.BaseModuleName()
Paul Duffinf7c99f52021-04-28 10:41:21 +0100425 if ctx.OtherModuleReverseDependencyVariantExists(name) {
426 ctx.AddReverseDependency(ctx.Module(), PrebuiltDepTag, name)
427 p.properties.SourceExists = true
Colin Crossce75d2c2016-10-06 16:12:58 -0700428 }
Spandan Das1c4d94d2023-10-26 22:38:34 +0000429 // Add a dependency from the prebuilt to the `all_apex_contributions`
430 // metadata module
431 // TODO: When all branches contain this singleton module, make this strict
432 // TODO: Add this dependency only for mainline prebuilts and not every prebuilt module
433 if ctx.OtherModuleExists("all_apex_contributions") {
434 ctx.AddDependency(m, acDepTag, "all_apex_contributions")
435 }
436
Colin Crossce75d2c2016-10-06 16:12:58 -0700437 }
438}
439
Jooyung Hanebaa5732023-05-02 11:43:14 +0900440// checkInvariantsForSourceAndPrebuilt checks if invariants are kept when replacing
441// source with prebuilt. Note that the current module for the context is the source module.
442func checkInvariantsForSourceAndPrebuilt(ctx BaseModuleContext, s, p Module) {
443 if _, ok := s.(OverrideModule); ok {
444 // skip the check when the source module is `override_X` because it's only a placeholder
445 // for the actual source module. The check will be invoked for the actual module.
446 return
447 }
448 if sourcePartition, prebuiltPartition := s.PartitionTag(ctx.DeviceConfig()), p.PartitionTag(ctx.DeviceConfig()); sourcePartition != prebuiltPartition {
449 ctx.OtherModuleErrorf(p, "partition is different: %s(%s) != %s(%s)",
450 sourcePartition, ctx.ModuleName(), prebuiltPartition, ctx.OtherModuleName(p))
451 }
452}
453
Colin Crossc3e7fa62017-03-17 13:14:32 -0700454// PrebuiltSelectModuleMutator marks prebuilts that are used, either overriding source modules or
455// because the source module doesn't exist. It also disables installing overridden source modules.
Spandan Dase3fcb412023-10-26 20:48:02 +0000456//
457// If the visited module is the metadata module `all_apex_contributions`, it sets a
458// provider containing metadata about whether source or prebuilt of mainline modules should be used.
459// This logic was added here to prevent the overhead of creating a new mutator.
Spandan Das1c4d94d2023-10-26 22:38:34 +0000460func PrebuiltSelectModuleMutator(ctx BottomUpMutatorContext) {
Paul Duffinf7c99f52021-04-28 10:41:21 +0100461 m := ctx.Module()
462 if p := GetEmbeddedPrebuilt(m); p != nil {
Martin Stjernholme65c3ae2021-11-23 01:24:06 +0000463 if p.srcsSupplier == nil && p.srcsPropertyName == "" {
Colin Cross74d73e22017-08-02 11:05:49 -0700464 panic(fmt.Errorf("prebuilt module did not have InitPrebuiltModule called on it"))
465 }
466 if !p.properties.SourceExists {
Paul Duffinc04fb9e2021-03-01 12:25:10 +0000467 p.properties.UsePrebuilt = p.usePrebuilt(ctx, nil, m)
Colin Crossc3e7fa62017-03-17 13:14:32 -0700468 }
Spandan Das1c4d94d2023-10-26 22:38:34 +0000469 // Propagate the provider received from `all_apex_contributions`
470 // to the source module
471 ctx.VisitDirectDepsWithTag(acDepTag, func(am Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800472 psi, _ := OtherModuleProvider(ctx, am, PrebuiltSelectionInfoProvider)
473 SetProvider(ctx, PrebuiltSelectionInfoProvider, psi)
Spandan Das1c4d94d2023-10-26 22:38:34 +0000474 })
475
Colin Crossc3e7fa62017-03-17 13:14:32 -0700476 } else if s, ok := ctx.Module().(Module); ok {
Spandan Das3576e762024-01-03 18:57:03 +0000477 // Use `all_apex_contributions` for source vs prebuilt selection.
478 psi := PrebuiltSelectionInfoMap{}
479 ctx.VisitDirectDepsWithTag(PrebuiltDepTag, func(am Module) {
480 // The value of psi gets overwritten with the provider from the last visited prebuilt.
481 // But all prebuilts have the same value of the provider, so this should be idempontent.
482 psi, _ = OtherModuleProvider(ctx, am, PrebuiltSelectionInfoProvider)
483 })
Paul Duffinf7c99f52021-04-28 10:41:21 +0100484 ctx.VisitDirectDepsWithTag(PrebuiltDepTag, func(prebuiltModule Module) {
485 p := GetEmbeddedPrebuilt(prebuiltModule)
486 if p.usePrebuilt(ctx, s, prebuiltModule) {
Jooyung Hanebaa5732023-05-02 11:43:14 +0900487 checkInvariantsForSourceAndPrebuilt(ctx, s, prebuiltModule)
488
Colin Crossee6143c2017-12-30 17:54:27 -0800489 p.properties.UsePrebuilt = true
Liz Kammer5ca3a622020-08-05 15:40:41 -0700490 s.ReplacedByPrebuilt()
Colin Crossa2f296f2016-11-29 15:16:18 -0800491 }
492 })
Spandan Das3576e762024-01-03 18:57:03 +0000493
494 // If any module in this mainline module family has been flagged using apex_contributions, disable every other module in that family
495 // Add source
496 allModules := []Module{s}
497 // Add each prebuilt
498 ctx.VisitDirectDepsWithTag(PrebuiltDepTag, func(prebuiltModule Module) {
499 allModules = append(allModules, prebuiltModule)
500 })
501 hideUnflaggedModules(ctx, psi, allModules)
502
Colin Crossa2f296f2016-11-29 15:16:18 -0800503 }
Spandan Das3576e762024-01-03 18:57:03 +0000504
Spandan Dase3fcb412023-10-26 20:48:02 +0000505 // If this is `all_apex_contributions`, set a provider containing
506 // metadata about source vs prebuilts selection
507 if am, ok := m.(*allApexContributions); ok {
508 am.SetPrebuiltSelectionInfoProvider(ctx)
509 }
Colin Crossa2f296f2016-11-29 15:16:18 -0800510}
511
Spandan Das3576e762024-01-03 18:57:03 +0000512// If any module in this mainline module family has been flagged using apex_contributions, disable every other module in that family
513func hideUnflaggedModules(ctx BottomUpMutatorContext, psi PrebuiltSelectionInfoMap, allModulesInFamily []Module) {
514 var selectedModuleInFamily Module
515 // query all_apex_contributions to see if any module in this family has been selected
516 for _, moduleInFamily := range allModulesInFamily {
517 // validate that are no duplicates
518 if psi.IsSelected(moduleInFamily.Name()) {
519 if selectedModuleInFamily == nil {
520 // Store this so we can validate that there are no duplicates
521 selectedModuleInFamily = moduleInFamily
522 } else {
523 // There are duplicate modules from the same mainline module family
524 ctx.ModuleErrorf("Found duplicate variations of the same module in apex_contributions: %s and %s. Please remove one of these.\n", selectedModuleInFamily.Name(), moduleInFamily.Name())
525 }
526 }
527 }
528
529 // If a module has been selected, hide all other modules
530 if selectedModuleInFamily != nil {
531 for _, moduleInFamily := range allModulesInFamily {
532 if moduleInFamily.Name() != selectedModuleInFamily.Name() {
533 moduleInFamily.HideFromMake()
534 }
535 }
536 }
537}
538
Jaewoong Jung6158dfe2021-03-23 14:08:29 -0700539// PrebuiltPostDepsMutator replaces dependencies on the source module with dependencies on the
540// prebuilt when both modules exist and the prebuilt should be used. When the prebuilt should not
541// be used, disable installing it.
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700542func PrebuiltPostDepsMutator(ctx BottomUpMutatorContext) {
Paul Duffinf7c99f52021-04-28 10:41:21 +0100543 m := ctx.Module()
544 if p := GetEmbeddedPrebuilt(m); p != nil {
Spandan Das3576e762024-01-03 18:57:03 +0000545 bmn, _ := m.(baseModuleName)
546 name := bmn.BaseModuleName()
Colin Cross74d73e22017-08-02 11:05:49 -0700547 if p.properties.UsePrebuilt {
548 if p.properties.SourceExists {
Paul Duffin80342d72020-06-26 22:08:43 +0100549 ctx.ReplaceDependenciesIf(name, func(from blueprint.Module, tag blueprint.DependencyTag, to blueprint.Module) bool {
550 if t, ok := tag.(ReplaceSourceWithPrebuilt); ok {
551 return t.ReplaceSourceWithPrebuilt()
552 }
553
554 return true
555 })
Colin Cross0f3c72f2016-11-23 15:44:07 -0800556 }
557 } else {
Colin Crossa9c8c9f2020-12-16 10:20:23 -0800558 m.HideFromMake()
Colin Crossce75d2c2016-10-06 16:12:58 -0700559 }
560 }
561}
562
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000563// A wrapper around PrebuiltSelectionInfoMap.IsSelected with special handling for java_sdk_library
564// java_sdk_library is a macro that creates
565// 1. top-level impl library
566// 2. stub libraries (suffixed with .stubs...)
567//
568// java_sdk_library_import is a macro that creates
569// 1. top-level "impl" library
570// 2. stub libraries (suffixed with .stubs...)
571//
572// the impl of java_sdk_library_import is a "hook" for hiddenapi and dexpreopt processing. It does not have an impl jar, but acts as a shim
573// to provide the jar deapxed from the prebuilt apex
574//
575// isSelected uses `all_apex_contributions` to supersede source vs prebuilts selection of the stub libraries. It does not supersede the
576// selection of the top-level "impl" library so that this hook can work
577//
578// TODO (b/308174306) - Fix this when we need to support multiple prebuilts in main
579func isSelected(psi PrebuiltSelectionInfoMap, m Module) bool {
580 if sdkLibrary, ok := m.(interface{ SdkLibraryName() *string }); ok && sdkLibrary.SdkLibraryName() != nil {
581 sln := proptools.String(sdkLibrary.SdkLibraryName())
582 // This is the top-level library
583 // Do not supersede the existing prebuilts vs source selection mechanisms
584 if sln == m.base().BaseModuleName() {
585 return false
586 }
587
588 // Stub library created by java_sdk_library_import
589 if p := GetEmbeddedPrebuilt(m); p != nil {
Spandan Das3576e762024-01-03 18:57:03 +0000590 return psi.IsSelected(PrebuiltNameFromSource(sln))
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000591 }
592
593 // Stub library created by java_sdk_library
Spandan Das3576e762024-01-03 18:57:03 +0000594 return psi.IsSelected(sln)
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000595 }
Spandan Das3576e762024-01-03 18:57:03 +0000596 return psi.IsSelected(m.Name())
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000597}
598
Colin Crossa2f296f2016-11-29 15:16:18 -0800599// usePrebuilt returns true if a prebuilt should be used instead of the source module. The prebuilt
600// will be used if it is marked "prefer" or if the source module is disabled.
Spandan Das1c4d94d2023-10-26 22:38:34 +0000601func (p *Prebuilt) usePrebuilt(ctx BaseMutatorContext, source Module, prebuilt Module) bool {
602 // Use `all_apex_contributions` for source vs prebuilt selection.
603 psi := PrebuiltSelectionInfoMap{}
604 ctx.VisitDirectDepsWithTag(PrebuiltDepTag, func(am Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800605 psi, _ = OtherModuleProvider(ctx, am, PrebuiltSelectionInfoProvider)
Spandan Das1c4d94d2023-10-26 22:38:34 +0000606 })
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000607
Spandan Das1c4d94d2023-10-26 22:38:34 +0000608 // If the source module is explicitly listed in the metadata module, use that
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000609 if source != nil && isSelected(psi, source) {
Spandan Das1c4d94d2023-10-26 22:38:34 +0000610 return false
611 }
612 // If the prebuilt module is explicitly listed in the metadata module, use that
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000613 if isSelected(psi, prebuilt) {
Spandan Das1c4d94d2023-10-26 22:38:34 +0000614 return true
615 }
Spandan Dasfc12d2f2023-10-27 20:06:32 +0000616
Spandan Das1c4d94d2023-10-26 22:38:34 +0000617 // If the baseModuleName could not be found in the metadata module,
618 // fall back to the existing source vs prebuilt selection.
619 // TODO: Drop the fallback mechanisms
620
Colin Crossb63d7b32023-12-07 16:54:51 -0800621 if p.srcsSupplier != nil && len(p.srcsSupplier(ctx, prebuilt)) == 0 {
622 return false
623 }
Colin Crossce75d2c2016-10-06 16:12:58 -0700624
Colin Crossb63d7b32023-12-07 16:54:51 -0800625 // Skip prebuilt modules under unexported namespaces so that we won't
626 // end up shadowing non-prebuilt module when prebuilt module under same
627 // name happens to have a `Prefer` property set to true.
628 if ctx.Config().KatiEnabled() && !prebuilt.ExportedToMake() {
629 return false
LuK1337fb545bf2021-01-10 17:47:46 +0100630 }
631
Paul Duffin0c52c7b2021-07-06 17:15:25 +0100632 // If source is not available or is disabled then always use the prebuilt.
633 if source == nil || !source.Enabled() {
Colin Crossb63d7b32023-12-07 16:54:51 -0800634 return true
Colin Crossa2f296f2016-11-29 15:16:18 -0800635 }
636
Paul Duffin0c52c7b2021-07-06 17:15:25 +0100637 // If the use_source_config_var property is set then it overrides the prefer property setting.
638 if configVar := p.properties.Use_source_config_var; configVar != nil {
639 return !ctx.Config().VendorConfig(proptools.String(configVar.Config_namespace)).Bool(proptools.String(configVar.Var_name))
640 }
641
642 // TODO: use p.Properties.Name and ctx.ModuleDir to override preference
643 return Bool(p.properties.Prefer)
Colin Crossce75d2c2016-10-06 16:12:58 -0700644}
Jiyong Park0a573d72019-07-07 12:39:16 +0900645
646func (p *Prebuilt) SourceExists() bool {
647 return p.properties.SourceExists
648}