blob: 8bfb24ed34e2286045a173af3a70f3c3745e0733 [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 (
Jingwen Chen1fd14692021-02-05 03:01:50 -050018 "android/soong/bazel"
Jingwen Chenfb4692a2021-02-07 10:05:16 -050019 "fmt"
Colin Cross18c46802019-09-24 22:19:02 -070020 "reflect"
Jingwen Chenfb4692a2021-02-07 10:05:16 -050021 "strings"
Colin Cross18c46802019-09-24 22:19:02 -070022
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.
Paul Duffin1d2d42f2021-03-06 20:08:12 +000037func RegisterMutatorsForBazelConversion(ctx *Context, preArchMutators, depsMutators, 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
55 bp2buildDepsMutators = append([]RegisterMutatorFunc{
56 registerDepsMutatorBp2Build,
57 registerPathDepsMutator,
58 }, depsMutators...)
59
60 for _, f := range bp2buildDepsMutators {
Jingwen Chen041b1842021-02-01 00:23:25 -050061 f(mctx)
62 }
63
Jingwen Chen73850672020-12-14 08:25:34 -050064 // Register bp2build mutators
65 for _, f := range bp2buildMutators {
66 f(mctx)
67 }
68
Paul Duffin1d2d42f2021-03-06 20:08:12 +000069 mctx.mutators.registerAll(ctx)
Jingwen Chen4133ce62020-12-02 04:34:15 -050070}
71
Paul Duffin1d2d42f2021-03-06 20:08:12 +000072func registerMutators(ctx *Context, preArch, preDeps, postDeps, finalDeps []RegisterMutatorFunc) {
Colin Crosscec81712017-07-13 14:43:27 -070073 mctx := &registerMutatorsContext{}
Nan Zhangdb0b9a32017-02-27 10:12:13 -080074
75 register := func(funcs []RegisterMutatorFunc) {
76 for _, f := range funcs {
Colin Crosscec81712017-07-13 14:43:27 -070077 f(mctx)
Nan Zhangdb0b9a32017-02-27 10:12:13 -080078 }
79 }
80
Colin Crosscec81712017-07-13 14:43:27 -070081 register(preArch)
Nan Zhangdb0b9a32017-02-27 10:12:13 -080082
Colin Crosscec81712017-07-13 14:43:27 -070083 register(preDeps)
84
Liz Kammer356f7d42021-01-26 09:18:53 -050085 register([]RegisterMutatorFunc{registerDepsMutator})
Colin Crosscec81712017-07-13 14:43:27 -070086
87 register(postDeps)
88
Martin Stjernholm710ec3a2020-01-16 15:12:04 +000089 mctx.finalPhase = true
90 register(finalDeps)
91
Paul Duffin1d2d42f2021-03-06 20:08:12 +000092 mctx.mutators.registerAll(ctx)
Colin Cross795c3772017-03-16 16:50:10 -070093}
94
95type registerMutatorsContext struct {
Paul Duffin1d2d42f2021-03-06 20:08:12 +000096 mutators sortableComponents
Liz Kammer356f7d42021-01-26 09:18:53 -050097 finalPhase bool
98 bazelConversionMode bool
Colin Cross795c3772017-03-16 16:50:10 -070099}
Colin Cross1e676be2016-10-12 14:38:15 -0700100
101type RegisterMutatorsContext interface {
Colin Cross25de6c32019-06-06 14:29:25 -0700102 TopDown(name string, m TopDownMutator) MutatorHandle
103 BottomUp(name string, m BottomUpMutator) MutatorHandle
Colin Cross617b88a2020-08-24 18:04:09 -0700104 BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle
Colin Cross1e676be2016-10-12 14:38:15 -0700105}
106
107type RegisterMutatorFunc func(RegisterMutatorsContext)
108
Colin Crosscec81712017-07-13 14:43:27 -0700109var preArch = []RegisterMutatorFunc{
Dan Willemsen6e72ef72018-01-26 18:27:02 -0800110 RegisterNamespaceMutator,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100111
Paul Duffinaa4162e2020-05-05 11:35:43 +0100112 // Check the visibility rules are valid.
113 //
114 // This must run after the package renamer mutators so that any issues found during
115 // validation of the package's default_visibility property are reported using the
116 // correct package name and not the synthetic name.
117 //
118 // This must also be run before defaults mutators as the rules for validation are
119 // different before checking the rules than they are afterwards. e.g.
120 // visibility: ["//visibility:private", "//visibility:public"]
121 // would be invalid if specified in a module definition but is valid if it results
122 // from something like this:
123 //
124 // defaults {
125 // name: "defaults",
126 // // Be inaccessible outside a package by default.
127 // visibility: ["//visibility:private"]
128 // }
129 //
130 // defaultable_module {
131 // name: "defaultable_module",
132 // defaults: ["defaults"],
133 // // Override the default.
134 // visibility: ["//visibility:public"]
135 // }
136 //
Paul Duffin593b3c92019-12-05 14:31:48 +0000137 RegisterVisibilityRuleChecker,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100138
Bob Badour37af0462021-01-07 03:34:31 +0000139 // Record the default_applicable_licenses for each package.
140 //
141 // This must run before the defaults so that defaults modules can pick up the package default.
142 RegisterLicensesPackageMapper,
143
Paul Duffinaa4162e2020-05-05 11:35:43 +0100144 // Apply properties from defaults modules to the referencing modules.
Paul Duffinafa9fa12020-04-29 16:47:28 +0100145 //
146 // Any mutators that are added before this will not see any modules created by
147 // a DefaultableHook.
Colin Cross89536d42017-07-07 14:35:50 -0700148 RegisterDefaultsPreArchMutators,
Paul Duffinaa4162e2020-05-05 11:35:43 +0100149
Paul Duffin44f1d842020-06-26 20:17:02 +0100150 // Add dependencies on any components so that any component references can be
151 // resolved within the deps mutator.
152 //
153 // Must be run after defaults so it can be used to create dependencies on the
154 // component modules that are creating in a DefaultableHook.
155 //
156 // Must be run before RegisterPrebuiltsPreArchMutators, i.e. before prebuilts are
157 // renamed. That is so that if a module creates components using a prebuilt module
158 // type that any dependencies (which must use prebuilt_ prefixes) are resolved to
159 // the prebuilt module and not the source module.
160 RegisterComponentsMutator,
161
Paul Duffinc988c8e2020-04-29 18:27:14 +0100162 // Create an association between prebuilt modules and their corresponding source
163 // modules (if any).
Paul Duffinafa9fa12020-04-29 16:47:28 +0100164 //
165 // Must be run after defaults mutators to ensure that any modules created by
166 // a DefaultableHook can be either a prebuilt or a source module with a matching
167 // prebuilt.
Paul Duffinc988c8e2020-04-29 18:27:14 +0100168 RegisterPrebuiltsPreArchMutators,
169
Bob Badour37af0462021-01-07 03:34:31 +0000170 // Gather the licenses properties for all modules for use during expansion and enforcement.
171 //
172 // This must come after the defaults mutators to ensure that any licenses supplied
173 // in a defaults module has been successfully applied before the rules are gathered.
174 RegisterLicensesPropertyGatherer,
175
Paul Duffinaa4162e2020-05-05 11:35:43 +0100176 // Gather the visibility rules for all modules for us during visibility enforcement.
177 //
178 // This must come after the defaults mutators to ensure that any visibility supplied
179 // in a defaults module has been successfully applied before the rules are gathered.
Paul Duffin593b3c92019-12-05 14:31:48 +0000180 RegisterVisibilityRuleGatherer,
Colin Crosscec81712017-07-13 14:43:27 -0700181}
182
Colin Crossae4c6182017-09-15 17:33:55 -0700183func registerArchMutator(ctx RegisterMutatorsContext) {
Colin Cross617b88a2020-08-24 18:04:09 -0700184 ctx.BottomUpBlueprint("os", osMutator).Parallel()
Colin Crossfb0c16e2019-11-20 17:12:35 -0800185 ctx.BottomUp("image", imageMutator).Parallel()
Colin Cross617b88a2020-08-24 18:04:09 -0700186 ctx.BottomUpBlueprint("arch", archMutator).Parallel()
Colin Crossae4c6182017-09-15 17:33:55 -0700187}
188
Colin Crosscec81712017-07-13 14:43:27 -0700189var preDeps = []RegisterMutatorFunc{
Colin Crossae4c6182017-09-15 17:33:55 -0700190 registerArchMutator,
Colin Crosscec81712017-07-13 14:43:27 -0700191}
192
193var postDeps = []RegisterMutatorFunc{
Colin Cross1b488422019-03-04 22:33:56 -0800194 registerPathDepsMutator,
Colin Cross5ea9bcc2017-07-27 15:41:32 -0700195 RegisterPrebuiltsPostDepsMutators,
Paul Duffin593b3c92019-12-05 14:31:48 +0000196 RegisterVisibilityRuleEnforcer,
Bob Badour37af0462021-01-07 03:34:31 +0000197 RegisterLicensesDependencyChecker,
Artur Satayevc5570ac2020-04-09 16:06:36 +0100198 RegisterNeverallowMutator,
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700199 RegisterOverridePostDepsMutators,
Colin Crosscec81712017-07-13 14:43:27 -0700200}
Colin Cross1e676be2016-10-12 14:38:15 -0700201
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000202var finalDeps = []RegisterMutatorFunc{}
203
Colin Cross1e676be2016-10-12 14:38:15 -0700204func PreArchMutators(f RegisterMutatorFunc) {
205 preArch = append(preArch, f)
206}
207
208func PreDepsMutators(f RegisterMutatorFunc) {
209 preDeps = append(preDeps, f)
210}
211
212func PostDepsMutators(f RegisterMutatorFunc) {
213 postDeps = append(postDeps, f)
214}
215
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000216func FinalDepsMutators(f RegisterMutatorFunc) {
217 finalDeps = append(finalDeps, f)
218}
219
Liz Kammer356f7d42021-01-26 09:18:53 -0500220var bp2buildPreArchMutators = []RegisterMutatorFunc{}
221var bp2buildDepsMutators = []RegisterMutatorFunc{}
Jingwen Chen73850672020-12-14 08:25:34 -0500222var bp2buildMutators = []RegisterMutatorFunc{}
223
224// 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 }
233 bp2buildMutators = append(bp2buildMutators, f)
234}
235
Liz Kammer356f7d42021-01-26 09:18:53 -0500236// PreArchBp2BuildMutators adds mutators to be register for converting Android Blueprint modules
237// into Bazel BUILD targets that should run prior to deps and conversion.
238func PreArchBp2BuildMutators(f RegisterMutatorFunc) {
239 bp2buildPreArchMutators = append(bp2buildPreArchMutators, f)
240}
241
242// DepsBp2BuildMutators adds mutators to be register for converting Android Blueprint modules into
243// Bazel BUILD targets that should run prior to conversion to resolve dependencies.
244func DepsBp2BuildMutators(f RegisterMutatorFunc) {
245 bp2buildDepsMutators = append(bp2buildDepsMutators, f)
246}
247
Colin Cross9f35c3d2020-09-16 19:04:41 -0700248type BaseMutatorContext interface {
249 BaseModuleContext
250
251 // MutatorName returns the name that this mutator was registered with.
252 MutatorName() string
253
254 // Rename all variants of a module. The new name is not visible to calls to ModuleName,
255 // AddDependency or OtherModuleName until after this mutator pass is complete.
256 Rename(name string)
257}
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.
Liz Kammerfc46bc12021-02-19 11:06:17 -0500272 CreateBazelTargetModule(ModuleFactory, string, bazel.BazelTargetModuleProperties, interface{}) BazelTargetModule
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{})
Liz Kammer356f7d42021-01-26 09:18:53 -0500398
399 // BazelConversionMode returns whether this mutator is being run as part of Bazel Conversion.
400 BazelConversionMode() bool
Colin Cross6362e272015-10-29 15:25:03 -0700401}
402
Colin Cross25de6c32019-06-06 14:29:25 -0700403type bottomUpMutatorContext struct {
Colin Crossdc35e212019-06-06 16:13:11 -0700404 bp blueprint.BottomUpMutatorContext
Colin Cross0ea8ba82019-06-06 14:33:29 -0700405 baseModuleContext
Liz Kammer356f7d42021-01-26 09:18:53 -0500406 finalPhase bool
407 bazelConversionMode bool
Colin Cross6362e272015-10-29 15:25:03 -0700408}
409
Colin Cross617b88a2020-08-24 18:04:09 -0700410func bottomUpMutatorContextFactory(ctx blueprint.BottomUpMutatorContext, a Module,
Liz Kammer356f7d42021-01-26 09:18:53 -0500411 finalPhase, bazelConversionMode bool) BottomUpMutatorContext {
Colin Cross617b88a2020-08-24 18:04:09 -0700412
413 return &bottomUpMutatorContext{
Liz Kammer356f7d42021-01-26 09:18:53 -0500414 bp: ctx,
415 baseModuleContext: a.base().baseModuleContextFactory(ctx),
416 finalPhase: finalPhase,
417 bazelConversionMode: bazelConversionMode,
Colin Cross617b88a2020-08-24 18:04:09 -0700418 }
419}
420
Colin Cross25de6c32019-06-06 14:29:25 -0700421func (x *registerMutatorsContext) BottomUp(name string, m BottomUpMutator) MutatorHandle {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000422 finalPhase := x.finalPhase
Liz Kammer356f7d42021-01-26 09:18:53 -0500423 bazelConversionMode := x.bazelConversionMode
Colin Cross798bfce2016-10-12 14:28:16 -0700424 f := func(ctx blueprint.BottomUpMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700425 if a, ok := ctx.Module().(Module); ok {
Liz Kammer356f7d42021-01-26 09:18:53 -0500426 m(bottomUpMutatorContextFactory(ctx, a, finalPhase, bazelConversionMode))
Colin Cross6362e272015-10-29 15:25:03 -0700427 }
Colin Cross798bfce2016-10-12 14:28:16 -0700428 }
Liz Kammer356f7d42021-01-26 09:18:53 -0500429 mutator := &mutator{name: x.mutatorName(name), bottomUpMutator: f}
Colin Cross795c3772017-03-16 16:50:10 -0700430 x.mutators = append(x.mutators, mutator)
Colin Cross798bfce2016-10-12 14:28:16 -0700431 return mutator
Colin Cross6362e272015-10-29 15:25:03 -0700432}
433
Colin Cross617b88a2020-08-24 18:04:09 -0700434func (x *registerMutatorsContext) BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle {
435 mutator := &mutator{name: name, bottomUpMutator: m}
436 x.mutators = append(x.mutators, mutator)
437 return mutator
438}
439
Liz Kammer356f7d42021-01-26 09:18:53 -0500440func (x *registerMutatorsContext) mutatorName(name string) string {
441 if x.bazelConversionMode {
442 return name + "_bp2build"
443 }
444 return name
445}
446
Colin Cross25de6c32019-06-06 14:29:25 -0700447func (x *registerMutatorsContext) TopDown(name string, m TopDownMutator) MutatorHandle {
Colin Cross798bfce2016-10-12 14:28:16 -0700448 f := func(ctx blueprint.TopDownMutatorContext) {
Colin Cross635c3b02016-05-18 15:37:25 -0700449 if a, ok := ctx.Module().(Module); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700450 actx := &topDownMutatorContext{
Colin Crossdc35e212019-06-06 16:13:11 -0700451 bp: ctx,
452 baseModuleContext: a.base().baseModuleContextFactory(ctx),
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(
518 factory ModuleFactory,
Liz Kammerfc46bc12021-02-19 11:06:17 -0500519 name string,
Jingwen Chen1fd14692021-02-05 03:01:50 -0500520 bazelProps bazel.BazelTargetModuleProperties,
521 attrs interface{}) BazelTargetModule {
Liz Kammerfc46bc12021-02-19 11:06:17 -0500522 if strings.HasPrefix(name, bazel.BazelTargetModuleNamePrefix) {
Jingwen Chenfb4692a2021-02-07 10:05:16 -0500523 panic(fmt.Errorf(
Liz Kammerfc46bc12021-02-19 11:06:17 -0500524 "The %s name prefix is added automatically, do not set it manually: %s",
Jingwen Chenfb4692a2021-02-07 10:05:16 -0500525 bazel.BazelTargetModuleNamePrefix,
Liz Kammerfc46bc12021-02-19 11:06:17 -0500526 name))
527 }
528 name = bazel.BazelTargetModuleNamePrefix + name
529 nameProp := struct {
530 Name *string
531 }{
532 Name: &name,
Jingwen Chenfb4692a2021-02-07 10:05:16 -0500533 }
534
Liz Kammerfc46bc12021-02-19 11:06:17 -0500535 b := t.CreateModule(factory, &nameProp, attrs).(BazelTargetModule)
536 b.SetBazelTargetModuleProperties(bazelProps)
537 return b
Jingwen Chen1fd14692021-02-05 03:01:50 -0500538}
539
Colin Cross25de6c32019-06-06 14:29:25 -0700540func (t *topDownMutatorContext) AppendProperties(props ...interface{}) {
Colin Cross519917d2017-11-02 16:35:56 -0700541 for _, p := range props {
Colin Cross25de6c32019-06-06 14:29:25 -0700542 err := proptools.AppendMatchingProperties(t.Module().base().customizableProperties,
Colin Cross519917d2017-11-02 16:35:56 -0700543 p, nil)
544 if err != nil {
545 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700546 t.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
Colin Cross519917d2017-11-02 16:35:56 -0700547 } else {
548 panic(err)
549 }
550 }
551 }
552}
553
Colin Cross25de6c32019-06-06 14:29:25 -0700554func (t *topDownMutatorContext) PrependProperties(props ...interface{}) {
Colin Cross519917d2017-11-02 16:35:56 -0700555 for _, p := range props {
Colin Cross25de6c32019-06-06 14:29:25 -0700556 err := proptools.PrependMatchingProperties(t.Module().base().customizableProperties,
Colin Cross519917d2017-11-02 16:35:56 -0700557 p, nil)
558 if err != nil {
559 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
Colin Cross25de6c32019-06-06 14:29:25 -0700560 t.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
Colin Cross519917d2017-11-02 16:35:56 -0700561 } else {
562 panic(err)
563 }
564 }
565 }
566}
Colin Crossdc35e212019-06-06 16:13:11 -0700567
568// android.topDownMutatorContext either has to embed blueprint.TopDownMutatorContext, in which case every method that
569// has an overridden version in android.BaseModuleContext has to be manually forwarded to BaseModuleContext to avoid
570// ambiguous method errors, or it has to store a blueprint.TopDownMutatorContext non-embedded, in which case every
571// non-overridden method has to be forwarded. There are fewer non-overridden methods, so use the latter. The following
572// methods forward to the identical blueprint versions for topDownMutatorContext and bottomUpMutatorContext.
573
Colin Crosscb55e082019-07-01 15:32:31 -0700574func (t *topDownMutatorContext) MutatorName() string {
575 return t.bp.MutatorName()
576}
577
Colin Crossdc35e212019-06-06 16:13:11 -0700578func (t *topDownMutatorContext) Rename(name string) {
579 t.bp.Rename(name)
Colin Cross9a362232019-07-01 15:32:45 -0700580 t.Module().base().commonProperties.DebugName = name
Colin Crossdc35e212019-06-06 16:13:11 -0700581}
582
Colin Crosse003c4a2019-09-25 12:58:36 -0700583func (t *topDownMutatorContext) CreateModule(factory ModuleFactory, props ...interface{}) Module {
Colin Cross18c46802019-09-24 22:19:02 -0700584 inherited := []interface{}{&t.Module().base().commonProperties}
Colin Crosse003c4a2019-09-25 12:58:36 -0700585 module := t.bp.CreateModule(ModuleFactoryAdaptor(factory), append(inherited, props...)...).(Module)
Colin Cross18c46802019-09-24 22:19:02 -0700586
587 if t.Module().base().variableProperties != nil && module.base().variableProperties != nil {
588 src := t.Module().base().variableProperties
589 dst := []interface{}{
590 module.base().variableProperties,
591 // Put an empty copy of the src properties into dst so that properties in src that are not in dst
592 // don't cause a "failed to find property to extend" error.
Colin Cross43e789d2020-01-28 09:46:50 -0800593 proptools.CloneEmptyProperties(reflect.ValueOf(src)).Interface(),
Colin Cross18c46802019-09-24 22:19:02 -0700594 }
595 err := proptools.AppendMatchingProperties(dst, src, nil)
596 if err != nil {
597 panic(err)
598 }
599 }
600
Colin Crosse003c4a2019-09-25 12:58:36 -0700601 return module
Colin Crossdc35e212019-06-06 16:13:11 -0700602}
603
Colin Crosscb55e082019-07-01 15:32:31 -0700604func (b *bottomUpMutatorContext) MutatorName() string {
605 return b.bp.MutatorName()
606}
607
Colin Crossdc35e212019-06-06 16:13:11 -0700608func (b *bottomUpMutatorContext) Rename(name string) {
609 b.bp.Rename(name)
Colin Cross9a362232019-07-01 15:32:45 -0700610 b.Module().base().commonProperties.DebugName = name
Colin Crossdc35e212019-06-06 16:13:11 -0700611}
612
Colin Cross4f1dcb02020-09-16 18:45:04 -0700613func (b *bottomUpMutatorContext) AddDependency(module blueprint.Module, tag blueprint.DependencyTag, name ...string) []blueprint.Module {
614 return b.bp.AddDependency(module, tag, name...)
Colin Crossdc35e212019-06-06 16:13:11 -0700615}
616
617func (b *bottomUpMutatorContext) AddReverseDependency(module blueprint.Module, tag blueprint.DependencyTag, name string) {
618 b.bp.AddReverseDependency(module, tag, name)
619}
620
Colin Cross43b92e02019-11-18 15:28:57 -0800621func (b *bottomUpMutatorContext) CreateVariations(variations ...string) []Module {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000622 if b.finalPhase {
623 panic("CreateVariations not allowed in FinalDepsMutators")
624 }
625
Colin Cross9a362232019-07-01 15:32:45 -0700626 modules := b.bp.CreateVariations(variations...)
627
Colin Cross43b92e02019-11-18 15:28:57 -0800628 aModules := make([]Module, len(modules))
Colin Cross9a362232019-07-01 15:32:45 -0700629 for i := range variations {
Colin Cross43b92e02019-11-18 15:28:57 -0800630 aModules[i] = modules[i].(Module)
631 base := aModules[i].base()
Colin Cross9a362232019-07-01 15:32:45 -0700632 base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName())
633 base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i])
634 }
635
Colin Cross43b92e02019-11-18 15:28:57 -0800636 return aModules
Colin Crossdc35e212019-06-06 16:13:11 -0700637}
638
Colin Cross43b92e02019-11-18 15:28:57 -0800639func (b *bottomUpMutatorContext) CreateLocalVariations(variations ...string) []Module {
Martin Stjernholm710ec3a2020-01-16 15:12:04 +0000640 if b.finalPhase {
641 panic("CreateLocalVariations not allowed in FinalDepsMutators")
642 }
643
Colin Cross9a362232019-07-01 15:32:45 -0700644 modules := b.bp.CreateLocalVariations(variations...)
645
Colin Cross43b92e02019-11-18 15:28:57 -0800646 aModules := make([]Module, len(modules))
Colin Cross9a362232019-07-01 15:32:45 -0700647 for i := range variations {
Colin Cross43b92e02019-11-18 15:28:57 -0800648 aModules[i] = modules[i].(Module)
649 base := aModules[i].base()
Colin Cross9a362232019-07-01 15:32:45 -0700650 base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName())
651 base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i])
652 }
653
Colin Cross43b92e02019-11-18 15:28:57 -0800654 return aModules
Colin Crossdc35e212019-06-06 16:13:11 -0700655}
656
657func (b *bottomUpMutatorContext) SetDependencyVariation(variation string) {
658 b.bp.SetDependencyVariation(variation)
659}
660
Jiyong Park1d1119f2019-07-29 21:27:18 +0900661func (b *bottomUpMutatorContext) SetDefaultDependencyVariation(variation *string) {
662 b.bp.SetDefaultDependencyVariation(variation)
663}
664
Colin Crossdc35e212019-06-06 16:13:11 -0700665func (b *bottomUpMutatorContext) AddVariationDependencies(variations []blueprint.Variation, tag blueprint.DependencyTag,
Colin Cross4f1dcb02020-09-16 18:45:04 -0700666 names ...string) []blueprint.Module {
Liz Kammer356f7d42021-01-26 09:18:53 -0500667 if b.bazelConversionMode {
668 _, noSelfDeps := RemoveFromList(b.ModuleName(), names)
669 if len(noSelfDeps) == 0 {
670 return []blueprint.Module(nil)
671 }
672 // In Bazel conversion mode, mutators should not have created any variants. So, when adding a
673 // dependency, the variations would not exist and the dependency could not be added, by
674 // specifying no variations, we will allow adding the dependency to succeed.
675 return b.bp.AddFarVariationDependencies(nil, tag, noSelfDeps...)
676 }
Colin Crossdc35e212019-06-06 16:13:11 -0700677
Colin Cross4f1dcb02020-09-16 18:45:04 -0700678 return b.bp.AddVariationDependencies(variations, tag, names...)
Colin Crossdc35e212019-06-06 16:13:11 -0700679}
680
681func (b *bottomUpMutatorContext) AddFarVariationDependencies(variations []blueprint.Variation,
Colin Cross4f1dcb02020-09-16 18:45:04 -0700682 tag blueprint.DependencyTag, names ...string) []blueprint.Module {
Liz Kammer356f7d42021-01-26 09:18:53 -0500683 if b.bazelConversionMode {
684 // In Bazel conversion mode, mutators should not have created any variants. So, when adding a
685 // dependency, the variations would not exist and the dependency could not be added, by
686 // specifying no variations, we will allow adding the dependency to succeed.
687 return b.bp.AddFarVariationDependencies(nil, tag, names...)
688 }
Colin Crossdc35e212019-06-06 16:13:11 -0700689
Colin Cross4f1dcb02020-09-16 18:45:04 -0700690 return b.bp.AddFarVariationDependencies(variations, tag, names...)
Colin Crossdc35e212019-06-06 16:13:11 -0700691}
692
693func (b *bottomUpMutatorContext) AddInterVariantDependency(tag blueprint.DependencyTag, from, to blueprint.Module) {
694 b.bp.AddInterVariantDependency(tag, from, to)
695}
696
697func (b *bottomUpMutatorContext) ReplaceDependencies(name string) {
698 b.bp.ReplaceDependencies(name)
699}
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800700
Paul Duffin80342d72020-06-26 22:08:43 +0100701func (b *bottomUpMutatorContext) ReplaceDependenciesIf(name string, predicate blueprint.ReplaceDependencyPredicate) {
702 b.bp.ReplaceDependenciesIf(name, predicate)
703}
704
Jaewoong Jung9f88ce22019-11-15 10:57:34 -0800705func (b *bottomUpMutatorContext) AliasVariation(variationName string) {
706 b.bp.AliasVariation(variationName)
707}
Colin Cross1b9604b2020-08-11 12:03:56 -0700708
709func (b *bottomUpMutatorContext) CreateAliasVariation(fromVariationName, toVariationName string) {
710 b.bp.CreateAliasVariation(fromVariationName, toVariationName)
711}
Colin Crossd27e7b82020-07-02 11:38:17 -0700712
713func (b *bottomUpMutatorContext) SetVariationProvider(module blueprint.Module, provider blueprint.ProviderKey, value interface{}) {
714 b.bp.SetVariationProvider(module, provider, value)
715}
Liz Kammer356f7d42021-01-26 09:18:53 -0500716
717func (b *bottomUpMutatorContext) BazelConversionMode() bool {
718 return b.bazelConversionMode
719}