Don't create a new module for bp2build conversion.
A performance improvement for bp2build as Blueprint/Soong no longer have
the overhead of additional modules. The creation of these modules
results in:
* traversal of additional modules for each subsequent mutator
* synchronization over a go channel to collect newly created modules:
https://cs.android.com/android/platform/superproject/+/master:build/blueprint/context.go;l=2594,2600;drc=1602226f23181b8c3fbfcaf3358f0297e839d7d3
We avoid both of these by storing the information directly in the
underlying module.
Also as a fringe benefit, removes some necessary boilerplate for
conversion.
For benchmarks, reduces runtime ~1% for 1% converted, ~24% for 100%
converted. See more: go/benchmarks-for-https:-r.android.com-1792714
Test: ran benchmarks/tests in bp2build
Test: build/bazel/ci/bp2build.sh
Change-Id: Ie9273b8cbab5bc6edac1728067ce184382feb211
diff --git a/bp2build/build_conversion.go b/bp2build/build_conversion.go
index 96a8b09..a64d474 100644
--- a/bp2build/build_conversion.go
+++ b/bp2build/build_conversion.go
@@ -244,7 +244,7 @@
dir := bpCtx.ModuleDir(m)
dirs[dir] = true
- var t BazelTarget
+ var targets []BazelTarget
switch ctx.Mode() {
case Bp2Build:
@@ -258,18 +258,23 @@
if _, exists := buildFileToAppend[pathToBuildFile]; exists {
return
}
- var err error
- t, err = getHandcraftedBuildContent(ctx, b, pathToBuildFile)
+ t, err := getHandcraftedBuildContent(ctx, b, pathToBuildFile)
if err != nil {
panic(fmt.Errorf("Error converting %s: %s", bpCtx.ModuleName(m), err))
}
+ targets = append(targets, t)
// TODO(b/181575318): currently we append the whole BUILD file, let's change that to do
// something more targeted based on the rule type and target
buildFileToAppend[pathToBuildFile] = true
- } else if btm, ok := m.(android.BazelTargetModule); ok {
- t = generateBazelTarget(bpCtx, m, btm)
- metrics.RuleClassCount[t.ruleClass] += 1
- compatLayer.AddNameToLabelEntry(m.Name(), t.Label())
+ } else if aModule, ok := m.(android.Module); ok && aModule.IsConvertedByBp2build() {
+ targets = generateBazelTargets(bpCtx, aModule)
+ for _, t := range targets {
+ if t.name == m.Name() {
+ // only add targets that exist in Soong to compatibility layer
+ compatLayer.AddNameToLabelEntry(m.Name(), t.Label())
+ }
+ metrics.RuleClassCount[t.ruleClass] += 1
+ }
} else {
metrics.TotalModuleCount += 1
return
@@ -281,12 +286,13 @@
// be mapped cleanly to a bazel label.
return
}
- t = generateSoongModuleTarget(bpCtx, m)
+ t := generateSoongModuleTarget(bpCtx, m)
+ targets = append(targets, t)
default:
panic(fmt.Errorf("Unknown code-generation mode: %s", ctx.Mode()))
}
- buildFileToTargets[dir] = append(buildFileToTargets[dir], t)
+ buildFileToTargets[dir] = append(buildFileToTargets[dir], targets...)
})
if generateFilegroups {
// Add a filegroup target that exposes all sources in the subtree of this package
@@ -326,22 +332,38 @@
}, nil
}
-func generateBazelTarget(ctx bpToBuildContext, m blueprint.Module, btm android.BazelTargetModule) BazelTarget {
- ruleClass := btm.RuleClass()
- bzlLoadLocation := btm.BzlLoadLocation()
+func generateBazelTargets(ctx bpToBuildContext, m android.Module) []BazelTarget {
+ var targets []BazelTarget
+ for _, m := range m.Bp2buildTargets() {
+ targets = append(targets, generateBazelTarget(ctx, m))
+ }
+ return targets
+}
+
+type bp2buildModule interface {
+ TargetName() string
+ TargetPackage() string
+ BazelRuleClass() string
+ BazelRuleLoadLocation() string
+ BazelAttributes() interface{}
+}
+
+func generateBazelTarget(ctx bpToBuildContext, m bp2buildModule) BazelTarget {
+ ruleClass := m.BazelRuleClass()
+ bzlLoadLocation := m.BazelRuleLoadLocation()
// extract the bazel attributes from the module.
- props := getBuildProperties(ctx, m)
+ props := extractModuleProperties([]interface{}{m.BazelAttributes()})
delete(props.Attrs, "bp2build_available")
// Return the Bazel target with rule class and attributes, ready to be
// code-generated.
attributes := propsToAttributes(props.Attrs)
- targetName := targetNameForBp2Build(ctx, m)
+ targetName := m.TargetName()
return BazelTarget{
name: targetName,
- packageName: ctx.ModuleDir(m),
+ packageName: m.TargetPackage(),
ruleClass: ruleClass,
bzlLoadLocation: bzlLoadLocation,
content: fmt.Sprintf(
@@ -391,24 +413,21 @@
}
func getBuildProperties(ctx bpToBuildContext, m blueprint.Module) BazelAttributes {
- var allProps map[string]string
// TODO: this omits properties for blueprint modules (blueprint_go_binary,
// bootstrap_go_binary, bootstrap_go_package), which will have to be handled separately.
if aModule, ok := m.(android.Module); ok {
- allProps = ExtractModuleProperties(aModule)
+ return extractModuleProperties(aModule.GetProperties())
}
- return BazelAttributes{
- Attrs: allProps,
- }
+ return BazelAttributes{}
}
// Generically extract module properties and types into a map, keyed by the module property name.
-func ExtractModuleProperties(aModule android.Module) map[string]string {
+func extractModuleProperties(props []interface{}) BazelAttributes {
ret := map[string]string{}
// Iterate over this android.Module's property structs.
- for _, properties := range aModule.GetProperties() {
+ for _, properties := range props {
propertiesValue := reflect.ValueOf(properties)
// Check that propertiesValue is a pointer to the Properties struct, like
// *cc.BaseLinkerProperties or *java.CompilerProperties.
@@ -427,7 +446,9 @@
}
}
- return ret
+ return BazelAttributes{
+ Attrs: ret,
+ }
}
func isStructPtr(t reflect.Type) bool {
diff --git a/bp2build/build_conversion_test.go b/bp2build/build_conversion_test.go
index eb3a73f..0d9106c 100644
--- a/bp2build/build_conversion_test.go
+++ b/bp2build/build_conversion_test.go
@@ -480,12 +480,12 @@
name = "bar",
)
-my_proto_library(
- name = "bar_my_proto_library_deps",
-)
-
proto_library(
name = "bar_proto_library_deps",
+)
+
+my_proto_library(
+ name = "bar_my_proto_library_deps",
)`,
expectedBazelTargetCount: 3,
expectedLoadStatements: `load("//build/bazel/rules:proto.bzl", "my_proto_library", "proto_library")
@@ -1213,22 +1213,24 @@
dir := "."
for _, testCase := range testCases {
- config := android.TestConfig(buildDir, nil, testCase.bp, nil)
- ctx := android.NewTestContext(config)
- ctx.RegisterModuleType(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestFactory)
- ctx.RegisterBp2BuildMutator(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestBp2BuildMutator)
- ctx.RegisterForBazelConversion()
+ t.Run(testCase.description, func(t *testing.T) {
+ config := android.TestConfig(buildDir, nil, testCase.bp, nil)
+ ctx := android.NewTestContext(config)
+ ctx.RegisterModuleType(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestFactory)
+ ctx.RegisterBp2BuildMutator(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestBp2BuildMutator)
+ ctx.RegisterForBazelConversion()
- _, errs := ctx.ParseFileList(dir, []string{"Android.bp"})
- android.FailIfErrored(t, errs)
- _, errs = ctx.ResolveDependencies(config)
- android.FailIfErrored(t, errs)
+ _, errs := ctx.ParseFileList(dir, []string{"Android.bp"})
+ android.FailIfErrored(t, errs)
+ _, errs = ctx.ResolveDependencies(config)
+ android.FailIfErrored(t, errs)
- codegenCtx := NewCodegenContext(config, *ctx.Context, Bp2Build)
- bazelTargets := generateBazelTargetsForDir(codegenCtx, dir)
- if actualCount := len(bazelTargets); actualCount != testCase.expectedCount {
- t.Fatalf("%s: Expected %d bazel target, got %d", testCase.description, testCase.expectedCount, actualCount)
- }
+ codegenCtx := NewCodegenContext(config, *ctx.Context, Bp2Build)
+ bazelTargets := generateBazelTargetsForDir(codegenCtx, dir)
+ if actualCount := len(bazelTargets); actualCount != testCase.expectedCount {
+ t.Fatalf("%s: Expected %d bazel target, got %d", testCase.description, testCase.expectedCount, actualCount)
+ }
+ })
}
}
diff --git a/bp2build/testing.go b/bp2build/testing.go
index faf1a44..266b817 100644
--- a/bp2build/testing.go
+++ b/bp2build/testing.go
@@ -140,16 +140,6 @@
customBazelModuleAttributes
}
-func customBazelModuleFactory() android.Module {
- module := &customBazelModule{}
- module.AddProperties(&module.customBazelModuleAttributes)
- android.InitBazelTargetModule(module)
- return module
-}
-
-func (m *customBazelModule) Name() string { return m.BaseModuleName() }
-func (m *customBazelModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {}
-
func customBp2BuildMutator(ctx android.TopDownMutatorContext) {
if m, ok := ctx.Module().(*customModule); ok {
if !m.ConvertWithBp2build(ctx) {
@@ -178,7 +168,7 @@
Rule_class: "custom",
}
- ctx.CreateBazelTargetModule(customBazelModuleFactory, m.Name(), props, attrs)
+ ctx.CreateBazelTargetModule(m.Name(), props, attrs)
}
}
@@ -197,19 +187,19 @@
Rule_class: "my_library",
Bzl_load_location: "//build/bazel/rules:rules.bzl",
}
- ctx.CreateBazelTargetModule(customBazelModuleFactory, baseName, myLibraryProps, attrs)
+ ctx.CreateBazelTargetModule(baseName, myLibraryProps, attrs)
protoLibraryProps := bazel.BazelTargetModuleProperties{
Rule_class: "proto_library",
Bzl_load_location: "//build/bazel/rules:proto.bzl",
}
- ctx.CreateBazelTargetModule(customBazelModuleFactory, baseName+"_proto_library_deps", protoLibraryProps, attrs)
+ ctx.CreateBazelTargetModule(baseName+"_proto_library_deps", protoLibraryProps, attrs)
myProtoLibraryProps := bazel.BazelTargetModuleProperties{
Rule_class: "my_proto_library",
Bzl_load_location: "//build/bazel/rules:proto.bzl",
}
- ctx.CreateBazelTargetModule(customBazelModuleFactory, baseName+"_my_proto_library_deps", myProtoLibraryProps, attrs)
+ ctx.CreateBazelTargetModule(baseName+"_my_proto_library_deps", myProtoLibraryProps, attrs)
}
}