bp2build: refactor/standardize cc_* bp2build converters am: ed9c17d033 am: 0a52f7276e am: 8bddaab06a

Original change: https://android-review.googlesource.com/c/platform/build/soong/+/1674326

Change-Id: I5874807a960a030a8f7367d3ce877b2542100b84
This commit is contained in:
Jingwen Chen
2021-04-22 11:28:47 +00:00
committed by Automerger Merge Worker
11 changed files with 579 additions and 224 deletions

View File

@@ -16,7 +16,7 @@ package cc
import (
"android/soong/android"
"android/soong/bazel"
"strings"
"path/filepath"
)
// bp2build functions and helpers for converting cc_* modules to Bazel.
@@ -53,6 +53,18 @@ func depsBp2BuildMutator(ctx android.BottomUpMutatorContext) {
if baseLinkerProps, ok := p.(*BaseLinkerProperties); ok {
allDeps = append(allDeps, baseLinkerProps.Header_libs...)
allDeps = append(allDeps, baseLinkerProps.Export_header_lib_headers...)
allDeps = append(allDeps, baseLinkerProps.Static_libs...)
allDeps = append(allDeps, baseLinkerProps.Whole_static_libs...)
}
}
for _, p := range module.GetArchProperties(&BaseLinkerProperties{}) {
// arch specific linker props
if baseLinkerProps, ok := p.(*BaseLinkerProperties); ok {
allDeps = append(allDeps, baseLinkerProps.Header_libs...)
allDeps = append(allDeps, baseLinkerProps.Export_header_lib_headers...)
allDeps = append(allDeps, baseLinkerProps.Static_libs...)
allDeps = append(allDeps, baseLinkerProps.Whole_static_libs...)
}
}
@@ -61,51 +73,80 @@ func depsBp2BuildMutator(ctx android.BottomUpMutatorContext) {
// Convenience struct to hold all attributes parsed from compiler properties.
type compilerAttributes struct {
copts bazel.StringListAttribute
srcs bazel.LabelListAttribute
hdrs bazel.LabelListAttribute
copts bazel.StringListAttribute
srcs bazel.LabelListAttribute
includes bazel.StringListAttribute
}
// bp2BuildParseCompilerProps returns copts, srcs and hdrs and other attributes.
func bp2BuildParseCompilerProps(ctx android.TopDownMutatorContext, module *Module) compilerAttributes {
var hdrs, srcs bazel.LabelListAttribute
var localHdrs, srcs bazel.LabelListAttribute
var copts bazel.StringListAttribute
hdrsAndSrcs := func(baseCompilerProps *BaseCompilerProperties) (bazel.LabelList, bazel.LabelList) {
srcsList := android.BazelLabelForModuleSrcExcludes(
ctx, baseCompilerProps.Srcs, baseCompilerProps.Exclude_srcs)
hdrsList := android.BazelLabelForModuleSrc(ctx, srcsList.LooseHdrsGlobs(headerExts))
return hdrsList, srcsList
// Creates the -I flag for a directory, while making the directory relative
// to the exec root for Bazel to work.
includeFlag := func(dir string) string {
// filepath.Join canonicalizes the path, i.e. it takes care of . or .. elements.
return "-I" + filepath.Join(ctx.ModuleDir(), dir)
}
// Parse the list of srcs, excluding files from exclude_srcs.
parseSrcs := func(baseCompilerProps *BaseCompilerProperties) bazel.LabelList {
return android.BazelLabelForModuleSrcExcludes(ctx, baseCompilerProps.Srcs, baseCompilerProps.Exclude_srcs)
}
// Parse the list of module-relative include directories (-I).
parseLocalIncludeDirs := func(baseCompilerProps *BaseCompilerProperties) []string {
// include_dirs are root-relative, not module-relative.
includeDirs := bp2BuildMakePathsRelativeToModule(ctx, baseCompilerProps.Include_dirs)
return append(includeDirs, baseCompilerProps.Local_include_dirs...)
}
// Parse the list of copts.
parseCopts := func(baseCompilerProps *BaseCompilerProperties) []string {
copts := append([]string{}, baseCompilerProps.Cflags...)
for _, dir := range parseLocalIncludeDirs(baseCompilerProps) {
copts = append(copts, includeFlag(dir))
}
return copts
}
for _, props := range module.compiler.compilerProps() {
if baseCompilerProps, ok := props.(*BaseCompilerProperties); ok {
hdrs.Value, srcs.Value = hdrsAndSrcs(baseCompilerProps)
copts.Value = baseCompilerProps.Cflags
srcs.Value = parseSrcs(baseCompilerProps)
copts.Value = parseCopts(baseCompilerProps)
break
}
}
if c, ok := module.compiler.(*baseCompiler); ok && c.includeBuildDirectory() {
copts.Value = append(copts.Value, includeFlag("."))
localHdrs.Value = bp2BuildListHeadersInDir(ctx, ".")
} else if c, ok := module.compiler.(*libraryDecorator); ok && c.includeBuildDirectory() {
copts.Value = append(copts.Value, includeFlag("."))
localHdrs.Value = bp2BuildListHeadersInDir(ctx, ".")
}
for arch, props := range module.GetArchProperties(&BaseCompilerProperties{}) {
if baseCompilerProps, ok := props.(*BaseCompilerProperties); ok {
hdrsList, srcsList := hdrsAndSrcs(baseCompilerProps)
hdrs.SetValueForArch(arch.Name, bazel.SubtractBazelLabelList(hdrsList, hdrs.Value))
srcs.SetValueForArch(arch.Name, srcsList)
copts.SetValueForArch(arch.Name, baseCompilerProps.Cflags)
srcsList := parseSrcs(baseCompilerProps)
srcs.SetValueForArch(arch.Name, bazel.SubtractBazelLabelList(srcsList, srcs.Value))
copts.SetValueForArch(arch.Name, parseCopts(baseCompilerProps))
}
}
for os, props := range module.GetTargetProperties(&BaseCompilerProperties{}) {
if baseCompilerProps, ok := props.(*BaseCompilerProperties); ok {
hdrsList, srcsList := hdrsAndSrcs(baseCompilerProps)
hdrs.SetValueForOS(os.Name, bazel.SubtractBazelLabelList(hdrsList, hdrs.Value))
srcs.SetValueForOS(os.Name, srcsList)
copts.SetValueForOS(os.Name, baseCompilerProps.Cflags)
srcsList := parseSrcs(baseCompilerProps)
srcs.SetValueForOS(os.Name, bazel.SubtractBazelLabelList(srcsList, srcs.Value))
copts.SetValueForOS(os.Name, parseCopts(baseCompilerProps))
}
}
// Combine local, non-exported hdrs into srcs
srcs.Append(localHdrs)
return compilerAttributes{
hdrs: hdrs,
srcs: srcs,
copts: copts,
}
@@ -120,7 +161,6 @@ type linkerAttributes struct {
// bp2BuildParseLinkerProps creates a label list attribute containing the header library deps of a module, including
// configurable attribute values.
func bp2BuildParseLinkerProps(ctx android.TopDownMutatorContext, module *Module) linkerAttributes {
var deps bazel.LabelListAttribute
var linkopts bazel.StringListAttribute
@@ -128,8 +168,10 @@ func bp2BuildParseLinkerProps(ctx android.TopDownMutatorContext, module *Module)
if baseLinkerProps, ok := linkerProps.(*BaseLinkerProperties); ok {
libs := baseLinkerProps.Header_libs
libs = append(libs, baseLinkerProps.Export_header_lib_headers...)
deps = bazel.MakeLabelListAttribute(
android.BazelLabelForModuleDeps(ctx, android.SortedUniqueStrings(libs)))
libs = append(libs, baseLinkerProps.Static_libs...)
libs = append(libs, baseLinkerProps.Whole_static_libs...)
libs = android.SortedUniqueStrings(libs)
deps = bazel.MakeLabelListAttribute(android.BazelLabelForModuleDeps(ctx, libs))
linkopts.Value = baseLinkerProps.Ldflags
break
}
@@ -139,6 +181,8 @@ func bp2BuildParseLinkerProps(ctx android.TopDownMutatorContext, module *Module)
if baseLinkerProps, ok := p.(*BaseLinkerProperties); ok {
libs := baseLinkerProps.Header_libs
libs = append(libs, baseLinkerProps.Export_header_lib_headers...)
libs = append(libs, baseLinkerProps.Static_libs...)
libs = append(libs, baseLinkerProps.Whole_static_libs...)
libs = android.SortedUniqueStrings(libs)
deps.SetValueForArch(arch.Name, android.BazelLabelForModuleDeps(ctx, libs))
linkopts.SetValueForArch(arch.Name, baseLinkerProps.Ldflags)
@@ -149,6 +193,8 @@ func bp2BuildParseLinkerProps(ctx android.TopDownMutatorContext, module *Module)
if baseLinkerProps, ok := p.(*BaseLinkerProperties); ok {
libs := baseLinkerProps.Header_libs
libs = append(libs, baseLinkerProps.Export_header_lib_headers...)
libs = append(libs, baseLinkerProps.Static_libs...)
libs = append(libs, baseLinkerProps.Whole_static_libs...)
libs = android.SortedUniqueStrings(libs)
deps.SetValueForOS(os.Name, android.BazelLabelForModuleDeps(ctx, libs))
linkopts.SetValueForOS(os.Name, baseLinkerProps.Ldflags)
@@ -162,28 +208,44 @@ func bp2BuildParseLinkerProps(ctx android.TopDownMutatorContext, module *Module)
}
func bp2BuildListHeadersInDir(ctx android.TopDownMutatorContext, includeDir string) bazel.LabelList {
globs := bazel.GlobsInDir(includeDir, includeDir != ".", headerExts)
globs := bazel.GlobsInDir(includeDir, true, headerExts)
return android.BazelLabelForModuleSrc(ctx, globs)
}
// Bazel wants include paths to be relative to the module
func bp2BuildMakePathsRelativeToModule(ctx android.TopDownMutatorContext, paths []string) []string {
// Relativize a list of root-relative paths with respect to the module's
// directory.
//
// include_dirs Soong prop are root-relative (b/183742505), but
// local_include_dirs, export_include_dirs and export_system_include_dirs are
// module dir relative. This function makes a list of paths entirely module dir
// relative.
//
// For the `include` attribute, Bazel wants the paths to be relative to the
// module.
func bp2BuildMakePathsRelativeToModule(ctx android.BazelConversionPathContext, paths []string) []string {
var relativePaths []string
for _, path := range paths {
relativePath := strings.TrimPrefix(path, ctx.ModuleDir()+"/")
// Semantics of filepath.Rel: join(ModuleDir, rel(ModuleDir, path)) == path
relativePath, err := filepath.Rel(ctx.ModuleDir(), path)
if err != nil {
panic(err)
}
relativePaths = append(relativePaths, relativePath)
}
return relativePaths
}
// bp2BuildParseExportedIncludes creates a label list attribute contains the
// exported included directories of a module.
// bp2BuildParseExportedIncludes creates a string list attribute contains the
// exported included directories of a module, and a label list attribute
// containing the exported headers of a module.
func bp2BuildParseExportedIncludes(ctx android.TopDownMutatorContext, module *Module) (bazel.StringListAttribute, bazel.LabelListAttribute) {
libraryDecorator := module.linker.(*libraryDecorator)
// Export_system_include_dirs and export_include_dirs are already module dir
// relative, so they don't need to be relativized like include_dirs, which
// are root-relative.
includeDirs := libraryDecorator.flagExporter.Properties.Export_system_include_dirs
includeDirs = append(includeDirs, libraryDecorator.flagExporter.Properties.Export_include_dirs...)
includeDirs = bp2BuildMakePathsRelativeToModule(ctx, includeDirs)
includeDirsAttribute := bazel.MakeStringListAttribute(includeDirs)
var headersAttribute bazel.LabelListAttribute
@@ -198,7 +260,6 @@ func bp2BuildParseExportedIncludes(ctx android.TopDownMutatorContext, module *Mo
if flagExporterProperties, ok := props.(*FlagExporterProperties); ok {
archIncludeDirs := flagExporterProperties.Export_system_include_dirs
archIncludeDirs = append(archIncludeDirs, flagExporterProperties.Export_include_dirs...)
archIncludeDirs = bp2BuildMakePathsRelativeToModule(ctx, archIncludeDirs)
// To avoid duplicate includes when base includes + arch includes are combined
archIncludeDirs = bazel.SubtractStrings(archIncludeDirs, includeDirs)

View File

@@ -260,11 +260,10 @@ func CcLibraryBp2Build(ctx android.TopDownMutatorContext) {
compilerAttrs := bp2BuildParseCompilerProps(ctx, m)
linkerAttrs := bp2BuildParseLinkerProps(ctx, m)
exportedIncludes, exportedIncludesHeaders := bp2BuildParseExportedIncludes(ctx, m)
compilerAttrs.hdrs.Append(exportedIncludesHeaders)
attrs := &bazelCcLibraryAttributes{
Srcs: compilerAttrs.srcs,
Hdrs: compilerAttrs.hdrs,
Hdrs: exportedIncludesHeaders,
Copts: compilerAttrs.copts,
Linkopts: linkerAttrs.linkopts,
Deps: linkerAttrs.deps,
@@ -2163,69 +2162,16 @@ func CcLibraryStaticBp2Build(ctx android.TopDownMutatorContext) {
}
compilerAttrs := bp2BuildParseCompilerProps(ctx, module)
var includeDirs []string
var localIncludeDirs []string
for _, props := range module.compiler.compilerProps() {
if baseCompilerProps, ok := props.(*BaseCompilerProperties); ok {
// TODO: these should be arch and os specific.
includeDirs = bp2BuildMakePathsRelativeToModule(ctx, baseCompilerProps.Include_dirs)
localIncludeDirs = bp2BuildMakePathsRelativeToModule(ctx, baseCompilerProps.Local_include_dirs)
break
}
}
// Soong implicitly includes headers from the module's directory.
// For Bazel builds to work we have to make these header includes explicit.
if module.compiler.(*libraryDecorator).includeBuildDirectory() {
localIncludeDirs = append(localIncludeDirs, ".")
}
// For Bazel, be more explicit about headers - list all header files in include dirs as srcs
for _, includeDir := range includeDirs {
compilerAttrs.srcs.Value.Append(bp2BuildListHeadersInDir(ctx, includeDir))
}
for _, localIncludeDir := range localIncludeDirs {
compilerAttrs.srcs.Value.Append(bp2BuildListHeadersInDir(ctx, localIncludeDir))
}
var staticLibs []string
var wholeStaticLibs []string
for _, props := range module.linker.linkerProps() {
// TODO: move this into bp2buildParseLinkerProps
if baseLinkerProperties, ok := props.(*BaseLinkerProperties); ok {
staticLibs = baseLinkerProperties.Static_libs
wholeStaticLibs = baseLinkerProperties.Whole_static_libs
break
}
}
// FIXME: Treat Static_libs and Whole_static_libs differently?
allDeps := staticLibs
allDeps = append(allDeps, wholeStaticLibs...)
depsLabels := android.BazelLabelForModuleDeps(ctx, allDeps)
exportedIncludes, exportedIncludesHeaders := bp2BuildParseExportedIncludes(ctx, module)
// FIXME: Unify absolute vs relative paths
// FIXME: Use -I copts instead of setting includes= ?
allIncludes := exportedIncludes
allIncludes.Value = append(allIncludes.Value, includeDirs...)
allIncludes.Value = append(allIncludes.Value, localIncludeDirs...)
compilerAttrs.hdrs.Append(exportedIncludesHeaders)
linkerAttrs := bp2BuildParseLinkerProps(ctx, module)
depsLabels.Append(linkerAttrs.deps.Value)
exportedIncludes, exportedIncludesHeaders := bp2BuildParseExportedIncludes(ctx, module)
attrs := &bazelCcLibraryStaticAttributes{
Copts: compilerAttrs.copts,
Srcs: compilerAttrs.srcs,
Deps: bazel.MakeLabelListAttribute(depsLabels),
Deps: linkerAttrs.deps,
Linkstatic: true,
Includes: allIncludes,
Hdrs: compilerAttrs.hdrs,
Includes: exportedIncludes,
Hdrs: exportedIncludesHeaders,
}
props := bazel.BazelTargetModuleProperties{

View File

@@ -95,14 +95,14 @@ func CcLibraryHeadersBp2Build(ctx android.TopDownMutatorContext) {
return
}
exportedIncludes, exportedIncludesHeaders := bp2BuildParseExportedIncludes(ctx, module)
exportedIncludes, exportedHdrs := bp2BuildParseExportedIncludes(ctx, module)
compilerAttrs := bp2BuildParseCompilerProps(ctx, module)
linkerAttrs := bp2BuildParseLinkerProps(ctx, module)
attrs := &bazelCcLibraryHeadersAttributes{
Copts: compilerAttrs.copts,
Includes: exportedIncludes,
Hdrs: exportedIncludesHeaders,
Hdrs: exportedHdrs,
Deps: linkerAttrs.deps,
}

View File

@@ -112,12 +112,11 @@ func ObjectFactory() android.Module {
// For bp2build conversion.
type bazelObjectAttributes struct {
Srcs bazel.LabelListAttribute
Hdrs bazel.LabelListAttribute
Deps bazel.LabelListAttribute
Copts bazel.StringListAttribute
Asflags []string
Local_include_dirs []string
Srcs bazel.LabelListAttribute
Hdrs bazel.LabelListAttribute
Deps bazel.LabelListAttribute
Copts bazel.StringListAttribute
Asflags []string
}
type bazelObject struct {
@@ -158,18 +157,7 @@ func ObjectBp2Build(ctx android.TopDownMutatorContext) {
// Set arch-specific configurable attributes
compilerAttrs := bp2BuildParseCompilerProps(ctx, m)
var localIncludeDirs []string
var asFlags []string
for _, props := range m.compiler.compilerProps() {
if baseCompilerProps, ok := props.(*BaseCompilerProperties); ok {
localIncludeDirs = baseCompilerProps.Local_include_dirs
break
}
}
if c, ok := m.compiler.(*baseCompiler); ok && c.includeBuildDirectory() {
localIncludeDirs = append(localIncludeDirs, ".")
}
var deps bazel.LabelListAttribute
for _, props := range m.linker.linkerProps() {
@@ -197,12 +185,10 @@ func ObjectBp2Build(ctx android.TopDownMutatorContext) {
// TODO(b/183595872) warn/error if we're not handling product variables
attrs := &bazelObjectAttributes{
Srcs: compilerAttrs.srcs,
Hdrs: compilerAttrs.hdrs,
Deps: deps,
Copts: compilerAttrs.copts,
Asflags: asFlags,
Local_include_dirs: localIncludeDirs,
Srcs: compilerAttrs.srcs,
Deps: deps,
Copts: compilerAttrs.copts,
Asflags: asFlags,
}
props := bazel.BazelTargetModuleProperties{