blob: 15be65f9a5a474dde3be2c3dc1144b41707fc79a [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"
19
Colin Cross795c3772017-03-16 16:50:10 -070020 "github.com/google/blueprint"
Colin Cross519917d2017-11-02 16:35:56 -070021 "github.com/google/blueprint/proptools"
Colin Cross795c3772017-03-16 16:50:10 -070022)
Colin Cross6362e272015-10-29 15:25:03 -070023
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -070024// Phases:
25// run Pre-arch mutators
26// run archMutator
27// run Pre-deps mutators
28// run depsMutator
29// run PostDeps mutators
Martin Stjernholm710ec3a2020-01-16 15:12:04 +000030// run FinalDeps mutators (CreateVariations disallowed in this phase)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -070031// continue on to GenerateAndroidBuildActions
Colin Cross1e676be2016-10-12 14:38:15 -070032
Colin Cross795c3772017-03-16 16:50:10 -070033func registerMutatorsToContext(ctx *blueprint.Context, mutators []*mutator) {
34 for _, t := range mutators {
35 var handle blueprint.MutatorHandle
36 if t.bottomUpMutator != nil {
37 handle = ctx.RegisterBottomUpMutator(t.name, t.bottomUpMutator)
38 } else if t.topDownMutator != nil {
39 handle = ctx.RegisterTopDownMutator(t.name, t.topDownMutator)
40 }
41 if t.parallel {
42 handle.Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070043 }
44 }
Colin Cross1e676be2016-10-12 14:38:15 -070045}
46
Jingwen Chen73850672020-12-14 08:25:34 -050047// RegisterMutatorsForBazelConversion is a alternate registration pipeline for bp2build. Exported for testing.
Liz Kammer356f7d42021-01-26 09:18:53 -050048func RegisterMutatorsForBazelConversion(ctx *blueprint.Context, preArchMutators, depsMutators, bp2buildMutators []RegisterMutatorFunc) {
49 mctx := &registerMutatorsContext{
50 bazelConversionMode: true,
Jingwen Chen041b1842021-02-01 00:23:25 -050051 }
52
Liz Kammer356f7d42021-01-26 09:18:53 -050053 bp2buildPreArchMutators = append([]RegisterMutatorFunc{
54 RegisterNamespaceMutator,
55 RegisterDefaultsPreArchMutators,
56 // TODO(b/165114590): this is required to resolve deps that are only prebuilts, but we should
57 // evaluate the impact on conversion.
58 RegisterPrebuiltsPreArchMutators,
59 },
60 preArchMutators...)
61
62 for _, f := range bp2buildPreArchMutators {
63 f(mctx)
64 }
65
66 bp2buildDepsMutators = append([]RegisterMutatorFunc{
67 registerDepsMutatorBp2Build,
68 registerPathDepsMutator,
69 }, depsMutators...)
70
71 for _, f := range bp2buildDepsMutators {
Jingwen Chen041b1842021-02-01 00:23:25 -050072 f(mctx)
73 }
74
Jingwen Chen73850672020-12-14 08:25:34 -050075 // Register bp2build mutators
76 for _, f := range bp2buildMutators {
77 f(mctx)
78 }
79
80 registerMutatorsToContext(ctx, mctx.mutators)
Jingwen Chen4133ce62020-12-02 04:34:15 -050081}
82
Martin Stjernholm710ec3a2020-01-16 15:12:04 +000083func registerMutators(ctx *blueprint.Context, preArch, preDeps, postDeps, finalDeps []RegisterMutatorFunc) {
Colin Crosscec81712017-07-13 14:43:27 -070084 mctx := &registerMutatorsContext{}
Nan Zhangdb0b9a32017-02-27 10:12:13 -080085
86 register := func(funcs []RegisterMutatorFunc) {
87 for _, f := range funcs {
Colin Crosscec81712017-07-13 14:43:27 -070088 f(mctx)
Nan Zhangdb0b9a32017-02-27 10:12:13 -080089 }
90 }
91
Colin Crosscec81712017-07-13 14:43:27 -070092 register(preArch)
Nan Zhangdb0b9a32017-02-27 10:12:13 -080093
Colin Crosscec81712017-07-13 14:43:27 -070094 register(preDeps)
95
Liz Kammer356f7d42021-01-26 09:18:53 -050096 register([]RegisterMutatorFunc{registerDepsMutator})
Colin Crosscec81712017-07-13 14:43:27 -070097
98 register(postDeps)
99
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000100 mctx.finalPhase = true
101 register(finalDeps)
102
Colin Crosscec81712017-07-13 14:43:27 -0700103 registerMutatorsToContext(ctx, mctx.mutators)
Colin Cross795c3772017-03-16 16:50:10 -0700104}
105
106type registerMutatorsContext struct {
Liz Kammer356f7d42021-01-26 09:18:53 -0500107 mutators []*mutator
108 finalPhase bool
109 bazelConversionMode bool
Colin Cross795c3772017-03-16 16:50:10 -0700110}
Colin Cross1e676be2016-10-12 14:38:15 -0700111
112type RegisterMutatorsContext interface {
Colin Cross25de6c32019-06-06 14:29:25 -0700113 TopDown(name string, m TopDownMutator) MutatorHandle
114 BottomUp(name string, m BottomUpMutator) MutatorHandle
Colin Cross617b88a2020-08-24 18:04:09 -0700115 BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle
Colin Cross1e676be2016-10-12 14:38:15 -0700116}
117
118type RegisterMutatorFunc func(RegisterMutatorsContext)
119
Colin Crosscec81712017-07-13 14:43:27 -0700120var preArch = []RegisterMutatorFunc{
Dan Willemsen6e72ef72018-01-26 18:27:02 -0800121 RegisterNamespaceMutator,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100122
Paul Duffinaa4162e2020-05-05 11:35:43 +0100123 // Check the visibility rules are valid.
124 //
125 // This must run after the package renamer mutators so that any issues found during
126 // validation of the package's default_visibility property are reported using the
127 // correct package name and not the synthetic name.
128 //
129 // This must also be run before defaults mutators as the rules for validation are
130 // different before checking the rules than they are afterwards. e.g.
131 // visibility: ["//visibility:private", "//visibility:public"]
132 // would be invalid if specified in a module definition but is valid if it results
133 // from something like this:
134 //
135 // defaults {
136 // name: "defaults",
137 // // Be inaccessible outside a package by default.
138 // visibility: ["//visibility:private"]
139 // }
140 //
141 // defaultable_module {
142 // name: "defaultable_module",
143 // defaults: ["defaults"],
144 // // Override the default.
145 // visibility: ["//visibility:public"]
146 // }
147 //
Paul Duffin593b3c92019-12-05 14:31:48 +0000148 RegisterVisibilityRuleChecker,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100149
Bob Badour37af0462021-01-07 03:34:31 +0000150 // Record the default_applicable_licenses for each package.
151 //
152 // This must run before the defaults so that defaults modules can pick up the package default.
153 RegisterLicensesPackageMapper,
154
Paul Duffinaa4162e2020-05-05 11:35:43 +0100155 // Apply properties from defaults modules to the referencing modules.
Paul Duffinafa9fa12020-04-29 16:47:28 +0100156 //
157 // Any mutators that are added before this will not see any modules created by
158 // a DefaultableHook.
Colin Cross89536d42017-07-07 14:35:50 -0700159 RegisterDefaultsPreArchMutators,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100160
Paul Duffin44f1d842020-06-26 20:17:02 +0100161 // Add dependencies on any components so that any component references can be
162 // resolved within the deps mutator.
163 //
164 // Must be run after defaults so it can be used to create dependencies on the
165 // component modules that are creating in a DefaultableHook.
166 //
167 // Must be run before RegisterPrebuiltsPreArchMutators, i.e. before prebuilts are
168 // renamed. That is so that if a module creates components using a prebuilt module
169 // type that any dependencies (which must use prebuilt_ prefixes) are resolved to
170 // the prebuilt module and not the source module.
171 RegisterComponentsMutator,
172
Paul Duffinc988c8e2020-04-29 18:27:14 +0100173 // Create an association between prebuilt modules and their corresponding source
174 // modules (if any).
Paul Duffinafa9fa12020-04-29 16:47:28 +0100175 //
176 // Must be run after defaults mutators to ensure that any modules created by
177 // a DefaultableHook can be either a prebuilt or a source module with a matching
178 // prebuilt.
Paul Duffinc988c8e2020-04-29 18:27:14 +0100179 RegisterPrebuiltsPreArchMutators,
180
Bob Badour37af0462021-01-07 03:34:31 +0000181 // Gather the licenses properties for all modules for use during expansion and enforcement.
182 //
183 // This must come after the defaults mutators to ensure that any licenses supplied
184 // in a defaults module has been successfully applied before the rules are gathered.
185 RegisterLicensesPropertyGatherer,
186
Paul Duffinaa4162e2020-05-05 11:35:43 +0100187 // Gather the visibility rules for all modules for us during visibility enforcement.
188 //
189 // This must come after the defaults mutators to ensure that any visibility supplied
190 // in a defaults module has been successfully applied before the rules are gathered.
Paul Duffin593b3c92019-12-05 14:31:48 +0000191 RegisterVisibilityRuleGatherer,
Colin Crosscec81712017-07-13 14:43:27 -0700192}
193
Colin Crossae4c6182017-09-15 17:33:55 -0700194func registerArchMutator(ctx RegisterMutatorsContext) {
Colin Cross617b88a2020-08-24 18:04:09 -0700195 ctx.BottomUpBlueprint("os", osMutator).Parallel()
Colin Crossfb0c16e2019-11-20 17:12:35 -0800196 ctx.BottomUp("image", imageMutator).Parallel()
Colin Cross617b88a2020-08-24 18:04:09 -0700197 ctx.BottomUpBlueprint("arch", archMutator).Parallel()
Colin Crossae4c6182017-09-15 17:33:55 -0700198}
199
Colin Crosscec81712017-07-13 14:43:27 -0700200var preDeps = []RegisterMutatorFunc{
Colin Crossae4c6182017-09-15 17:33:55 -0700201 registerArchMutator,
Colin Crosscec81712017-07-13 14:43:27 -0700202}
203
204var postDeps = []RegisterMutatorFunc{
Colin Cross1b488422019-03-04 22:33:56 -0800205 registerPathDepsMutator,
Colin Cross5ea9bcc2017-07-27 15:41:32 -0700206 RegisterPrebuiltsPostDepsMutators,
Paul Duffin593b3c92019-12-05 14:31:48 +0000207 RegisterVisibilityRuleEnforcer,
Bob Badour37af0462021-01-07 03:34:31 +0000208 RegisterLicensesDependencyChecker,
Artur Satayevc5570ac2020-04-09 16:06:36 +0100209 RegisterNeverallowMutator,
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700210 RegisterOverridePostDepsMutators,
Colin Crosscec81712017-07-13 14:43:27 -0700211}
Colin Cross1e676be2016-10-12 14:38:15 -0700212
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000213var finalDeps = []RegisterMutatorFunc{}
214
Colin Cross1e676be2016-10-12 14:38:15 -0700215func PreArchMutators(f RegisterMutatorFunc) {
216 preArch = append(preArch, f)
217}
218
219func PreDepsMutators(f RegisterMutatorFunc) {
220 preDeps = append(preDeps, f)
221}
222
223func PostDepsMutators(f RegisterMutatorFunc) {
224 postDeps = append(postDeps, f)
225}
226
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000227func FinalDepsMutators(f RegisterMutatorFunc) {
228 finalDeps = append(finalDeps, f)
229}
230
Liz Kammer356f7d42021-01-26 09:18:53 -0500231var bp2buildPreArchMutators = []RegisterMutatorFunc{}
232var bp2buildDepsMutators = []RegisterMutatorFunc{}
Jingwen Chen73850672020-12-14 08:25:34 -0500233var bp2buildMutators = []RegisterMutatorFunc{}
234
235// RegisterBp2BuildMutator registers specially crafted mutators for
236// converting Blueprint/Android modules into special modules that can
237// be code-generated into Bazel BUILD targets.
238//
239// TODO(b/178068862): bring this into TestContext.
240func RegisterBp2BuildMutator(moduleType string, m func(TopDownMutatorContext)) {
Jingwen Chen73850672020-12-14 08:25:34 -0500241 f := func(ctx RegisterMutatorsContext) {
Liz Kammer356f7d42021-01-26 09:18:53 -0500242 ctx.TopDown(moduleType, m)
Jingwen Chen73850672020-12-14 08:25:34 -0500243 }
244 bp2buildMutators = append(bp2buildMutators, f)
245}
246
Liz Kammer356f7d42021-01-26 09:18:53 -0500247// PreArchBp2BuildMutators adds mutators to be register for converting Android Blueprint modules
248// into Bazel BUILD targets that should run prior to deps and conversion.
249func PreArchBp2BuildMutators(f RegisterMutatorFunc) {
250 bp2buildPreArchMutators = append(bp2buildPreArchMutators, f)
251}
252
253// DepsBp2BuildMutators adds mutators to be register for converting Android Blueprint modules into
254// Bazel BUILD targets that should run prior to conversion to resolve dependencies.
255func DepsBp2BuildMutators(f RegisterMutatorFunc) {
256 bp2buildDepsMutators = append(bp2buildDepsMutators, f)
257}
258
Colin Cross9f35c3d2020-09-16 19:04:41 -0700259type BaseMutatorContext interface {
260 BaseModuleContext
261
262 // MutatorName returns the name that this mutator was registered with.
263 MutatorName() string
264
265 // Rename all variants of a module. The new name is not visible to calls to ModuleName,
266 // AddDependency or OtherModuleName until after this mutator pass is complete.
267 Rename(name string)
268}
269
Colin Cross25de6c32019-06-06 14:29:25 -0700270type TopDownMutator func(TopDownMutatorContext)
Colin Cross6362e272015-10-29 15:25:03 -0700271
Colin Cross635c3b02016-05-18 15:37:25 -0700272type TopDownMutatorContext interface {
Colin Cross9f35c3d2020-09-16 19:04:41 -0700273 BaseMutatorContext
Colin Cross3f68a132017-10-23 17:10:29 -0700274
Colin Cross9f35c3d2020-09-16 19:04:41 -0700275 // CreateModule creates a new module by calling the factory method for the specified moduleType, and applies
276 // the specified property structs to it as if the properties were set in a blueprint file.
Colin Crosse003c4a2019-09-25 12:58:36 -0700277 CreateModule(ModuleFactory, ...interface{}) Module
Colin Cross6362e272015-10-29 15:25:03 -0700278}
279
Colin Cross25de6c32019-06-06 14:29:25 -0700280type topDownMutatorContext struct {
Colin Crossdc35e212019-06-06 16:13:11 -0700281 bp blueprint.TopDownMutatorContext
Colin Cross0ea8ba82019-06-06 14:33:29 -0700282 baseModuleContext
Colin Cross6362e272015-10-29 15:25:03 -0700283}
284
Colin Cross25de6c32019-06-06 14:29:25 -0700285type BottomUpMutator func(BottomUpMutatorContext)
Colin Cross6362e272015-10-29 15:25:03 -0700286
Colin Cross635c3b02016-05-18 15:37:25 -0700287type BottomUpMutatorContext interface {
Colin Cross9f35c3d2020-09-16 19:04:41 -0700288 BaseMutatorContext
Colin Crossaabf6792017-11-29 00:27:14 -0800289
Colin Cross4f1dcb02020-09-16 18:45:04 -0700290 // AddDependency adds a dependency to the given module. It returns a slice of modules for each
291 // dependency (some entries may be nil).
292 //
293 // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the
294 // new dependencies have had the current mutator called on them. If the mutator is not
295 // parallel this method does not affect the ordering of the current mutator pass, but will
296 // be ordered correctly for all future mutator passes.
297 AddDependency(module blueprint.Module, tag blueprint.DependencyTag, name ...string) []blueprint.Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700298
299 // AddReverseDependency adds a dependency from the destination to the given module.
300 // Does not affect the ordering of the current mutator pass, but will be ordered
301 // correctly for all future mutator passes. All reverse dependencies for a destination module are
302 // collected until the end of the mutator pass, sorted by name, and then appended to the destination
303 // module's dependency list.
Colin Crossaabf6792017-11-29 00:27:14 -0800304 AddReverseDependency(module blueprint.Module, tag blueprint.DependencyTag, name string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700305
306 // CreateVariations splits a module into multiple variants, one for each name in the variationNames
307 // parameter. It returns a list of new modules in the same order as the variationNames
308 // list.
309 //
310 // If any of the dependencies of the module being operated on were already split
311 // by calling CreateVariations with the same name, the dependency will automatically
312 // be updated to point the matching variant.
313 //
314 // If a module is split, and then a module depending on the first module is not split
315 // when the Mutator is later called on it, the dependency of the depending module will
316 // automatically be updated to point to the first variant.
Colin Cross43b92e02019-11-18 15:28:57 -0800317 CreateVariations(...string) []Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700318
319 // CreateLocationVariations splits a module into multiple variants, one for each name in the variantNames
320 // parameter. It returns a list of new modules in the same order as the variantNames
321 // list.
322 //
323 // Local variations do not affect automatic dependency resolution - dependencies added
324 // to the split module via deps or DynamicDependerModule must exactly match a variant
325 // that contains all the non-local variations.
Colin Cross43b92e02019-11-18 15:28:57 -0800326 CreateLocalVariations(...string) []Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700327
328 // SetDependencyVariation sets all dangling dependencies on the current module to point to the variation
329 // with given name. This function ignores the default variation set by SetDefaultDependencyVariation.
Colin Crossaabf6792017-11-29 00:27:14 -0800330 SetDependencyVariation(string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700331
332 // SetDefaultDependencyVariation sets the default variation when a dangling reference is detected
333 // during the subsequent calls on Create*Variations* functions. To reset, set it to nil.
Jiyong Park1d1119f2019-07-29 21:27:18 +0900334 SetDefaultDependencyVariation(*string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700335
336 // AddVariationDependencies adds deps as dependencies of the current module, but uses the variations
Colin Cross4f1dcb02020-09-16 18:45:04 -0700337 // argument to select which variant of the dependency to use. It returns a slice of modules for
338 // each dependency (some entries may be nil). A variant of the dependency must exist that matches
339 // the all of the non-local variations of the current module, plus the variations argument.
340 //
341 // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the
342 // new dependencies have had the current mutator called on them. If the mutator is not
343 // parallel this method does not affect the ordering of the current mutator pass, but will
344 // be ordered correctly for all future mutator passes.
345 AddVariationDependencies([]blueprint.Variation, blueprint.DependencyTag, ...string) []blueprint.Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700346
347 // AddFarVariationDependencies adds deps as dependencies of the current module, but uses the
Colin Cross4f1dcb02020-09-16 18:45:04 -0700348 // variations argument to select which variant of the dependency to use. It returns a slice of
349 // modules for each dependency (some entries may be nil). A variant of the dependency must
350 // exist that matches the variations argument, but may also have other variations.
Colin Cross9f35c3d2020-09-16 19:04:41 -0700351 // For any unspecified variation the first variant will be used.
352 //
353 // Unlike AddVariationDependencies, the variations of the current module are ignored - the
354 // dependency only needs to match the supplied variations.
Colin Cross4f1dcb02020-09-16 18:45:04 -0700355 //
356 // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the
357 // new dependencies have had the current mutator called on them. If the mutator is not
358 // parallel this method does not affect the ordering of the current mutator pass, but will
359 // be ordered correctly for all future mutator passes.
360 AddFarVariationDependencies([]blueprint.Variation, blueprint.DependencyTag, ...string) []blueprint.Module
Colin Cross9f35c3d2020-09-16 19:04:41 -0700361
362 // AddInterVariantDependency adds a dependency between two variants of the same module. Variants are always
363 // ordered in the same orderas they were listed in CreateVariations, and AddInterVariantDependency does not change
364 // that ordering, but it associates a DependencyTag with the dependency and makes it visible to VisitDirectDeps,
365 // WalkDeps, etc.
Colin Crossaabf6792017-11-29 00:27:14 -0800366 AddInterVariantDependency(tag blueprint.DependencyTag, from, to blueprint.Module)
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. Replacements don't take effect until
370 // after the mutator pass is finished.
Colin Crossaabf6792017-11-29 00:27:14 -0800371 ReplaceDependencies(string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700372
373 // ReplaceDependencies replaces all dependencies on the identical variant of the module with the
374 // specified name with the current variant of this module as long as the supplied predicate returns
375 // true.
376 //
377 // Replacements don't take effect until after the mutator pass is finished.
Paul Duffin80342d72020-06-26 22:08:43 +0100378 ReplaceDependenciesIf(string, blueprint.ReplaceDependencyPredicate)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700379
380 // AliasVariation takes a variationName that was passed to CreateVariations for this module,
381 // and creates an alias from the current variant (before the mutator has run) to the new
382 // variant. The alias will be valid until the next time a mutator calls CreateVariations or
383 // CreateLocalVariations on this module without also calling AliasVariation. The alias can
384 // be used to add dependencies on the newly created variant using the variant map from
385 // before CreateVariations was run.
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800386 AliasVariation(variationName string)
Colin Cross9f35c3d2020-09-16 19:04:41 -0700387
388 // CreateAliasVariation takes a toVariationName that was passed to CreateVariations for this
389 // module, and creates an alias from a new fromVariationName variant the toVariationName
390 // variant. The alias will be valid until the next time a mutator calls CreateVariations or
391 // CreateLocalVariations on this module without also calling AliasVariation. The alias can
392 // be used to add dependencies on the toVariationName variant using the fromVariationName
393 // variant.
Colin Cross1b9604b2020-08-11 12:03:56 -0700394 CreateAliasVariation(fromVariationName, toVariationName string)
Colin Crossd27e7b82020-07-02 11:38:17 -0700395
396 // SetVariationProvider sets the value for a provider for the given newly created variant of
397 // the current module, i.e. one of the Modules returned by CreateVariations.. It panics if
398 // not called during the appropriate mutator or GenerateBuildActions pass for the provider,
399 // if the value is not of the appropriate type, or if the module is not a newly created
400 // variant of the current module. The value should not be modified after being passed to
401 // SetVariationProvider.
402 SetVariationProvider(module blueprint.Module, provider blueprint.ProviderKey, value interface{})
Liz Kammer356f7d42021-01-26 09:18:53 -0500403
404 // BazelConversionMode returns whether this mutator is being run as part of Bazel Conversion.
405 BazelConversionMode() bool
Colin Cross6362e272015-10-29 15:25:03 -0700406}
407
Colin Cross25de6c32019-06-06 14:29:25 -0700408type bottomUpMutatorContext struct {
Colin Crossdc35e212019-06-06 16:13:11 -0700409 bp blueprint.BottomUpMutatorContext
Colin Cross0ea8ba82019-06-06 14:33:29 -0700410 baseModuleContext
Liz Kammer356f7d42021-01-26 09:18:53 -0500411 finalPhase bool
412 bazelConversionMode bool
Colin Cross6362e272015-10-29 15:25:03 -0700413}
414
Colin Cross617b88a2020-08-24 18:04:09 -0700415func bottomUpMutatorContextFactory(ctx blueprint.BottomUpMutatorContext, a Module,
Liz Kammer356f7d42021-01-26 09:18:53 -0500416 finalPhase, bazelConversionMode bool) BottomUpMutatorContext {
Colin Cross617b88a2020-08-24 18:04:09 -0700417
418 return &bottomUpMutatorContext{
Liz Kammer356f7d42021-01-26 09:18:53 -0500419 bp: ctx,
420 baseModuleContext: a.base().baseModuleContextFactory(ctx),
421 finalPhase: finalPhase,
422 bazelConversionMode: bazelConversionMode,
Colin Cross617b88a2020-08-24 18:04:09 -0700423 }
424}
425
Colin Cross25de6c32019-06-06 14:29:25 -0700426func (x *registerMutatorsContext) BottomUp(name string, m BottomUpMutator) MutatorHandle {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000427 finalPhase := x.finalPhase
Liz Kammer356f7d42021-01-26 09:18:53 -0500428 bazelConversionMode := x.bazelConversionMode
Colin Cross798bfce2016-10-12 14:28:16 -0700429 f := func(ctx blueprint.BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700430 if a, ok := ctx.Module().(Module); ok {
Liz Kammer356f7d42021-01-26 09:18:53 -0500431 m(bottomUpMutatorContextFactory(ctx, a, finalPhase, bazelConversionMode))
Colin Cross6362e272015-10-29 15:25:03 -0700432 }
Colin Cross798bfce2016-10-12 14:28:16 -0700433 }
Liz Kammer356f7d42021-01-26 09:18:53 -0500434 mutator := &mutator{name: x.mutatorName(name), bottomUpMutator: f}
Colin Cross795c3772017-03-16 16:50:10 -0700435 x.mutators = append(x.mutators, mutator)
Colin Cross798bfce2016-10-12 14:28:16 -0700436 return mutator
Colin Cross6362e272015-10-29 15:25:03 -0700437}
438
Colin Cross617b88a2020-08-24 18:04:09 -0700439func (x *registerMutatorsContext) BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle {
440 mutator := &mutator{name: name, bottomUpMutator: m}
441 x.mutators = append(x.mutators, mutator)
442 return mutator
443}
444
Liz Kammer356f7d42021-01-26 09:18:53 -0500445func (x *registerMutatorsContext) mutatorName(name string) string {
446 if x.bazelConversionMode {
447 return name + "_bp2build"
448 }
449 return name
450}
451
Colin Cross25de6c32019-06-06 14:29:25 -0700452func (x *registerMutatorsContext) TopDown(name string, m TopDownMutator) MutatorHandle {
Colin Cross798bfce2016-10-12 14:28:16 -0700453 f := func(ctx blueprint.TopDownMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700454 if a, ok := ctx.Module().(Module); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700455 actx := &topDownMutatorContext{
Colin Crossdc35e212019-06-06 16:13:11 -0700456 bp: ctx,
457 baseModuleContext: a.base().baseModuleContextFactory(ctx),
Colin Cross6362e272015-10-29 15:25:03 -0700458 }
Colin Cross798bfce2016-10-12 14:28:16 -0700459 m(actx)
Colin Cross6362e272015-10-29 15:25:03 -0700460 }
Colin Cross798bfce2016-10-12 14:28:16 -0700461 }
Liz Kammer356f7d42021-01-26 09:18:53 -0500462 mutator := &mutator{name: x.mutatorName(name), topDownMutator: f}
Colin Cross795c3772017-03-16 16:50:10 -0700463 x.mutators = append(x.mutators, mutator)
Colin Cross798bfce2016-10-12 14:28:16 -0700464 return mutator
465}
466
467type MutatorHandle interface {
468 Parallel() MutatorHandle
469}
470
471func (mutator *mutator) Parallel() MutatorHandle {
472 mutator.parallel = true
473 return mutator
Colin Cross6362e272015-10-29 15:25:03 -0700474}
Colin Cross1e676be2016-10-12 14:38:15 -0700475
Paul Duffin44f1d842020-06-26 20:17:02 +0100476func RegisterComponentsMutator(ctx RegisterMutatorsContext) {
477 ctx.BottomUp("component-deps", componentDepsMutator).Parallel()
478}
479
480// A special mutator that runs just prior to the deps mutator to allow the dependencies
481// on component modules to be added so that they can depend directly on a prebuilt
482// module.
483func componentDepsMutator(ctx BottomUpMutatorContext) {
484 if m := ctx.Module(); m.Enabled() {
485 m.ComponentDepsMutator(ctx)
486 }
487}
488
Colin Cross1e676be2016-10-12 14:38:15 -0700489func depsMutator(ctx BottomUpMutatorContext) {
Paul Duffin44f1d842020-06-26 20:17:02 +0100490 if m := ctx.Module(); m.Enabled() {
Colin Cross1e676be2016-10-12 14:38:15 -0700491 m.DepsMutator(ctx)
492 }
493}
Colin Crossd11fcda2017-10-23 17:59:01 -0700494
Liz Kammer356f7d42021-01-26 09:18:53 -0500495func registerDepsMutator(ctx RegisterMutatorsContext) {
496 ctx.BottomUp("deps", depsMutator).Parallel()
497}
498
499func registerDepsMutatorBp2Build(ctx RegisterMutatorsContext) {
500 // TODO(b/179313531): Consider a separate mutator that only runs depsMutator for modules that are
501 // being converted to build targets.
502 ctx.BottomUp("deps", depsMutator).Parallel()
503}
504
Colin Cross25de6c32019-06-06 14:29:25 -0700505func (t *topDownMutatorContext) AppendProperties(props ...interface{}) {
Colin Cross519917d2017-11-02 16:35:56 -0700506 for _, p := range props {
Colin Cross25de6c32019-06-06 14:29:25 -0700507 err := proptools.AppendMatchingProperties(t.Module().base().customizableProperties,
Colin Cross519917d2017-11-02 16:35:56 -0700508 p, nil)
509 if err != nil {
510 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700511 t.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
Colin Cross519917d2017-11-02 16:35:56 -0700512 } else {
513 panic(err)
514 }
515 }
516 }
517}
518
Colin Cross25de6c32019-06-06 14:29:25 -0700519func (t *topDownMutatorContext) PrependProperties(props ...interface{}) {
Colin Cross519917d2017-11-02 16:35:56 -0700520 for _, p := range props {
Colin Cross25de6c32019-06-06 14:29:25 -0700521 err := proptools.PrependMatchingProperties(t.Module().base().customizableProperties,
Colin Cross519917d2017-11-02 16:35:56 -0700522 p, nil)
523 if err != nil {
524 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700525 t.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
Colin Cross519917d2017-11-02 16:35:56 -0700526 } else {
527 panic(err)
528 }
529 }
530 }
531}
Colin Crossdc35e212019-06-06 16:13:11 -0700532
533// android.topDownMutatorContext either has to embed blueprint.TopDownMutatorContext, in which case every method that
534// has an overridden version in android.BaseModuleContext has to be manually forwarded to BaseModuleContext to avoid
535// ambiguous method errors, or it has to store a blueprint.TopDownMutatorContext non-embedded, in which case every
536// non-overridden method has to be forwarded. There are fewer non-overridden methods, so use the latter. The following
537// methods forward to the identical blueprint versions for topDownMutatorContext and bottomUpMutatorContext.
538
Colin Crosscb55e082019-07-01 15:32:31 -0700539func (t *topDownMutatorContext) MutatorName() string {
540 return t.bp.MutatorName()
541}
542
Colin Crossdc35e212019-06-06 16:13:11 -0700543func (t *topDownMutatorContext) Rename(name string) {
544 t.bp.Rename(name)
Colin Cross9a362232019-07-01 15:32:45 -0700545 t.Module().base().commonProperties.DebugName = name
Colin Crossdc35e212019-06-06 16:13:11 -0700546}
547
Colin Crosse003c4a2019-09-25 12:58:36 -0700548func (t *topDownMutatorContext) CreateModule(factory ModuleFactory, props ...interface{}) Module {
Colin Cross18c46802019-09-24 22:19:02 -0700549 inherited := []interface{}{&t.Module().base().commonProperties}
Colin Crosse003c4a2019-09-25 12:58:36 -0700550 module := t.bp.CreateModule(ModuleFactoryAdaptor(factory), append(inherited, props...)...).(Module)
Colin Cross18c46802019-09-24 22:19:02 -0700551
552 if t.Module().base().variableProperties != nil && module.base().variableProperties != nil {
553 src := t.Module().base().variableProperties
554 dst := []interface{}{
555 module.base().variableProperties,
556 // Put an empty copy of the src properties into dst so that properties in src that are not in dst
557 // don't cause a "failed to find property to extend" error.
Colin Cross43e789d2020-01-28 09:46:50 -0800558 proptools.CloneEmptyProperties(reflect.ValueOf(src)).Interface(),
Colin Cross18c46802019-09-24 22:19:02 -0700559 }
560 err := proptools.AppendMatchingProperties(dst, src, nil)
561 if err != nil {
562 panic(err)
563 }
564 }
565
Colin Crosse003c4a2019-09-25 12:58:36 -0700566 return module
Colin Crossdc35e212019-06-06 16:13:11 -0700567}
568
Colin Crosscb55e082019-07-01 15:32:31 -0700569func (b *bottomUpMutatorContext) MutatorName() string {
570 return b.bp.MutatorName()
571}
572
Colin Crossdc35e212019-06-06 16:13:11 -0700573func (b *bottomUpMutatorContext) Rename(name string) {
574 b.bp.Rename(name)
Colin Cross9a362232019-07-01 15:32:45 -0700575 b.Module().base().commonProperties.DebugName = name
Colin Crossdc35e212019-06-06 16:13:11 -0700576}
577
Colin Cross4f1dcb02020-09-16 18:45:04 -0700578func (b *bottomUpMutatorContext) AddDependency(module blueprint.Module, tag blueprint.DependencyTag, name ...string) []blueprint.Module {
579 return b.bp.AddDependency(module, tag, name...)
Colin Crossdc35e212019-06-06 16:13:11 -0700580}
581
582func (b *bottomUpMutatorContext) AddReverseDependency(module blueprint.Module, tag blueprint.DependencyTag, name string) {
583 b.bp.AddReverseDependency(module, tag, name)
584}
585
Colin Cross43b92e02019-11-18 15:28:57 -0800586func (b *bottomUpMutatorContext) CreateVariations(variations ...string) []Module {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000587 if b.finalPhase {
588 panic("CreateVariations not allowed in FinalDepsMutators")
589 }
590
Colin Cross9a362232019-07-01 15:32:45 -0700591 modules := b.bp.CreateVariations(variations...)
592
Colin Cross43b92e02019-11-18 15:28:57 -0800593 aModules := make([]Module, len(modules))
Colin Cross9a362232019-07-01 15:32:45 -0700594 for i := range variations {
Colin Cross43b92e02019-11-18 15:28:57 -0800595 aModules[i] = modules[i].(Module)
596 base := aModules[i].base()
Colin Cross9a362232019-07-01 15:32:45 -0700597 base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName())
598 base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i])
599 }
600
Colin Cross43b92e02019-11-18 15:28:57 -0800601 return aModules
Colin Crossdc35e212019-06-06 16:13:11 -0700602}
603
Colin Cross43b92e02019-11-18 15:28:57 -0800604func (b *bottomUpMutatorContext) CreateLocalVariations(variations ...string) []Module {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000605 if b.finalPhase {
606 panic("CreateLocalVariations not allowed in FinalDepsMutators")
607 }
608
Colin Cross9a362232019-07-01 15:32:45 -0700609 modules := b.bp.CreateLocalVariations(variations...)
610
Colin Cross43b92e02019-11-18 15:28:57 -0800611 aModules := make([]Module, len(modules))
Colin Cross9a362232019-07-01 15:32:45 -0700612 for i := range variations {
Colin Cross43b92e02019-11-18 15:28:57 -0800613 aModules[i] = modules[i].(Module)
614 base := aModules[i].base()
Colin Cross9a362232019-07-01 15:32:45 -0700615 base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName())
616 base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i])
617 }
618
Colin Cross43b92e02019-11-18 15:28:57 -0800619 return aModules
Colin Crossdc35e212019-06-06 16:13:11 -0700620}
621
622func (b *bottomUpMutatorContext) SetDependencyVariation(variation string) {
623 b.bp.SetDependencyVariation(variation)
624}
625
Jiyong Park1d1119f2019-07-29 21:27:18 +0900626func (b *bottomUpMutatorContext) SetDefaultDependencyVariation(variation *string) {
627 b.bp.SetDefaultDependencyVariation(variation)
628}
629
Colin Crossdc35e212019-06-06 16:13:11 -0700630func (b *bottomUpMutatorContext) AddVariationDependencies(variations []blueprint.Variation, tag blueprint.DependencyTag,
Colin Cross4f1dcb02020-09-16 18:45:04 -0700631 names ...string) []blueprint.Module {
Liz Kammer356f7d42021-01-26 09:18:53 -0500632 if b.bazelConversionMode {
633 _, noSelfDeps := RemoveFromList(b.ModuleName(), names)
634 if len(noSelfDeps) == 0 {
635 return []blueprint.Module(nil)
636 }
637 // In Bazel conversion mode, mutators should not have created any variants. So, when adding a
638 // dependency, the variations would not exist and the dependency could not be added, by
639 // specifying no variations, we will allow adding the dependency to succeed.
640 return b.bp.AddFarVariationDependencies(nil, tag, noSelfDeps...)
641 }
Colin Crossdc35e212019-06-06 16:13:11 -0700642
Colin Cross4f1dcb02020-09-16 18:45:04 -0700643 return b.bp.AddVariationDependencies(variations, tag, names...)
Colin Crossdc35e212019-06-06 16:13:11 -0700644}
645
646func (b *bottomUpMutatorContext) AddFarVariationDependencies(variations []blueprint.Variation,
Colin Cross4f1dcb02020-09-16 18:45:04 -0700647 tag blueprint.DependencyTag, names ...string) []blueprint.Module {
Liz Kammer356f7d42021-01-26 09:18:53 -0500648 if b.bazelConversionMode {
649 // In Bazel conversion mode, mutators should not have created any variants. So, when adding a
650 // dependency, the variations would not exist and the dependency could not be added, by
651 // specifying no variations, we will allow adding the dependency to succeed.
652 return b.bp.AddFarVariationDependencies(nil, tag, names...)
653 }
Colin Crossdc35e212019-06-06 16:13:11 -0700654
Colin Cross4f1dcb02020-09-16 18:45:04 -0700655 return b.bp.AddFarVariationDependencies(variations, tag, names...)
Colin Crossdc35e212019-06-06 16:13:11 -0700656}
657
658func (b *bottomUpMutatorContext) AddInterVariantDependency(tag blueprint.DependencyTag, from, to blueprint.Module) {
659 b.bp.AddInterVariantDependency(tag, from, to)
660}
661
662func (b *bottomUpMutatorContext) ReplaceDependencies(name string) {
663 b.bp.ReplaceDependencies(name)
664}
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800665
Paul Duffin80342d72020-06-26 22:08:43 +0100666func (b *bottomUpMutatorContext) ReplaceDependenciesIf(name string, predicate blueprint.ReplaceDependencyPredicate) {
667 b.bp.ReplaceDependenciesIf(name, predicate)
668}
669
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800670func (b *bottomUpMutatorContext) AliasVariation(variationName string) {
671 b.bp.AliasVariation(variationName)
672}
Colin Cross1b9604b2020-08-11 12:03:56 -0700673
674func (b *bottomUpMutatorContext) CreateAliasVariation(fromVariationName, toVariationName string) {
675 b.bp.CreateAliasVariation(fromVariationName, toVariationName)
676}
Colin Crossd27e7b82020-07-02 11:38:17 -0700677
678func (b *bottomUpMutatorContext) SetVariationProvider(module blueprint.Module, provider blueprint.ProviderKey, value interface{}) {
679 b.bp.SetVariationProvider(module, provider, value)
680}
Liz Kammer356f7d42021-01-26 09:18:53 -0500681
682func (b *bottomUpMutatorContext) BazelConversionMode() bool {
683 return b.bazelConversionMode
684}