blob: 4b373778efd2ec6164f1180b3a60ffb7d1dd9b7c [file] [log] [blame]
Colin Cross6362e272015-10-29 15:25:03 -07001// Copyright 2015 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
Colin Cross635c3b02016-05-18 15:37:25 -070015package android
Colin Cross6362e272015-10-29 15:25:03 -070016
Colin Cross795c3772017-03-16 16:50:10 -070017import (
Colin Cross18c46802019-09-24 22:19:02 -070018 "reflect"
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -040019 "sync"
Colin Cross18c46802019-09-24 22:19:02 -070020
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +000021 "android/soong/bazel"
22
Colin Cross795c3772017-03-16 16:50:10 -070023 "github.com/google/blueprint"
Colin Cross519917d2017-11-02 16:35:56 -070024 "github.com/google/blueprint/proptools"
Colin Cross795c3772017-03-16 16:50:10 -070025)
Colin Cross6362e272015-10-29 15:25:03 -070026
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -070027// Phases:
28// run Pre-arch mutators
29// run archMutator
30// run Pre-deps mutators
31// run depsMutator
32// run PostDeps mutators
Martin Stjernholm710ec3a2020-01-16 15:12:04 +000033// run FinalDeps mutators (CreateVariations disallowed in this phase)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -070034// continue on to GenerateAndroidBuildActions
Colin Cross1e676be2016-10-12 14:38:15 -070035
Jingwen Chen73850672020-12-14 08:25:34 -050036// RegisterMutatorsForBazelConversion is a alternate registration pipeline for bp2build. Exported for testing.
Chris Parsons5a34ffb2021-07-21 14:34:58 -040037func RegisterMutatorsForBazelConversion(ctx *Context, preArchMutators, bp2buildMutators []RegisterMutatorFunc) {
Liz Kammer356f7d42021-01-26 09:18:53 -050038 mctx := &registerMutatorsContext{
39 bazelConversionMode: true,
Jingwen Chen041b1842021-02-01 00:23:25 -050040 }
41
Liz Kammer356f7d42021-01-26 09:18:53 -050042 bp2buildPreArchMutators = append([]RegisterMutatorFunc{
43 RegisterNamespaceMutator,
44 RegisterDefaultsPreArchMutators,
45 // TODO(b/165114590): this is required to resolve deps that are only prebuilts, but we should
46 // evaluate the impact on conversion.
47 RegisterPrebuiltsPreArchMutators,
48 },
49 preArchMutators...)
50
51 for _, f := range bp2buildPreArchMutators {
52 f(mctx)
53 }
54
Jingwen Chen73850672020-12-14 08:25:34 -050055 // Register bp2build mutators
56 for _, f := range bp2buildMutators {
57 f(mctx)
58 }
59
Paul Duffin1d2d42f2021-03-06 20:08:12 +000060 mctx.mutators.registerAll(ctx)
Jingwen Chen4133ce62020-12-02 04:34:15 -050061}
62
Paul Duffinc05b0342021-03-06 13:28:13 +000063// collateGloballyRegisteredMutators constructs the list of mutators that have been registered
64// with the InitRegistrationContext and will be used at runtime.
65func collateGloballyRegisteredMutators() sortableComponents {
66 return collateRegisteredMutators(preArch, preDeps, postDeps, finalDeps)
67}
68
69// collateRegisteredMutators constructs a single list of mutators from the separate lists.
70func collateRegisteredMutators(preArch, preDeps, postDeps, finalDeps []RegisterMutatorFunc) sortableComponents {
Colin Crosscec81712017-07-13 14:43:27 -070071 mctx := &registerMutatorsContext{}
Nan Zhangdb0b9a32017-02-27 10:12:13 -080072
73 register := func(funcs []RegisterMutatorFunc) {
74 for _, f := range funcs {
Colin Crosscec81712017-07-13 14:43:27 -070075 f(mctx)
Nan Zhangdb0b9a32017-02-27 10:12:13 -080076 }
77 }
78
Colin Crosscec81712017-07-13 14:43:27 -070079 register(preArch)
Nan Zhangdb0b9a32017-02-27 10:12:13 -080080
Colin Crosscec81712017-07-13 14:43:27 -070081 register(preDeps)
82
Liz Kammer356f7d42021-01-26 09:18:53 -050083 register([]RegisterMutatorFunc{registerDepsMutator})
Colin Crosscec81712017-07-13 14:43:27 -070084
85 register(postDeps)
86
Martin Stjernholm710ec3a2020-01-16 15:12:04 +000087 mctx.finalPhase = true
88 register(finalDeps)
89
Paul Duffinc05b0342021-03-06 13:28:13 +000090 return mctx.mutators
Colin Cross795c3772017-03-16 16:50:10 -070091}
92
93type registerMutatorsContext struct {
Paul Duffin1d2d42f2021-03-06 20:08:12 +000094 mutators sortableComponents
Liz Kammer356f7d42021-01-26 09:18:53 -050095 finalPhase bool
96 bazelConversionMode bool
Colin Cross795c3772017-03-16 16:50:10 -070097}
Colin Cross1e676be2016-10-12 14:38:15 -070098
99type RegisterMutatorsContext interface {
Colin Cross25de6c32019-06-06 14:29:25 -0700100 TopDown(name string, m TopDownMutator) MutatorHandle
101 BottomUp(name string, m BottomUpMutator) MutatorHandle
Colin Cross617b88a2020-08-24 18:04:09 -0700102 BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle
Colin Cross1e676be2016-10-12 14:38:15 -0700103}
104
105type RegisterMutatorFunc func(RegisterMutatorsContext)
106
Colin Crosscec81712017-07-13 14:43:27 -0700107var preArch = []RegisterMutatorFunc{
Dan Willemsen6e72ef72018-01-26 18:27:02 -0800108 RegisterNamespaceMutator,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100109
Paul Duffinaa4162e2020-05-05 11:35:43 +0100110 // Check the visibility rules are valid.
111 //
112 // This must run after the package renamer mutators so that any issues found during
113 // validation of the package's default_visibility property are reported using the
114 // correct package name and not the synthetic name.
115 //
116 // This must also be run before defaults mutators as the rules for validation are
117 // different before checking the rules than they are afterwards. e.g.
118 // visibility: ["//visibility:private", "//visibility:public"]
119 // would be invalid if specified in a module definition but is valid if it results
120 // from something like this:
121 //
122 // defaults {
123 // name: "defaults",
124 // // Be inaccessible outside a package by default.
125 // visibility: ["//visibility:private"]
126 // }
127 //
128 // defaultable_module {
129 // name: "defaultable_module",
130 // defaults: ["defaults"],
131 // // Override the default.
132 // visibility: ["//visibility:public"]
133 // }
134 //
Paul Duffin593b3c92019-12-05 14:31:48 +0000135 RegisterVisibilityRuleChecker,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100136
Bob Badour37af0462021-01-07 03:34:31 +0000137 // Record the default_applicable_licenses for each package.
138 //
139 // This must run before the defaults so that defaults modules can pick up the package default.
140 RegisterLicensesPackageMapper,
141
Paul Duffinaa4162e2020-05-05 11:35:43 +0100142 // Apply properties from defaults modules to the referencing modules.
Paul Duffinafa9fa12020-04-29 16:47:28 +0100143 //
144 // Any mutators that are added before this will not see any modules created by
145 // a DefaultableHook.
Colin Cross89536d42017-07-07 14:35:50 -0700146 RegisterDefaultsPreArchMutators,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100147
Paul Duffin44f1d842020-06-26 20:17:02 +0100148 // Add dependencies on any components so that any component references can be
149 // resolved within the deps mutator.
150 //
151 // Must be run after defaults so it can be used to create dependencies on the
152 // component modules that are creating in a DefaultableHook.
153 //
154 // Must be run before RegisterPrebuiltsPreArchMutators, i.e. before prebuilts are
155 // renamed. That is so that if a module creates components using a prebuilt module
156 // type that any dependencies (which must use prebuilt_ prefixes) are resolved to
157 // the prebuilt module and not the source module.
158 RegisterComponentsMutator,
159
Paul Duffinc988c8e2020-04-29 18:27:14 +0100160 // Create an association between prebuilt modules and their corresponding source
161 // modules (if any).
Paul Duffinafa9fa12020-04-29 16:47:28 +0100162 //
163 // Must be run after defaults mutators to ensure that any modules created by
164 // a DefaultableHook can be either a prebuilt or a source module with a matching
165 // prebuilt.
Paul Duffinc988c8e2020-04-29 18:27:14 +0100166 RegisterPrebuiltsPreArchMutators,
167
Bob Badour37af0462021-01-07 03:34:31 +0000168 // Gather the licenses properties for all modules for use during expansion and enforcement.
169 //
170 // This must come after the defaults mutators to ensure that any licenses supplied
171 // in a defaults module has been successfully applied before the rules are gathered.
172 RegisterLicensesPropertyGatherer,
173
Paul Duffinaa4162e2020-05-05 11:35:43 +0100174 // Gather the visibility rules for all modules for us during visibility enforcement.
175 //
176 // This must come after the defaults mutators to ensure that any visibility supplied
177 // in a defaults module has been successfully applied before the rules are gathered.
Paul Duffin593b3c92019-12-05 14:31:48 +0000178 RegisterVisibilityRuleGatherer,
Colin Crosscec81712017-07-13 14:43:27 -0700179}
180
Colin Crossae4c6182017-09-15 17:33:55 -0700181func registerArchMutator(ctx RegisterMutatorsContext) {
Colin Cross617b88a2020-08-24 18:04:09 -0700182 ctx.BottomUpBlueprint("os", osMutator).Parallel()
Colin Crossfb0c16e2019-11-20 17:12:35 -0800183 ctx.BottomUp("image", imageMutator).Parallel()
Colin Cross617b88a2020-08-24 18:04:09 -0700184 ctx.BottomUpBlueprint("arch", archMutator).Parallel()
Colin Crossae4c6182017-09-15 17:33:55 -0700185}
186
Colin Crosscec81712017-07-13 14:43:27 -0700187var preDeps = []RegisterMutatorFunc{
Colin Crossae4c6182017-09-15 17:33:55 -0700188 registerArchMutator,
Colin Crosscec81712017-07-13 14:43:27 -0700189}
190
191var postDeps = []RegisterMutatorFunc{
Colin Cross1b488422019-03-04 22:33:56 -0800192 registerPathDepsMutator,
Colin Cross5ea9bcc2017-07-27 15:41:32 -0700193 RegisterPrebuiltsPostDepsMutators,
Paul Duffin593b3c92019-12-05 14:31:48 +0000194 RegisterVisibilityRuleEnforcer,
Bob Badour37af0462021-01-07 03:34:31 +0000195 RegisterLicensesDependencyChecker,
Paul Duffin45338f02021-03-30 23:07:52 +0100196 registerNeverallowMutator,
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700197 RegisterOverridePostDepsMutators,
Colin Crosscec81712017-07-13 14:43:27 -0700198}
Colin Cross1e676be2016-10-12 14:38:15 -0700199
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000200var finalDeps = []RegisterMutatorFunc{}
201
Colin Cross1e676be2016-10-12 14:38:15 -0700202func PreArchMutators(f RegisterMutatorFunc) {
203 preArch = append(preArch, f)
204}
205
206func PreDepsMutators(f RegisterMutatorFunc) {
207 preDeps = append(preDeps, f)
208}
209
210func PostDepsMutators(f RegisterMutatorFunc) {
211 postDeps = append(postDeps, f)
212}
213
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000214func FinalDepsMutators(f RegisterMutatorFunc) {
215 finalDeps = append(finalDeps, f)
216}
217
Liz Kammer356f7d42021-01-26 09:18:53 -0500218var bp2buildPreArchMutators = []RegisterMutatorFunc{}
Jingwen Chen12b4c272021-03-10 02:05:59 -0500219var bp2buildMutators = map[string]RegisterMutatorFunc{}
Jingwen Chen73850672020-12-14 08:25:34 -0500220
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -0400221// See http://b/192523357
222var bp2buildLock sync.Mutex
223
Jingwen Chen73850672020-12-14 08:25:34 -0500224// RegisterBp2BuildMutator registers specially crafted mutators for
225// converting Blueprint/Android modules into special modules that can
226// be code-generated into Bazel BUILD targets.
227//
228// TODO(b/178068862): bring this into TestContext.
229func RegisterBp2BuildMutator(moduleType string, m func(TopDownMutatorContext)) {
Jingwen Chen73850672020-12-14 08:25:34 -0500230 f := func(ctx RegisterMutatorsContext) {
Liz Kammer356f7d42021-01-26 09:18:53 -0500231 ctx.TopDown(moduleType, m)
Jingwen Chen73850672020-12-14 08:25:34 -0500232 }
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -0400233 // Use a lock to avoid a concurrent map write if RegisterBp2BuildMutator is called in parallel
234 bp2buildLock.Lock()
235 defer bp2buildLock.Unlock()
Jingwen Chen12b4c272021-03-10 02:05:59 -0500236 bp2buildMutators[moduleType] = f
Jingwen Chen73850672020-12-14 08:25:34 -0500237}
238
Liz Kammer356f7d42021-01-26 09:18:53 -0500239// PreArchBp2BuildMutators adds mutators to be register for converting Android Blueprint modules
240// into Bazel BUILD targets that should run prior to deps and conversion.
241func PreArchBp2BuildMutators(f RegisterMutatorFunc) {
242 bp2buildPreArchMutators = append(bp2buildPreArchMutators, f)
243}
244
Colin Cross9f35c3d2020-09-16 19:04:41 -0700245type BaseMutatorContext interface {
246 BaseModuleContext
247
248 // MutatorName returns the name that this mutator was registered with.
249 MutatorName() string
250
251 // Rename all variants of a module. The new name is not visible to calls to ModuleName,
252 // AddDependency or OtherModuleName until after this mutator pass is complete.
253 Rename(name string)
Chris Parsons5a34ffb2021-07-21 14:34:58 -0400254
255 // BazelConversionMode returns whether this mutator is being run as part of Bazel Conversion.
256 BazelConversionMode() bool
Colin Cross9f35c3d2020-09-16 19:04:41 -0700257}
258
Colin Cross25de6c32019-06-06 14:29:25 -0700259type TopDownMutator func(TopDownMutatorContext)
Colin Cross6362e272015-10-29 15:25:03 -0700260
Colin Cross635c3b02016-05-18 15:37:25 -0700261type TopDownMutatorContext interface {
Colin Cross9f35c3d2020-09-16 19:04:41 -0700262 BaseMutatorContext
Colin Cross3f68a132017-10-23 17:10:29 -0700263
Colin Cross9f35c3d2020-09-16 19:04:41 -0700264 // CreateModule creates a new module by calling the factory method for the specified moduleType, and applies
265 // the specified property structs to it as if the properties were set in a blueprint file.
Colin Crosse003c4a2019-09-25 12:58:36 -0700266 CreateModule(ModuleFactory, ...interface{}) Module
Jingwen Chen1fd14692021-02-05 03:01:50 -0500267
268 // CreateBazelTargetModule creates a BazelTargetModule by calling the
269 // factory method, just like in CreateModule, but also requires
270 // BazelTargetModuleProperties containing additional metadata for the
271 // bp2build codegenerator.
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +0000272 CreateBazelTargetModule(bazel.BazelTargetModuleProperties, CommonAttributes, interface{})
Colin Cross6362e272015-10-29 15:25:03 -0700273}
274
Colin Cross25de6c32019-06-06 14:29:25 -0700275type topDownMutatorContext struct {
Colin Crossdc35e212019-06-06 16:13:11 -0700276 bp blueprint.TopDownMutatorContext
Colin Cross0ea8ba82019-06-06 14:33:29 -0700277 baseModuleContext
Colin Cross6362e272015-10-29 15:25:03 -0700278}
279
Colin Cross25de6c32019-06-06 14:29:25 -0700280type BottomUpMutator func(BottomUpMutatorContext)
Colin Cross6362e272015-10-29 15:25:03 -0700281
Colin Cross635c3b02016-05-18 15:37:25 -0700282type BottomUpMutatorContext interface {
Colin Cross9f35c3d2020-09-16 19:04:41 -0700283 BaseMutatorContext
Colin Crossaabf6792017-11-29 00:27:14 -0800284
Colin Cross4f1dcb02020-09-16 18:45:04 -0700285 // AddDependency adds a dependency to the given module. It returns a slice of modules for each
286 // dependency (some entries may be nil).
287 //
288 // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the
289 // new dependencies have had the current mutator called on them. If the mutator is not
290 // parallel this method does not affect the ordering of the current mutator pass, but will
291 // be ordered correctly for all future mutator passes.
292 AddDependency(module blueprint.Module, tag blueprint.DependencyTag, name ...string) []blueprint.Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700293
294 // AddReverseDependency adds a dependency from the destination to the given module.
295 // Does not affect the ordering of the current mutator pass, but will be ordered
296 // correctly for all future mutator passes. All reverse dependencies for a destination module are
297 // collected until the end of the mutator pass, sorted by name, and then appended to the destination
298 // module's dependency list.
Colin Crossaabf6792017-11-29 00:27:14 -0800299 AddReverseDependency(module blueprint.Module, tag blueprint.DependencyTag, name string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700300
301 // CreateVariations splits a module into multiple variants, one for each name in the variationNames
302 // parameter. It returns a list of new modules in the same order as the variationNames
303 // list.
304 //
305 // If any of the dependencies of the module being operated on were already split
306 // by calling CreateVariations with the same name, the dependency will automatically
307 // be updated to point the matching variant.
308 //
309 // If a module is split, and then a module depending on the first module is not split
310 // when the Mutator is later called on it, the dependency of the depending module will
311 // automatically be updated to point to the first variant.
Colin Cross43b92e02019-11-18 15:28:57 -0800312 CreateVariations(...string) []Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700313
314 // CreateLocationVariations splits a module into multiple variants, one for each name in the variantNames
315 // parameter. It returns a list of new modules in the same order as the variantNames
316 // list.
317 //
318 // Local variations do not affect automatic dependency resolution - dependencies added
319 // to the split module via deps or DynamicDependerModule must exactly match a variant
320 // that contains all the non-local variations.
Colin Cross43b92e02019-11-18 15:28:57 -0800321 CreateLocalVariations(...string) []Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700322
323 // SetDependencyVariation sets all dangling dependencies on the current module to point to the variation
324 // with given name. This function ignores the default variation set by SetDefaultDependencyVariation.
Colin Crossaabf6792017-11-29 00:27:14 -0800325 SetDependencyVariation(string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700326
327 // SetDefaultDependencyVariation sets the default variation when a dangling reference is detected
328 // during the subsequent calls on Create*Variations* functions. To reset, set it to nil.
Jiyong Park1d1119f2019-07-29 21:27:18 +0900329 SetDefaultDependencyVariation(*string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700330
331 // AddVariationDependencies adds deps as dependencies of the current module, but uses the variations
Colin Cross4f1dcb02020-09-16 18:45:04 -0700332 // argument to select which variant of the dependency to use. It returns a slice of modules for
333 // each dependency (some entries may be nil). A variant of the dependency must exist that matches
334 // the all of the non-local variations of the current module, plus the variations argument.
335 //
336 // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the
337 // new dependencies have had the current mutator called on them. If the mutator is not
338 // parallel this method does not affect the ordering of the current mutator pass, but will
339 // be ordered correctly for all future mutator passes.
340 AddVariationDependencies([]blueprint.Variation, blueprint.DependencyTag, ...string) []blueprint.Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700341
342 // AddFarVariationDependencies adds deps as dependencies of the current module, but uses the
Colin Cross4f1dcb02020-09-16 18:45:04 -0700343 // variations argument to select which variant of the dependency to use. It returns a slice of
344 // modules for each dependency (some entries may be nil). A variant of the dependency must
345 // exist that matches the variations argument, but may also have other variations.
Colin Cross9f35c3d2020-09-16 19:04:41 -0700346 // For any unspecified variation the first variant will be used.
347 //
348 // Unlike AddVariationDependencies, the variations of the current module are ignored - the
349 // dependency only needs to match the supplied variations.
Colin Cross4f1dcb02020-09-16 18:45:04 -0700350 //
351 // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the
352 // new dependencies have had the current mutator called on them. If the mutator is not
353 // parallel this method does not affect the ordering of the current mutator pass, but will
354 // be ordered correctly for all future mutator passes.
355 AddFarVariationDependencies([]blueprint.Variation, blueprint.DependencyTag, ...string) []blueprint.Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700356
357 // AddInterVariantDependency adds a dependency between two variants of the same module. Variants are always
358 // ordered in the same orderas they were listed in CreateVariations, and AddInterVariantDependency does not change
359 // that ordering, but it associates a DependencyTag with the dependency and makes it visible to VisitDirectDeps,
360 // WalkDeps, etc.
Colin Crossaabf6792017-11-29 00:27:14 -0800361 AddInterVariantDependency(tag blueprint.DependencyTag, from, to blueprint.Module)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700362
363 // ReplaceDependencies replaces all dependencies on the identical variant of the module with the
364 // specified name with the current variant of this module. Replacements don't take effect until
365 // after the mutator pass is finished.
Colin Crossaabf6792017-11-29 00:27:14 -0800366 ReplaceDependencies(string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700367
368 // ReplaceDependencies replaces all dependencies on the identical variant of the module with the
369 // specified name with the current variant of this module as long as the supplied predicate returns
370 // true.
371 //
372 // Replacements don't take effect until after the mutator pass is finished.
Paul Duffin80342d72020-06-26 22:08:43 +0100373 ReplaceDependenciesIf(string, blueprint.ReplaceDependencyPredicate)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700374
375 // AliasVariation takes a variationName that was passed to CreateVariations for this module,
376 // and creates an alias from the current variant (before the mutator has run) to the new
377 // variant. The alias will be valid until the next time a mutator calls CreateVariations or
378 // CreateLocalVariations on this module without also calling AliasVariation. The alias can
379 // be used to add dependencies on the newly created variant using the variant map from
380 // before CreateVariations was run.
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800381 AliasVariation(variationName string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700382
383 // CreateAliasVariation takes a toVariationName that was passed to CreateVariations for this
384 // module, and creates an alias from a new fromVariationName variant the toVariationName
385 // variant. The alias will be valid until the next time a mutator calls CreateVariations or
386 // CreateLocalVariations on this module without also calling AliasVariation. The alias can
387 // be used to add dependencies on the toVariationName variant using the fromVariationName
388 // variant.
Colin Cross1b9604b2020-08-11 12:03:56 -0700389 CreateAliasVariation(fromVariationName, toVariationName string)
Colin Crossd27e7b82020-07-02 11:38:17 -0700390
391 // SetVariationProvider sets the value for a provider for the given newly created variant of
392 // the current module, i.e. one of the Modules returned by CreateVariations.. It panics if
393 // not called during the appropriate mutator or GenerateBuildActions pass for the provider,
394 // if the value is not of the appropriate type, or if the module is not a newly created
395 // variant of the current module. The value should not be modified after being passed to
396 // SetVariationProvider.
397 SetVariationProvider(module blueprint.Module, provider blueprint.ProviderKey, value interface{})
Colin Cross6362e272015-10-29 15:25:03 -0700398}
399
Colin Cross25de6c32019-06-06 14:29:25 -0700400type bottomUpMutatorContext struct {
Colin Crossdc35e212019-06-06 16:13:11 -0700401 bp blueprint.BottomUpMutatorContext
Colin Cross0ea8ba82019-06-06 14:33:29 -0700402 baseModuleContext
Chris Parsons5a34ffb2021-07-21 14:34:58 -0400403 finalPhase bool
Colin Cross6362e272015-10-29 15:25:03 -0700404}
405
Colin Cross617b88a2020-08-24 18:04:09 -0700406func bottomUpMutatorContextFactory(ctx blueprint.BottomUpMutatorContext, a Module,
Liz Kammer356f7d42021-01-26 09:18:53 -0500407 finalPhase, bazelConversionMode bool) BottomUpMutatorContext {
Colin Cross617b88a2020-08-24 18:04:09 -0700408
Chris Parsons5a34ffb2021-07-21 14:34:58 -0400409 moduleContext := a.base().baseModuleContextFactory(ctx)
410 moduleContext.bazelConversionMode = bazelConversionMode
411
Colin Cross617b88a2020-08-24 18:04:09 -0700412 return &bottomUpMutatorContext{
Chris Parsons5a34ffb2021-07-21 14:34:58 -0400413 bp: ctx,
414 baseModuleContext: a.base().baseModuleContextFactory(ctx),
415 finalPhase: finalPhase,
Colin Cross617b88a2020-08-24 18:04:09 -0700416 }
417}
418
Colin Cross25de6c32019-06-06 14:29:25 -0700419func (x *registerMutatorsContext) BottomUp(name string, m BottomUpMutator) MutatorHandle {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000420 finalPhase := x.finalPhase
Liz Kammer356f7d42021-01-26 09:18:53 -0500421 bazelConversionMode := x.bazelConversionMode
Colin Cross798bfce2016-10-12 14:28:16 -0700422 f := func(ctx blueprint.BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700423 if a, ok := ctx.Module().(Module); ok {
Liz Kammer356f7d42021-01-26 09:18:53 -0500424 m(bottomUpMutatorContextFactory(ctx, a, finalPhase, bazelConversionMode))
Colin Cross6362e272015-10-29 15:25:03 -0700425 }
Colin Cross798bfce2016-10-12 14:28:16 -0700426 }
Liz Kammer356f7d42021-01-26 09:18:53 -0500427 mutator := &mutator{name: x.mutatorName(name), bottomUpMutator: f}
Colin Cross795c3772017-03-16 16:50:10 -0700428 x.mutators = append(x.mutators, mutator)
Colin Cross798bfce2016-10-12 14:28:16 -0700429 return mutator
Colin Cross6362e272015-10-29 15:25:03 -0700430}
431
Colin Cross617b88a2020-08-24 18:04:09 -0700432func (x *registerMutatorsContext) BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle {
433 mutator := &mutator{name: name, bottomUpMutator: m}
434 x.mutators = append(x.mutators, mutator)
435 return mutator
436}
437
Liz Kammer356f7d42021-01-26 09:18:53 -0500438func (x *registerMutatorsContext) mutatorName(name string) string {
439 if x.bazelConversionMode {
440 return name + "_bp2build"
441 }
442 return name
443}
444
Colin Cross25de6c32019-06-06 14:29:25 -0700445func (x *registerMutatorsContext) TopDown(name string, m TopDownMutator) MutatorHandle {
Colin Cross798bfce2016-10-12 14:28:16 -0700446 f := func(ctx blueprint.TopDownMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700447 if a, ok := ctx.Module().(Module); ok {
Chris Parsons5a34ffb2021-07-21 14:34:58 -0400448 moduleContext := a.base().baseModuleContextFactory(ctx)
449 moduleContext.bazelConversionMode = x.bazelConversionMode
Colin Cross25de6c32019-06-06 14:29:25 -0700450 actx := &topDownMutatorContext{
Colin Crossdc35e212019-06-06 16:13:11 -0700451 bp: ctx,
Chris Parsons5a34ffb2021-07-21 14:34:58 -0400452 baseModuleContext: moduleContext,
Colin Cross6362e272015-10-29 15:25:03 -0700453 }
Colin Cross798bfce2016-10-12 14:28:16 -0700454 m(actx)
Colin Cross6362e272015-10-29 15:25:03 -0700455 }
Colin Cross798bfce2016-10-12 14:28:16 -0700456 }
Liz Kammer356f7d42021-01-26 09:18:53 -0500457 mutator := &mutator{name: x.mutatorName(name), topDownMutator: f}
Colin Cross795c3772017-03-16 16:50:10 -0700458 x.mutators = append(x.mutators, mutator)
Colin Cross798bfce2016-10-12 14:28:16 -0700459 return mutator
460}
461
Paul Duffin1d2d42f2021-03-06 20:08:12 +0000462func (mutator *mutator) componentName() string {
463 return mutator.name
464}
465
466func (mutator *mutator) register(ctx *Context) {
467 blueprintCtx := ctx.Context
468 var handle blueprint.MutatorHandle
469 if mutator.bottomUpMutator != nil {
470 handle = blueprintCtx.RegisterBottomUpMutator(mutator.name, mutator.bottomUpMutator)
471 } else if mutator.topDownMutator != nil {
472 handle = blueprintCtx.RegisterTopDownMutator(mutator.name, mutator.topDownMutator)
473 }
474 if mutator.parallel {
475 handle.Parallel()
476 }
477}
478
Colin Cross798bfce2016-10-12 14:28:16 -0700479type MutatorHandle interface {
480 Parallel() MutatorHandle
481}
482
483func (mutator *mutator) Parallel() MutatorHandle {
484 mutator.parallel = true
485 return mutator
Colin Cross6362e272015-10-29 15:25:03 -0700486}
Colin Cross1e676be2016-10-12 14:38:15 -0700487
Paul Duffin44f1d842020-06-26 20:17:02 +0100488func RegisterComponentsMutator(ctx RegisterMutatorsContext) {
489 ctx.BottomUp("component-deps", componentDepsMutator).Parallel()
490}
491
492// A special mutator that runs just prior to the deps mutator to allow the dependencies
493// on component modules to be added so that they can depend directly on a prebuilt
494// module.
495func componentDepsMutator(ctx BottomUpMutatorContext) {
496 if m := ctx.Module(); m.Enabled() {
497 m.ComponentDepsMutator(ctx)
498 }
499}
500
Colin Cross1e676be2016-10-12 14:38:15 -0700501func depsMutator(ctx BottomUpMutatorContext) {
Paul Duffin44f1d842020-06-26 20:17:02 +0100502 if m := ctx.Module(); m.Enabled() {
Colin Cross1e676be2016-10-12 14:38:15 -0700503 m.DepsMutator(ctx)
504 }
505}
Colin Crossd11fcda2017-10-23 17:59:01 -0700506
Liz Kammer356f7d42021-01-26 09:18:53 -0500507func registerDepsMutator(ctx RegisterMutatorsContext) {
508 ctx.BottomUp("deps", depsMutator).Parallel()
509}
510
511func registerDepsMutatorBp2Build(ctx RegisterMutatorsContext) {
512 // TODO(b/179313531): Consider a separate mutator that only runs depsMutator for modules that are
513 // being converted to build targets.
514 ctx.BottomUp("deps", depsMutator).Parallel()
515}
516
Jingwen Chen1fd14692021-02-05 03:01:50 -0500517func (t *topDownMutatorContext) CreateBazelTargetModule(
Jingwen Chen1fd14692021-02-05 03:01:50 -0500518 bazelProps bazel.BazelTargetModuleProperties,
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +0000519 commonAttrs CommonAttributes,
Liz Kammer2ada09a2021-08-11 00:17:36 -0400520 attrs interface{}) {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +0000521 commonAttrs.fillCommonBp2BuildModuleAttrs(t)
522 mod := t.Module()
Liz Kammer2ada09a2021-08-11 00:17:36 -0400523 info := bp2buildInfo{
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +0000524 Dir: t.OtherModuleDir(mod),
525 BazelProps: bazelProps,
526 CommonAttrs: commonAttrs,
527 Attrs: attrs,
Jingwen Chenfb4692a2021-02-07 10:05:16 -0500528 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +0000529 mod.base().addBp2buildInfo(info)
Jingwen Chen1fd14692021-02-05 03:01:50 -0500530}
531
Colin Cross25de6c32019-06-06 14:29:25 -0700532func (t *topDownMutatorContext) AppendProperties(props ...interface{}) {
Colin Cross519917d2017-11-02 16:35:56 -0700533 for _, p := range props {
Colin Cross25de6c32019-06-06 14:29:25 -0700534 err := proptools.AppendMatchingProperties(t.Module().base().customizableProperties,
Colin Cross519917d2017-11-02 16:35:56 -0700535 p, nil)
536 if err != nil {
537 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700538 t.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
Colin Cross519917d2017-11-02 16:35:56 -0700539 } else {
540 panic(err)
541 }
542 }
543 }
544}
545
Colin Cross25de6c32019-06-06 14:29:25 -0700546func (t *topDownMutatorContext) PrependProperties(props ...interface{}) {
Colin Cross519917d2017-11-02 16:35:56 -0700547 for _, p := range props {
Colin Cross25de6c32019-06-06 14:29:25 -0700548 err := proptools.PrependMatchingProperties(t.Module().base().customizableProperties,
Colin Cross519917d2017-11-02 16:35:56 -0700549 p, nil)
550 if err != nil {
551 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700552 t.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
Colin Cross519917d2017-11-02 16:35:56 -0700553 } else {
554 panic(err)
555 }
556 }
557 }
558}
Colin Crossdc35e212019-06-06 16:13:11 -0700559
560// android.topDownMutatorContext either has to embed blueprint.TopDownMutatorContext, in which case every method that
561// has an overridden version in android.BaseModuleContext has to be manually forwarded to BaseModuleContext to avoid
562// ambiguous method errors, or it has to store a blueprint.TopDownMutatorContext non-embedded, in which case every
563// non-overridden method has to be forwarded. There are fewer non-overridden methods, so use the latter. The following
564// methods forward to the identical blueprint versions for topDownMutatorContext and bottomUpMutatorContext.
565
Colin Crosscb55e082019-07-01 15:32:31 -0700566func (t *topDownMutatorContext) MutatorName() string {
567 return t.bp.MutatorName()
568}
569
Colin Crossdc35e212019-06-06 16:13:11 -0700570func (t *topDownMutatorContext) Rename(name string) {
571 t.bp.Rename(name)
Colin Cross9a362232019-07-01 15:32:45 -0700572 t.Module().base().commonProperties.DebugName = name
Colin Crossdc35e212019-06-06 16:13:11 -0700573}
574
Colin Crosse003c4a2019-09-25 12:58:36 -0700575func (t *topDownMutatorContext) CreateModule(factory ModuleFactory, props ...interface{}) Module {
Colin Cross18c46802019-09-24 22:19:02 -0700576 inherited := []interface{}{&t.Module().base().commonProperties}
Colin Crosse003c4a2019-09-25 12:58:36 -0700577 module := t.bp.CreateModule(ModuleFactoryAdaptor(factory), append(inherited, props...)...).(Module)
Colin Cross18c46802019-09-24 22:19:02 -0700578
579 if t.Module().base().variableProperties != nil && module.base().variableProperties != nil {
580 src := t.Module().base().variableProperties
581 dst := []interface{}{
582 module.base().variableProperties,
583 // Put an empty copy of the src properties into dst so that properties in src that are not in dst
584 // don't cause a "failed to find property to extend" error.
Colin Cross43e789d2020-01-28 09:46:50 -0800585 proptools.CloneEmptyProperties(reflect.ValueOf(src)).Interface(),
Colin Cross18c46802019-09-24 22:19:02 -0700586 }
587 err := proptools.AppendMatchingProperties(dst, src, nil)
588 if err != nil {
589 panic(err)
590 }
591 }
592
Colin Crosse003c4a2019-09-25 12:58:36 -0700593 return module
Colin Crossdc35e212019-06-06 16:13:11 -0700594}
595
Liz Kammera060c452021-03-24 10:14:47 -0400596func (t *topDownMutatorContext) createModuleWithoutInheritance(factory ModuleFactory, props ...interface{}) Module {
597 module := t.bp.CreateModule(ModuleFactoryAdaptor(factory), props...).(Module)
598 return module
599}
600
Colin Crosscb55e082019-07-01 15:32:31 -0700601func (b *bottomUpMutatorContext) MutatorName() string {
602 return b.bp.MutatorName()
603}
604
Colin Crossdc35e212019-06-06 16:13:11 -0700605func (b *bottomUpMutatorContext) Rename(name string) {
606 b.bp.Rename(name)
Colin Cross9a362232019-07-01 15:32:45 -0700607 b.Module().base().commonProperties.DebugName = name
Colin Crossdc35e212019-06-06 16:13:11 -0700608}
609
Colin Cross4f1dcb02020-09-16 18:45:04 -0700610func (b *bottomUpMutatorContext) AddDependency(module blueprint.Module, tag blueprint.DependencyTag, name ...string) []blueprint.Module {
611 return b.bp.AddDependency(module, tag, name...)
Colin Crossdc35e212019-06-06 16:13:11 -0700612}
613
614func (b *bottomUpMutatorContext) AddReverseDependency(module blueprint.Module, tag blueprint.DependencyTag, name string) {
615 b.bp.AddReverseDependency(module, tag, name)
616}
617
Colin Cross43b92e02019-11-18 15:28:57 -0800618func (b *bottomUpMutatorContext) CreateVariations(variations ...string) []Module {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000619 if b.finalPhase {
620 panic("CreateVariations not allowed in FinalDepsMutators")
621 }
622
Colin Cross9a362232019-07-01 15:32:45 -0700623 modules := b.bp.CreateVariations(variations...)
624
Colin Cross43b92e02019-11-18 15:28:57 -0800625 aModules := make([]Module, len(modules))
Colin Cross9a362232019-07-01 15:32:45 -0700626 for i := range variations {
Colin Cross43b92e02019-11-18 15:28:57 -0800627 aModules[i] = modules[i].(Module)
628 base := aModules[i].base()
Colin Cross9a362232019-07-01 15:32:45 -0700629 base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName())
630 base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i])
631 }
632
Colin Cross43b92e02019-11-18 15:28:57 -0800633 return aModules
Colin Crossdc35e212019-06-06 16:13:11 -0700634}
635
Colin Cross43b92e02019-11-18 15:28:57 -0800636func (b *bottomUpMutatorContext) CreateLocalVariations(variations ...string) []Module {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000637 if b.finalPhase {
638 panic("CreateLocalVariations not allowed in FinalDepsMutators")
639 }
640
Colin Cross9a362232019-07-01 15:32:45 -0700641 modules := b.bp.CreateLocalVariations(variations...)
642
Colin Cross43b92e02019-11-18 15:28:57 -0800643 aModules := make([]Module, len(modules))
Colin Cross9a362232019-07-01 15:32:45 -0700644 for i := range variations {
Colin Cross43b92e02019-11-18 15:28:57 -0800645 aModules[i] = modules[i].(Module)
646 base := aModules[i].base()
Colin Cross9a362232019-07-01 15:32:45 -0700647 base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName())
648 base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i])
649 }
650
Colin Cross43b92e02019-11-18 15:28:57 -0800651 return aModules
Colin Crossdc35e212019-06-06 16:13:11 -0700652}
653
654func (b *bottomUpMutatorContext) SetDependencyVariation(variation string) {
655 b.bp.SetDependencyVariation(variation)
656}
657
Jiyong Park1d1119f2019-07-29 21:27:18 +0900658func (b *bottomUpMutatorContext) SetDefaultDependencyVariation(variation *string) {
659 b.bp.SetDefaultDependencyVariation(variation)
660}
661
Colin Crossdc35e212019-06-06 16:13:11 -0700662func (b *bottomUpMutatorContext) AddVariationDependencies(variations []blueprint.Variation, tag blueprint.DependencyTag,
Colin Cross4f1dcb02020-09-16 18:45:04 -0700663 names ...string) []blueprint.Module {
Liz Kammer356f7d42021-01-26 09:18:53 -0500664 if b.bazelConversionMode {
665 _, noSelfDeps := RemoveFromList(b.ModuleName(), names)
666 if len(noSelfDeps) == 0 {
667 return []blueprint.Module(nil)
668 }
669 // In Bazel conversion mode, mutators should not have created any variants. So, when adding a
670 // dependency, the variations would not exist and the dependency could not be added, by
671 // specifying no variations, we will allow adding the dependency to succeed.
672 return b.bp.AddFarVariationDependencies(nil, tag, noSelfDeps...)
673 }
Colin Crossdc35e212019-06-06 16:13:11 -0700674
Colin Cross4f1dcb02020-09-16 18:45:04 -0700675 return b.bp.AddVariationDependencies(variations, tag, names...)
Colin Crossdc35e212019-06-06 16:13:11 -0700676}
677
678func (b *bottomUpMutatorContext) AddFarVariationDependencies(variations []blueprint.Variation,
Colin Cross4f1dcb02020-09-16 18:45:04 -0700679 tag blueprint.DependencyTag, names ...string) []blueprint.Module {
Liz Kammer356f7d42021-01-26 09:18:53 -0500680 if b.bazelConversionMode {
681 // In Bazel conversion mode, mutators should not have created any variants. So, when adding a
682 // dependency, the variations would not exist and the dependency could not be added, by
683 // specifying no variations, we will allow adding the dependency to succeed.
684 return b.bp.AddFarVariationDependencies(nil, tag, names...)
685 }
Colin Crossdc35e212019-06-06 16:13:11 -0700686
Colin Cross4f1dcb02020-09-16 18:45:04 -0700687 return b.bp.AddFarVariationDependencies(variations, tag, names...)
Colin Crossdc35e212019-06-06 16:13:11 -0700688}
689
690func (b *bottomUpMutatorContext) AddInterVariantDependency(tag blueprint.DependencyTag, from, to blueprint.Module) {
691 b.bp.AddInterVariantDependency(tag, from, to)
692}
693
694func (b *bottomUpMutatorContext) ReplaceDependencies(name string) {
695 b.bp.ReplaceDependencies(name)
696}
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800697
Paul Duffin80342d72020-06-26 22:08:43 +0100698func (b *bottomUpMutatorContext) ReplaceDependenciesIf(name string, predicate blueprint.ReplaceDependencyPredicate) {
699 b.bp.ReplaceDependenciesIf(name, predicate)
700}
701
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800702func (b *bottomUpMutatorContext) AliasVariation(variationName string) {
703 b.bp.AliasVariation(variationName)
704}
Colin Cross1b9604b2020-08-11 12:03:56 -0700705
706func (b *bottomUpMutatorContext) CreateAliasVariation(fromVariationName, toVariationName string) {
707 b.bp.CreateAliasVariation(fromVariationName, toVariationName)
708}
Colin Crossd27e7b82020-07-02 11:38:17 -0700709
710func (b *bottomUpMutatorContext) SetVariationProvider(module blueprint.Module, provider blueprint.ProviderKey, value interface{}) {
711 b.bp.SetVariationProvider(module, provider, value)
712}