Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 1 | // 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 Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 15 | package android |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 16 | |
Colin Cross | 795c377 | 2017-03-16 16:50:10 -0700 | [diff] [blame] | 17 | import ( |
Colin Cross | 18c4680 | 2019-09-24 22:19:02 -0700 | [diff] [blame] | 18 | "reflect" |
| 19 | |
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux | 447f6c9 | 2021-08-31 20:30:36 +0000 | [diff] [blame] | 20 | "android/soong/bazel" |
| 21 | |
Colin Cross | 795c377 | 2017-03-16 16:50:10 -0700 | [diff] [blame] | 22 | "github.com/google/blueprint" |
Colin Cross | 519917d | 2017-11-02 16:35:56 -0700 | [diff] [blame] | 23 | "github.com/google/blueprint/proptools" |
Colin Cross | 795c377 | 2017-03-16 16:50:10 -0700 | [diff] [blame] | 24 | ) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 25 | |
Jeff Gaston | af3cc2d | 2017-09-27 17:01:44 -0700 | [diff] [blame] | 26 | // Phases: |
| 27 | // run Pre-arch mutators |
| 28 | // run archMutator |
| 29 | // run Pre-deps mutators |
| 30 | // run depsMutator |
| 31 | // run PostDeps mutators |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 32 | // run FinalDeps mutators (CreateVariations disallowed in this phase) |
Jeff Gaston | af3cc2d | 2017-09-27 17:01:44 -0700 | [diff] [blame] | 33 | // continue on to GenerateAndroidBuildActions |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 34 | |
Jingwen Chen | 7385067 | 2020-12-14 08:25:34 -0500 | [diff] [blame] | 35 | // RegisterMutatorsForBazelConversion is a alternate registration pipeline for bp2build. Exported for testing. |
Liz Kammer | be46fcc | 2021-11-01 15:32:43 -0400 | [diff] [blame] | 36 | func RegisterMutatorsForBazelConversion(ctx *Context, preArchMutators []RegisterMutatorFunc) { |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 37 | mctx := ®isterMutatorsContext{ |
| 38 | bazelConversionMode: true, |
Jingwen Chen | 041b184 | 2021-02-01 00:23:25 -0500 | [diff] [blame] | 39 | } |
| 40 | |
Liz Kammer | be46fcc | 2021-11-01 15:32:43 -0400 | [diff] [blame] | 41 | bp2buildMutators := append([]RegisterMutatorFunc{ |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 42 | RegisterNamespaceMutator, |
| 43 | RegisterDefaultsPreArchMutators, |
| 44 | // TODO(b/165114590): this is required to resolve deps that are only prebuilts, but we should |
| 45 | // evaluate the impact on conversion. |
| 46 | RegisterPrebuiltsPreArchMutators, |
| 47 | }, |
| 48 | preArchMutators...) |
Liz Kammer | be46fcc | 2021-11-01 15:32:43 -0400 | [diff] [blame] | 49 | bp2buildMutators = append(bp2buildMutators, registerBp2buildConversionMutator) |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 50 | |
Jingwen Chen | 7385067 | 2020-12-14 08:25:34 -0500 | [diff] [blame] | 51 | // Register bp2build mutators |
| 52 | for _, f := range bp2buildMutators { |
| 53 | f(mctx) |
| 54 | } |
| 55 | |
Paul Duffin | 1d2d42f | 2021-03-06 20:08:12 +0000 | [diff] [blame] | 56 | mctx.mutators.registerAll(ctx) |
Jingwen Chen | 4133ce6 | 2020-12-02 04:34:15 -0500 | [diff] [blame] | 57 | } |
| 58 | |
Paul Duffin | c05b034 | 2021-03-06 13:28:13 +0000 | [diff] [blame] | 59 | // collateGloballyRegisteredMutators constructs the list of mutators that have been registered |
| 60 | // with the InitRegistrationContext and will be used at runtime. |
| 61 | func collateGloballyRegisteredMutators() sortableComponents { |
| 62 | return collateRegisteredMutators(preArch, preDeps, postDeps, finalDeps) |
| 63 | } |
| 64 | |
| 65 | // collateRegisteredMutators constructs a single list of mutators from the separate lists. |
| 66 | func collateRegisteredMutators(preArch, preDeps, postDeps, finalDeps []RegisterMutatorFunc) sortableComponents { |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 67 | mctx := ®isterMutatorsContext{} |
Nan Zhang | db0b9a3 | 2017-02-27 10:12:13 -0800 | [diff] [blame] | 68 | |
| 69 | register := func(funcs []RegisterMutatorFunc) { |
| 70 | for _, f := range funcs { |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 71 | f(mctx) |
Nan Zhang | db0b9a3 | 2017-02-27 10:12:13 -0800 | [diff] [blame] | 72 | } |
| 73 | } |
| 74 | |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 75 | register(preArch) |
Nan Zhang | db0b9a3 | 2017-02-27 10:12:13 -0800 | [diff] [blame] | 76 | |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 77 | register(preDeps) |
| 78 | |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 79 | register([]RegisterMutatorFunc{registerDepsMutator}) |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 80 | |
| 81 | register(postDeps) |
| 82 | |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 83 | mctx.finalPhase = true |
| 84 | register(finalDeps) |
| 85 | |
Paul Duffin | c05b034 | 2021-03-06 13:28:13 +0000 | [diff] [blame] | 86 | return mctx.mutators |
Colin Cross | 795c377 | 2017-03-16 16:50:10 -0700 | [diff] [blame] | 87 | } |
| 88 | |
| 89 | type registerMutatorsContext struct { |
Paul Duffin | 1d2d42f | 2021-03-06 20:08:12 +0000 | [diff] [blame] | 90 | mutators sortableComponents |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 91 | finalPhase bool |
| 92 | bazelConversionMode bool |
Colin Cross | 795c377 | 2017-03-16 16:50:10 -0700 | [diff] [blame] | 93 | } |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 94 | |
| 95 | type RegisterMutatorsContext interface { |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 96 | TopDown(name string, m TopDownMutator) MutatorHandle |
| 97 | BottomUp(name string, m BottomUpMutator) MutatorHandle |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 98 | BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 99 | } |
| 100 | |
| 101 | type RegisterMutatorFunc func(RegisterMutatorsContext) |
| 102 | |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 103 | var preArch = []RegisterMutatorFunc{ |
Dan Willemsen | 6e72ef7 | 2018-01-26 18:27:02 -0800 | [diff] [blame] | 104 | RegisterNamespaceMutator, |
Paul Duffin | aa4162e | 2020-05-05 11:35:43 +0100 | [diff] [blame] | 105 | |
Paul Duffin | aa4162e | 2020-05-05 11:35:43 +0100 | [diff] [blame] | 106 | // Check the visibility rules are valid. |
| 107 | // |
| 108 | // This must run after the package renamer mutators so that any issues found during |
| 109 | // validation of the package's default_visibility property are reported using the |
| 110 | // correct package name and not the synthetic name. |
| 111 | // |
| 112 | // This must also be run before defaults mutators as the rules for validation are |
| 113 | // different before checking the rules than they are afterwards. e.g. |
| 114 | // visibility: ["//visibility:private", "//visibility:public"] |
| 115 | // would be invalid if specified in a module definition but is valid if it results |
| 116 | // from something like this: |
| 117 | // |
| 118 | // defaults { |
| 119 | // name: "defaults", |
| 120 | // // Be inaccessible outside a package by default. |
| 121 | // visibility: ["//visibility:private"] |
| 122 | // } |
| 123 | // |
| 124 | // defaultable_module { |
| 125 | // name: "defaultable_module", |
| 126 | // defaults: ["defaults"], |
| 127 | // // Override the default. |
| 128 | // visibility: ["//visibility:public"] |
| 129 | // } |
| 130 | // |
Paul Duffin | 593b3c9 | 2019-12-05 14:31:48 +0000 | [diff] [blame] | 131 | RegisterVisibilityRuleChecker, |
Paul Duffin | aa4162e | 2020-05-05 11:35:43 +0100 | [diff] [blame] | 132 | |
Bob Badour | 37af046 | 2021-01-07 03:34:31 +0000 | [diff] [blame] | 133 | // Record the default_applicable_licenses for each package. |
| 134 | // |
| 135 | // This must run before the defaults so that defaults modules can pick up the package default. |
| 136 | RegisterLicensesPackageMapper, |
| 137 | |
Paul Duffin | aa4162e | 2020-05-05 11:35:43 +0100 | [diff] [blame] | 138 | // Apply properties from defaults modules to the referencing modules. |
Paul Duffin | afa9fa1 | 2020-04-29 16:47:28 +0100 | [diff] [blame] | 139 | // |
| 140 | // Any mutators that are added before this will not see any modules created by |
| 141 | // a DefaultableHook. |
Colin Cross | 89536d4 | 2017-07-07 14:35:50 -0700 | [diff] [blame] | 142 | RegisterDefaultsPreArchMutators, |
Paul Duffin | aa4162e | 2020-05-05 11:35:43 +0100 | [diff] [blame] | 143 | |
Paul Duffin | 44f1d84 | 2020-06-26 20:17:02 +0100 | [diff] [blame] | 144 | // Add dependencies on any components so that any component references can be |
| 145 | // resolved within the deps mutator. |
| 146 | // |
| 147 | // Must be run after defaults so it can be used to create dependencies on the |
| 148 | // component modules that are creating in a DefaultableHook. |
| 149 | // |
| 150 | // Must be run before RegisterPrebuiltsPreArchMutators, i.e. before prebuilts are |
| 151 | // renamed. That is so that if a module creates components using a prebuilt module |
| 152 | // type that any dependencies (which must use prebuilt_ prefixes) are resolved to |
| 153 | // the prebuilt module and not the source module. |
| 154 | RegisterComponentsMutator, |
| 155 | |
Paul Duffin | c988c8e | 2020-04-29 18:27:14 +0100 | [diff] [blame] | 156 | // Create an association between prebuilt modules and their corresponding source |
| 157 | // modules (if any). |
Paul Duffin | afa9fa1 | 2020-04-29 16:47:28 +0100 | [diff] [blame] | 158 | // |
| 159 | // Must be run after defaults mutators to ensure that any modules created by |
| 160 | // a DefaultableHook can be either a prebuilt or a source module with a matching |
| 161 | // prebuilt. |
Paul Duffin | c988c8e | 2020-04-29 18:27:14 +0100 | [diff] [blame] | 162 | RegisterPrebuiltsPreArchMutators, |
| 163 | |
Bob Badour | 37af046 | 2021-01-07 03:34:31 +0000 | [diff] [blame] | 164 | // Gather the licenses properties for all modules for use during expansion and enforcement. |
| 165 | // |
| 166 | // This must come after the defaults mutators to ensure that any licenses supplied |
| 167 | // in a defaults module has been successfully applied before the rules are gathered. |
| 168 | RegisterLicensesPropertyGatherer, |
| 169 | |
Paul Duffin | aa4162e | 2020-05-05 11:35:43 +0100 | [diff] [blame] | 170 | // Gather the visibility rules for all modules for us during visibility enforcement. |
| 171 | // |
| 172 | // This must come after the defaults mutators to ensure that any visibility supplied |
| 173 | // in a defaults module has been successfully applied before the rules are gathered. |
Paul Duffin | 593b3c9 | 2019-12-05 14:31:48 +0000 | [diff] [blame] | 174 | RegisterVisibilityRuleGatherer, |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 175 | } |
| 176 | |
Colin Cross | ae4c618 | 2017-09-15 17:33:55 -0700 | [diff] [blame] | 177 | func registerArchMutator(ctx RegisterMutatorsContext) { |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 178 | ctx.BottomUpBlueprint("os", osMutator).Parallel() |
Colin Cross | fb0c16e | 2019-11-20 17:12:35 -0800 | [diff] [blame] | 179 | ctx.BottomUp("image", imageMutator).Parallel() |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 180 | ctx.BottomUpBlueprint("arch", archMutator).Parallel() |
Colin Cross | ae4c618 | 2017-09-15 17:33:55 -0700 | [diff] [blame] | 181 | } |
| 182 | |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 183 | var preDeps = []RegisterMutatorFunc{ |
Colin Cross | ae4c618 | 2017-09-15 17:33:55 -0700 | [diff] [blame] | 184 | registerArchMutator, |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | var postDeps = []RegisterMutatorFunc{ |
Colin Cross | 1b48842 | 2019-03-04 22:33:56 -0800 | [diff] [blame] | 188 | registerPathDepsMutator, |
Colin Cross | 5ea9bcc | 2017-07-27 15:41:32 -0700 | [diff] [blame] | 189 | RegisterPrebuiltsPostDepsMutators, |
Paul Duffin | 593b3c9 | 2019-12-05 14:31:48 +0000 | [diff] [blame] | 190 | RegisterVisibilityRuleEnforcer, |
Bob Badour | 37af046 | 2021-01-07 03:34:31 +0000 | [diff] [blame] | 191 | RegisterLicensesDependencyChecker, |
Paul Duffin | 45338f0 | 2021-03-30 23:07:52 +0100 | [diff] [blame] | 192 | registerNeverallowMutator, |
Jaewoong Jung | b639a6a | 2019-05-10 15:16:29 -0700 | [diff] [blame] | 193 | RegisterOverridePostDepsMutators, |
Colin Cross | cec8171 | 2017-07-13 14:43:27 -0700 | [diff] [blame] | 194 | } |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 195 | |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 196 | var finalDeps = []RegisterMutatorFunc{} |
| 197 | |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 198 | func PreArchMutators(f RegisterMutatorFunc) { |
| 199 | preArch = append(preArch, f) |
| 200 | } |
| 201 | |
| 202 | func PreDepsMutators(f RegisterMutatorFunc) { |
| 203 | preDeps = append(preDeps, f) |
| 204 | } |
| 205 | |
| 206 | func PostDepsMutators(f RegisterMutatorFunc) { |
| 207 | postDeps = append(postDeps, f) |
| 208 | } |
| 209 | |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 210 | func FinalDepsMutators(f RegisterMutatorFunc) { |
| 211 | finalDeps = append(finalDeps, f) |
| 212 | } |
| 213 | |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 214 | var bp2buildPreArchMutators = []RegisterMutatorFunc{} |
Rupert Shuttleworth | a9d76dd | 2021-07-02 07:17:16 -0400 | [diff] [blame] | 215 | |
Liz Kammer | 12615db | 2021-09-28 09:19:17 -0400 | [diff] [blame] | 216 | // A minimal context for Bp2build conversion |
| 217 | type Bp2buildMutatorContext interface { |
| 218 | BazelConversionPathContext |
| 219 | |
| 220 | CreateBazelTargetModule(bazel.BazelTargetModuleProperties, CommonAttributes, interface{}) |
| 221 | } |
| 222 | |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 223 | // PreArchBp2BuildMutators adds mutators to be register for converting Android Blueprint modules |
| 224 | // into Bazel BUILD targets that should run prior to deps and conversion. |
| 225 | func PreArchBp2BuildMutators(f RegisterMutatorFunc) { |
| 226 | bp2buildPreArchMutators = append(bp2buildPreArchMutators, f) |
| 227 | } |
| 228 | |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 229 | type BaseMutatorContext interface { |
| 230 | BaseModuleContext |
| 231 | |
| 232 | // MutatorName returns the name that this mutator was registered with. |
| 233 | MutatorName() string |
| 234 | |
| 235 | // Rename all variants of a module. The new name is not visible to calls to ModuleName, |
| 236 | // AddDependency or OtherModuleName until after this mutator pass is complete. |
| 237 | Rename(name string) |
Chris Parsons | 5a34ffb | 2021-07-21 14:34:58 -0400 | [diff] [blame] | 238 | |
| 239 | // BazelConversionMode returns whether this mutator is being run as part of Bazel Conversion. |
| 240 | BazelConversionMode() bool |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 241 | } |
| 242 | |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 243 | type TopDownMutator func(TopDownMutatorContext) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 244 | |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 245 | type TopDownMutatorContext interface { |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 246 | BaseMutatorContext |
Colin Cross | 3f68a13 | 2017-10-23 17:10:29 -0700 | [diff] [blame] | 247 | |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 248 | // CreateModule creates a new module by calling the factory method for the specified moduleType, and applies |
| 249 | // the specified property structs to it as if the properties were set in a blueprint file. |
Colin Cross | e003c4a | 2019-09-25 12:58:36 -0700 | [diff] [blame] | 250 | CreateModule(ModuleFactory, ...interface{}) Module |
Jingwen Chen | 1fd1469 | 2021-02-05 03:01:50 -0500 | [diff] [blame] | 251 | |
| 252 | // CreateBazelTargetModule creates a BazelTargetModule by calling the |
| 253 | // factory method, just like in CreateModule, but also requires |
| 254 | // BazelTargetModuleProperties containing additional metadata for the |
| 255 | // bp2build codegenerator. |
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux | 447f6c9 | 2021-08-31 20:30:36 +0000 | [diff] [blame] | 256 | CreateBazelTargetModule(bazel.BazelTargetModuleProperties, CommonAttributes, interface{}) |
Chris Parsons | 58852a0 | 2021-12-09 18:10:18 -0500 | [diff] [blame] | 257 | |
| 258 | // CreateBazelTargetModuleWithRestrictions creates a BazelTargetModule by calling the |
| 259 | // factory method, just like in CreateModule, but also requires |
| 260 | // BazelTargetModuleProperties containing additional metadata for the |
| 261 | // bp2build codegenerator. The generated target is restricted to only be buildable for certain |
| 262 | // platforms, as dictated by a given bool attribute: the target will not be buildable in |
| 263 | // any platform for which this bool attribute is false. |
| 264 | CreateBazelTargetModuleWithRestrictions(bazel.BazelTargetModuleProperties, CommonAttributes, interface{}, bazel.BoolAttribute) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 265 | } |
| 266 | |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 267 | type topDownMutatorContext struct { |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 268 | bp blueprint.TopDownMutatorContext |
Colin Cross | 0ea8ba8 | 2019-06-06 14:33:29 -0700 | [diff] [blame] | 269 | baseModuleContext |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 270 | } |
| 271 | |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 272 | type BottomUpMutator func(BottomUpMutatorContext) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 273 | |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 274 | type BottomUpMutatorContext interface { |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 275 | BaseMutatorContext |
Colin Cross | aabf679 | 2017-11-29 00:27:14 -0800 | [diff] [blame] | 276 | |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 277 | // AddDependency adds a dependency to the given module. It returns a slice of modules for each |
| 278 | // dependency (some entries may be nil). |
| 279 | // |
| 280 | // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the |
| 281 | // new dependencies have had the current mutator called on them. If the mutator is not |
| 282 | // parallel this method does not affect the ordering of the current mutator pass, but will |
| 283 | // be ordered correctly for all future mutator passes. |
| 284 | AddDependency(module blueprint.Module, tag blueprint.DependencyTag, name ...string) []blueprint.Module |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 285 | |
| 286 | // AddReverseDependency adds a dependency from the destination to the given module. |
| 287 | // Does not affect the ordering of the current mutator pass, but will be ordered |
| 288 | // correctly for all future mutator passes. All reverse dependencies for a destination module are |
| 289 | // collected until the end of the mutator pass, sorted by name, and then appended to the destination |
| 290 | // module's dependency list. |
Colin Cross | aabf679 | 2017-11-29 00:27:14 -0800 | [diff] [blame] | 291 | AddReverseDependency(module blueprint.Module, tag blueprint.DependencyTag, name string) |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 292 | |
| 293 | // CreateVariations splits a module into multiple variants, one for each name in the variationNames |
| 294 | // parameter. It returns a list of new modules in the same order as the variationNames |
| 295 | // list. |
| 296 | // |
| 297 | // If any of the dependencies of the module being operated on were already split |
| 298 | // by calling CreateVariations with the same name, the dependency will automatically |
| 299 | // be updated to point the matching variant. |
| 300 | // |
| 301 | // If a module is split, and then a module depending on the first module is not split |
| 302 | // when the Mutator is later called on it, the dependency of the depending module will |
| 303 | // automatically be updated to point to the first variant. |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 304 | CreateVariations(...string) []Module |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 305 | |
| 306 | // CreateLocationVariations splits a module into multiple variants, one for each name in the variantNames |
| 307 | // parameter. It returns a list of new modules in the same order as the variantNames |
| 308 | // list. |
| 309 | // |
| 310 | // Local variations do not affect automatic dependency resolution - dependencies added |
| 311 | // to the split module via deps or DynamicDependerModule must exactly match a variant |
| 312 | // that contains all the non-local variations. |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 313 | CreateLocalVariations(...string) []Module |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 314 | |
| 315 | // SetDependencyVariation sets all dangling dependencies on the current module to point to the variation |
| 316 | // with given name. This function ignores the default variation set by SetDefaultDependencyVariation. |
Colin Cross | aabf679 | 2017-11-29 00:27:14 -0800 | [diff] [blame] | 317 | SetDependencyVariation(string) |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 318 | |
| 319 | // SetDefaultDependencyVariation sets the default variation when a dangling reference is detected |
| 320 | // during the subsequent calls on Create*Variations* functions. To reset, set it to nil. |
Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 321 | SetDefaultDependencyVariation(*string) |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 322 | |
| 323 | // AddVariationDependencies adds deps as dependencies of the current module, but uses the variations |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 324 | // argument to select which variant of the dependency to use. It returns a slice of modules for |
| 325 | // each dependency (some entries may be nil). A variant of the dependency must exist that matches |
Usta Shrestha | c725f47 | 2022-01-11 02:44:21 -0500 | [diff] [blame] | 326 | // all the non-local variations of the current module, plus the variations argument. |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 327 | // |
| 328 | // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the |
| 329 | // new dependencies have had the current mutator called on them. If the mutator is not |
| 330 | // parallel this method does not affect the ordering of the current mutator pass, but will |
| 331 | // be ordered correctly for all future mutator passes. |
Usta Shrestha | c725f47 | 2022-01-11 02:44:21 -0500 | [diff] [blame] | 332 | AddVariationDependencies(variations []blueprint.Variation, tag blueprint.DependencyTag, names ...string) []blueprint.Module |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 333 | |
| 334 | // AddFarVariationDependencies adds deps as dependencies of the current module, but uses the |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 335 | // variations argument to select which variant of the dependency to use. It returns a slice of |
| 336 | // modules for each dependency (some entries may be nil). A variant of the dependency must |
| 337 | // exist that matches the variations argument, but may also have other variations. |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 338 | // For any unspecified variation the first variant will be used. |
| 339 | // |
| 340 | // Unlike AddVariationDependencies, the variations of the current module are ignored - the |
| 341 | // dependency only needs to match the supplied variations. |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 342 | // |
| 343 | // If the mutator is parallel (see MutatorHandle.Parallel), this method will pause until the |
| 344 | // new dependencies have had the current mutator called on them. If the mutator is not |
| 345 | // parallel this method does not affect the ordering of the current mutator pass, but will |
| 346 | // be ordered correctly for all future mutator passes. |
| 347 | AddFarVariationDependencies([]blueprint.Variation, blueprint.DependencyTag, ...string) []blueprint.Module |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 348 | |
| 349 | // AddInterVariantDependency adds a dependency between two variants of the same module. Variants are always |
| 350 | // ordered in the same orderas they were listed in CreateVariations, and AddInterVariantDependency does not change |
| 351 | // that ordering, but it associates a DependencyTag with the dependency and makes it visible to VisitDirectDeps, |
| 352 | // WalkDeps, etc. |
Colin Cross | aabf679 | 2017-11-29 00:27:14 -0800 | [diff] [blame] | 353 | AddInterVariantDependency(tag blueprint.DependencyTag, from, to blueprint.Module) |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 354 | |
| 355 | // ReplaceDependencies replaces all dependencies on the identical variant of the module with the |
| 356 | // specified name with the current variant of this module. Replacements don't take effect until |
| 357 | // after the mutator pass is finished. |
Colin Cross | aabf679 | 2017-11-29 00:27:14 -0800 | [diff] [blame] | 358 | ReplaceDependencies(string) |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 359 | |
| 360 | // ReplaceDependencies replaces all dependencies on the identical variant of the module with the |
| 361 | // specified name with the current variant of this module as long as the supplied predicate returns |
| 362 | // true. |
| 363 | // |
| 364 | // Replacements don't take effect until after the mutator pass is finished. |
Paul Duffin | 80342d7 | 2020-06-26 22:08:43 +0100 | [diff] [blame] | 365 | ReplaceDependenciesIf(string, blueprint.ReplaceDependencyPredicate) |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 366 | |
| 367 | // AliasVariation takes a variationName that was passed to CreateVariations for this module, |
| 368 | // and creates an alias from the current variant (before the mutator has run) to the new |
| 369 | // variant. The alias will be valid until the next time a mutator calls CreateVariations or |
| 370 | // CreateLocalVariations on this module without also calling AliasVariation. The alias can |
| 371 | // be used to add dependencies on the newly created variant using the variant map from |
| 372 | // before CreateVariations was run. |
Jaewoong Jung | 9f88ce2 | 2019-11-15 10:57:34 -0800 | [diff] [blame] | 373 | AliasVariation(variationName string) |
Colin Cross | 9f35c3d | 2020-09-16 19:04:41 -0700 | [diff] [blame] | 374 | |
| 375 | // CreateAliasVariation takes a toVariationName that was passed to CreateVariations for this |
| 376 | // module, and creates an alias from a new fromVariationName variant the toVariationName |
| 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 toVariationName variant using the fromVariationName |
| 380 | // variant. |
Colin Cross | 1b9604b | 2020-08-11 12:03:56 -0700 | [diff] [blame] | 381 | CreateAliasVariation(fromVariationName, toVariationName string) |
Colin Cross | d27e7b8 | 2020-07-02 11:38:17 -0700 | [diff] [blame] | 382 | |
| 383 | // SetVariationProvider sets the value for a provider for the given newly created variant of |
| 384 | // the current module, i.e. one of the Modules returned by CreateVariations.. It panics if |
| 385 | // not called during the appropriate mutator or GenerateBuildActions pass for the provider, |
| 386 | // if the value is not of the appropriate type, or if the module is not a newly created |
| 387 | // variant of the current module. The value should not be modified after being passed to |
| 388 | // SetVariationProvider. |
| 389 | SetVariationProvider(module blueprint.Module, provider blueprint.ProviderKey, value interface{}) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 390 | } |
| 391 | |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 392 | type bottomUpMutatorContext struct { |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 393 | bp blueprint.BottomUpMutatorContext |
Colin Cross | 0ea8ba8 | 2019-06-06 14:33:29 -0700 | [diff] [blame] | 394 | baseModuleContext |
Chris Parsons | 5a34ffb | 2021-07-21 14:34:58 -0400 | [diff] [blame] | 395 | finalPhase bool |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 396 | } |
| 397 | |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 398 | func bottomUpMutatorContextFactory(ctx blueprint.BottomUpMutatorContext, a Module, |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 399 | finalPhase, bazelConversionMode bool) BottomUpMutatorContext { |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 400 | |
Chris Parsons | 5a34ffb | 2021-07-21 14:34:58 -0400 | [diff] [blame] | 401 | moduleContext := a.base().baseModuleContextFactory(ctx) |
| 402 | moduleContext.bazelConversionMode = bazelConversionMode |
| 403 | |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 404 | return &bottomUpMutatorContext{ |
Chris Parsons | 5a34ffb | 2021-07-21 14:34:58 -0400 | [diff] [blame] | 405 | bp: ctx, |
| 406 | baseModuleContext: a.base().baseModuleContextFactory(ctx), |
| 407 | finalPhase: finalPhase, |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 408 | } |
| 409 | } |
| 410 | |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 411 | func (x *registerMutatorsContext) BottomUp(name string, m BottomUpMutator) MutatorHandle { |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 412 | finalPhase := x.finalPhase |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 413 | bazelConversionMode := x.bazelConversionMode |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 414 | f := func(ctx blueprint.BottomUpMutatorContext) { |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 415 | if a, ok := ctx.Module().(Module); ok { |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 416 | m(bottomUpMutatorContextFactory(ctx, a, finalPhase, bazelConversionMode)) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 417 | } |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 418 | } |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 419 | mutator := &mutator{name: x.mutatorName(name), bottomUpMutator: f} |
Colin Cross | 795c377 | 2017-03-16 16:50:10 -0700 | [diff] [blame] | 420 | x.mutators = append(x.mutators, mutator) |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 421 | return mutator |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 422 | } |
| 423 | |
Colin Cross | 617b88a | 2020-08-24 18:04:09 -0700 | [diff] [blame] | 424 | func (x *registerMutatorsContext) BottomUpBlueprint(name string, m blueprint.BottomUpMutator) MutatorHandle { |
| 425 | mutator := &mutator{name: name, bottomUpMutator: m} |
| 426 | x.mutators = append(x.mutators, mutator) |
| 427 | return mutator |
| 428 | } |
| 429 | |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 430 | func (x *registerMutatorsContext) mutatorName(name string) string { |
| 431 | if x.bazelConversionMode { |
| 432 | return name + "_bp2build" |
| 433 | } |
| 434 | return name |
| 435 | } |
| 436 | |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 437 | func (x *registerMutatorsContext) TopDown(name string, m TopDownMutator) MutatorHandle { |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 438 | f := func(ctx blueprint.TopDownMutatorContext) { |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 439 | if a, ok := ctx.Module().(Module); ok { |
Chris Parsons | 5a34ffb | 2021-07-21 14:34:58 -0400 | [diff] [blame] | 440 | moduleContext := a.base().baseModuleContextFactory(ctx) |
| 441 | moduleContext.bazelConversionMode = x.bazelConversionMode |
Colin Cross | 25de6c3 | 2019-06-06 14:29:25 -0700 | [diff] [blame] | 442 | actx := &topDownMutatorContext{ |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 443 | bp: ctx, |
Chris Parsons | 5a34ffb | 2021-07-21 14:34:58 -0400 | [diff] [blame] | 444 | baseModuleContext: moduleContext, |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 445 | } |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 446 | m(actx) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 447 | } |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 448 | } |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 449 | mutator := &mutator{name: x.mutatorName(name), topDownMutator: f} |
Colin Cross | 795c377 | 2017-03-16 16:50:10 -0700 | [diff] [blame] | 450 | x.mutators = append(x.mutators, mutator) |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 451 | return mutator |
| 452 | } |
| 453 | |
Paul Duffin | 1d2d42f | 2021-03-06 20:08:12 +0000 | [diff] [blame] | 454 | func (mutator *mutator) componentName() string { |
| 455 | return mutator.name |
| 456 | } |
| 457 | |
| 458 | func (mutator *mutator) register(ctx *Context) { |
| 459 | blueprintCtx := ctx.Context |
| 460 | var handle blueprint.MutatorHandle |
| 461 | if mutator.bottomUpMutator != nil { |
| 462 | handle = blueprintCtx.RegisterBottomUpMutator(mutator.name, mutator.bottomUpMutator) |
| 463 | } else if mutator.topDownMutator != nil { |
| 464 | handle = blueprintCtx.RegisterTopDownMutator(mutator.name, mutator.topDownMutator) |
| 465 | } |
| 466 | if mutator.parallel { |
| 467 | handle.Parallel() |
| 468 | } |
| 469 | } |
| 470 | |
Colin Cross | 798bfce | 2016-10-12 14:28:16 -0700 | [diff] [blame] | 471 | type MutatorHandle interface { |
| 472 | Parallel() MutatorHandle |
| 473 | } |
| 474 | |
| 475 | func (mutator *mutator) Parallel() MutatorHandle { |
| 476 | mutator.parallel = true |
| 477 | return mutator |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 478 | } |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 479 | |
Paul Duffin | 44f1d84 | 2020-06-26 20:17:02 +0100 | [diff] [blame] | 480 | func RegisterComponentsMutator(ctx RegisterMutatorsContext) { |
| 481 | ctx.BottomUp("component-deps", componentDepsMutator).Parallel() |
| 482 | } |
| 483 | |
| 484 | // A special mutator that runs just prior to the deps mutator to allow the dependencies |
| 485 | // on component modules to be added so that they can depend directly on a prebuilt |
| 486 | // module. |
| 487 | func componentDepsMutator(ctx BottomUpMutatorContext) { |
| 488 | if m := ctx.Module(); m.Enabled() { |
| 489 | m.ComponentDepsMutator(ctx) |
| 490 | } |
| 491 | } |
| 492 | |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 493 | func depsMutator(ctx BottomUpMutatorContext) { |
Paul Duffin | 44f1d84 | 2020-06-26 20:17:02 +0100 | [diff] [blame] | 494 | if m := ctx.Module(); m.Enabled() { |
Colin Cross | 1e676be | 2016-10-12 14:38:15 -0700 | [diff] [blame] | 495 | m.DepsMutator(ctx) |
| 496 | } |
| 497 | } |
Colin Cross | d11fcda | 2017-10-23 17:59:01 -0700 | [diff] [blame] | 498 | |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 499 | func registerDepsMutator(ctx RegisterMutatorsContext) { |
| 500 | ctx.BottomUp("deps", depsMutator).Parallel() |
| 501 | } |
| 502 | |
| 503 | func registerDepsMutatorBp2Build(ctx RegisterMutatorsContext) { |
| 504 | // TODO(b/179313531): Consider a separate mutator that only runs depsMutator for modules that are |
| 505 | // being converted to build targets. |
| 506 | ctx.BottomUp("deps", depsMutator).Parallel() |
| 507 | } |
| 508 | |
Jingwen Chen | 1fd1469 | 2021-02-05 03:01:50 -0500 | [diff] [blame] | 509 | func (t *topDownMutatorContext) CreateBazelTargetModule( |
Jingwen Chen | 1fd1469 | 2021-02-05 03:01:50 -0500 | [diff] [blame] | 510 | bazelProps bazel.BazelTargetModuleProperties, |
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux | 447f6c9 | 2021-08-31 20:30:36 +0000 | [diff] [blame] | 511 | commonAttrs CommonAttributes, |
Liz Kammer | 2ada09a | 2021-08-11 00:17:36 -0400 | [diff] [blame] | 512 | attrs interface{}) { |
Chris Parsons | 58852a0 | 2021-12-09 18:10:18 -0500 | [diff] [blame] | 513 | t.createBazelTargetModule(bazelProps, commonAttrs, attrs, bazel.BoolAttribute{}) |
| 514 | } |
| 515 | |
| 516 | func (t *topDownMutatorContext) CreateBazelTargetModuleWithRestrictions( |
| 517 | bazelProps bazel.BazelTargetModuleProperties, |
| 518 | commonAttrs CommonAttributes, |
| 519 | attrs interface{}, |
| 520 | enabledProperty bazel.BoolAttribute) { |
| 521 | t.createBazelTargetModule(bazelProps, commonAttrs, attrs, enabledProperty) |
| 522 | } |
| 523 | |
| 524 | func (t *topDownMutatorContext) createBazelTargetModule( |
| 525 | bazelProps bazel.BazelTargetModuleProperties, |
| 526 | commonAttrs CommonAttributes, |
| 527 | attrs interface{}, |
| 528 | enabledProperty bazel.BoolAttribute) { |
| 529 | constraintAttributes := commonAttrs.fillCommonBp2BuildModuleAttrs(t, enabledProperty) |
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux | 447f6c9 | 2021-08-31 20:30:36 +0000 | [diff] [blame] | 530 | mod := t.Module() |
Liz Kammer | 2ada09a | 2021-08-11 00:17:36 -0400 | [diff] [blame] | 531 | info := bp2buildInfo{ |
Chris Parsons | 58852a0 | 2021-12-09 18:10:18 -0500 | [diff] [blame] | 532 | Dir: t.OtherModuleDir(mod), |
| 533 | BazelProps: bazelProps, |
| 534 | CommonAttrs: commonAttrs, |
| 535 | ConstraintAttrs: constraintAttributes, |
| 536 | Attrs: attrs, |
Jingwen Chen | fb4692a | 2021-02-07 10:05:16 -0500 | [diff] [blame] | 537 | } |
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux | 447f6c9 | 2021-08-31 20:30:36 +0000 | [diff] [blame] | 538 | mod.base().addBp2buildInfo(info) |
Jingwen Chen | 1fd1469 | 2021-02-05 03:01:50 -0500 | [diff] [blame] | 539 | } |
| 540 | |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 541 | // android.topDownMutatorContext either has to embed blueprint.TopDownMutatorContext, in which case every method that |
| 542 | // has an overridden version in android.BaseModuleContext has to be manually forwarded to BaseModuleContext to avoid |
| 543 | // ambiguous method errors, or it has to store a blueprint.TopDownMutatorContext non-embedded, in which case every |
| 544 | // non-overridden method has to be forwarded. There are fewer non-overridden methods, so use the latter. The following |
| 545 | // methods forward to the identical blueprint versions for topDownMutatorContext and bottomUpMutatorContext. |
| 546 | |
Colin Cross | cb55e08 | 2019-07-01 15:32:31 -0700 | [diff] [blame] | 547 | func (t *topDownMutatorContext) MutatorName() string { |
| 548 | return t.bp.MutatorName() |
| 549 | } |
| 550 | |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 551 | func (t *topDownMutatorContext) Rename(name string) { |
| 552 | t.bp.Rename(name) |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 553 | t.Module().base().commonProperties.DebugName = name |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 554 | } |
| 555 | |
Colin Cross | e003c4a | 2019-09-25 12:58:36 -0700 | [diff] [blame] | 556 | func (t *topDownMutatorContext) CreateModule(factory ModuleFactory, props ...interface{}) Module { |
Colin Cross | 18c4680 | 2019-09-24 22:19:02 -0700 | [diff] [blame] | 557 | inherited := []interface{}{&t.Module().base().commonProperties} |
Colin Cross | e003c4a | 2019-09-25 12:58:36 -0700 | [diff] [blame] | 558 | module := t.bp.CreateModule(ModuleFactoryAdaptor(factory), append(inherited, props...)...).(Module) |
Colin Cross | 18c4680 | 2019-09-24 22:19:02 -0700 | [diff] [blame] | 559 | |
| 560 | if t.Module().base().variableProperties != nil && module.base().variableProperties != nil { |
| 561 | src := t.Module().base().variableProperties |
| 562 | dst := []interface{}{ |
| 563 | module.base().variableProperties, |
| 564 | // Put an empty copy of the src properties into dst so that properties in src that are not in dst |
| 565 | // don't cause a "failed to find property to extend" error. |
Colin Cross | 43e789d | 2020-01-28 09:46:50 -0800 | [diff] [blame] | 566 | proptools.CloneEmptyProperties(reflect.ValueOf(src)).Interface(), |
Colin Cross | 18c4680 | 2019-09-24 22:19:02 -0700 | [diff] [blame] | 567 | } |
| 568 | err := proptools.AppendMatchingProperties(dst, src, nil) |
| 569 | if err != nil { |
| 570 | panic(err) |
| 571 | } |
| 572 | } |
| 573 | |
Colin Cross | e003c4a | 2019-09-25 12:58:36 -0700 | [diff] [blame] | 574 | return module |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 575 | } |
| 576 | |
Liz Kammer | a060c45 | 2021-03-24 10:14:47 -0400 | [diff] [blame] | 577 | func (t *topDownMutatorContext) createModuleWithoutInheritance(factory ModuleFactory, props ...interface{}) Module { |
| 578 | module := t.bp.CreateModule(ModuleFactoryAdaptor(factory), props...).(Module) |
| 579 | return module |
| 580 | } |
| 581 | |
Colin Cross | cb55e08 | 2019-07-01 15:32:31 -0700 | [diff] [blame] | 582 | func (b *bottomUpMutatorContext) MutatorName() string { |
| 583 | return b.bp.MutatorName() |
| 584 | } |
| 585 | |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 586 | func (b *bottomUpMutatorContext) Rename(name string) { |
| 587 | b.bp.Rename(name) |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 588 | b.Module().base().commonProperties.DebugName = name |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 589 | } |
| 590 | |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 591 | func (b *bottomUpMutatorContext) AddDependency(module blueprint.Module, tag blueprint.DependencyTag, name ...string) []blueprint.Module { |
| 592 | return b.bp.AddDependency(module, tag, name...) |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 593 | } |
| 594 | |
| 595 | func (b *bottomUpMutatorContext) AddReverseDependency(module blueprint.Module, tag blueprint.DependencyTag, name string) { |
| 596 | b.bp.AddReverseDependency(module, tag, name) |
| 597 | } |
| 598 | |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 599 | func (b *bottomUpMutatorContext) CreateVariations(variations ...string) []Module { |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 600 | if b.finalPhase { |
| 601 | panic("CreateVariations not allowed in FinalDepsMutators") |
| 602 | } |
| 603 | |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 604 | modules := b.bp.CreateVariations(variations...) |
| 605 | |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 606 | aModules := make([]Module, len(modules)) |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 607 | for i := range variations { |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 608 | aModules[i] = modules[i].(Module) |
| 609 | base := aModules[i].base() |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 610 | base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName()) |
| 611 | base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i]) |
| 612 | } |
| 613 | |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 614 | return aModules |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 615 | } |
| 616 | |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 617 | func (b *bottomUpMutatorContext) CreateLocalVariations(variations ...string) []Module { |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 618 | if b.finalPhase { |
| 619 | panic("CreateLocalVariations not allowed in FinalDepsMutators") |
| 620 | } |
| 621 | |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 622 | modules := b.bp.CreateLocalVariations(variations...) |
| 623 | |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 624 | aModules := make([]Module, len(modules)) |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 625 | for i := range variations { |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 626 | aModules[i] = modules[i].(Module) |
| 627 | base := aModules[i].base() |
Colin Cross | 9a36223 | 2019-07-01 15:32:45 -0700 | [diff] [blame] | 628 | base.commonProperties.DebugMutators = append(base.commonProperties.DebugMutators, b.MutatorName()) |
| 629 | base.commonProperties.DebugVariations = append(base.commonProperties.DebugVariations, variations[i]) |
| 630 | } |
| 631 | |
Colin Cross | 43b92e0 | 2019-11-18 15:28:57 -0800 | [diff] [blame] | 632 | return aModules |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 633 | } |
| 634 | |
| 635 | func (b *bottomUpMutatorContext) SetDependencyVariation(variation string) { |
| 636 | b.bp.SetDependencyVariation(variation) |
| 637 | } |
| 638 | |
Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 639 | func (b *bottomUpMutatorContext) SetDefaultDependencyVariation(variation *string) { |
| 640 | b.bp.SetDefaultDependencyVariation(variation) |
| 641 | } |
| 642 | |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 643 | func (b *bottomUpMutatorContext) AddVariationDependencies(variations []blueprint.Variation, tag blueprint.DependencyTag, |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 644 | names ...string) []blueprint.Module { |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 645 | if b.bazelConversionMode { |
| 646 | _, noSelfDeps := RemoveFromList(b.ModuleName(), names) |
| 647 | if len(noSelfDeps) == 0 { |
| 648 | return []blueprint.Module(nil) |
| 649 | } |
| 650 | // In Bazel conversion mode, mutators should not have created any variants. So, when adding a |
| 651 | // dependency, the variations would not exist and the dependency could not be added, by |
| 652 | // specifying no variations, we will allow adding the dependency to succeed. |
| 653 | return b.bp.AddFarVariationDependencies(nil, tag, noSelfDeps...) |
| 654 | } |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 655 | |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 656 | return b.bp.AddVariationDependencies(variations, tag, names...) |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 657 | } |
| 658 | |
| 659 | func (b *bottomUpMutatorContext) AddFarVariationDependencies(variations []blueprint.Variation, |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 660 | tag blueprint.DependencyTag, names ...string) []blueprint.Module { |
Liz Kammer | 356f7d4 | 2021-01-26 09:18:53 -0500 | [diff] [blame] | 661 | if b.bazelConversionMode { |
| 662 | // In Bazel conversion mode, mutators should not have created any variants. So, when adding a |
| 663 | // dependency, the variations would not exist and the dependency could not be added, by |
| 664 | // specifying no variations, we will allow adding the dependency to succeed. |
| 665 | return b.bp.AddFarVariationDependencies(nil, tag, names...) |
| 666 | } |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 667 | |
Colin Cross | 4f1dcb0 | 2020-09-16 18:45:04 -0700 | [diff] [blame] | 668 | return b.bp.AddFarVariationDependencies(variations, tag, names...) |
Colin Cross | dc35e21 | 2019-06-06 16:13:11 -0700 | [diff] [blame] | 669 | } |
| 670 | |
| 671 | func (b *bottomUpMutatorContext) AddInterVariantDependency(tag blueprint.DependencyTag, from, to blueprint.Module) { |
| 672 | b.bp.AddInterVariantDependency(tag, from, to) |
| 673 | } |
| 674 | |
| 675 | func (b *bottomUpMutatorContext) ReplaceDependencies(name string) { |
| 676 | b.bp.ReplaceDependencies(name) |
| 677 | } |
Jaewoong Jung | 9f88ce2 | 2019-11-15 10:57:34 -0800 | [diff] [blame] | 678 | |
Paul Duffin | 80342d7 | 2020-06-26 22:08:43 +0100 | [diff] [blame] | 679 | func (b *bottomUpMutatorContext) ReplaceDependenciesIf(name string, predicate blueprint.ReplaceDependencyPredicate) { |
| 680 | b.bp.ReplaceDependenciesIf(name, predicate) |
| 681 | } |
| 682 | |
Jaewoong Jung | 9f88ce2 | 2019-11-15 10:57:34 -0800 | [diff] [blame] | 683 | func (b *bottomUpMutatorContext) AliasVariation(variationName string) { |
| 684 | b.bp.AliasVariation(variationName) |
| 685 | } |
Colin Cross | 1b9604b | 2020-08-11 12:03:56 -0700 | [diff] [blame] | 686 | |
| 687 | func (b *bottomUpMutatorContext) CreateAliasVariation(fromVariationName, toVariationName string) { |
| 688 | b.bp.CreateAliasVariation(fromVariationName, toVariationName) |
| 689 | } |
Colin Cross | d27e7b8 | 2020-07-02 11:38:17 -0700 | [diff] [blame] | 690 | |
| 691 | func (b *bottomUpMutatorContext) SetVariationProvider(module blueprint.Module, provider blueprint.ProviderKey, value interface{}) { |
| 692 | b.bp.SetVariationProvider(module, provider, value) |
| 693 | } |