cfff924ef9
The host variant of libdexfile and its deps were added to module sdk to support the use case of building platform tests without art's source code. This use case is not very relevant today, so we can drop the host variant of these modules from the module sdk. We still need to keep them in <= U snapshots, so this CL uses a hack to drop these libraries only if `SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE` is greater than UDC Test: SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE=UpsideDownCake m out/soong/mainline-sdks/art-module-host-exports-current.zip # verified that libartbase is in the generated Android.bp Test: m out/soong/mainline-sdks/art-module-host-exports-current.zip # verified that libartbase is not in the generated Android.bp Test: In `main`, deleted the host variants from prebuilts/module_sdk locally; enabled art prebuilts; Test: atest --host --no-bazel-mode libunwindstack_unit_test Bug: 329830257 Change-Id: Iab23853ef5e96661a5f5c2989add1be32fb07fbc
2321 lines
78 KiB
Go
2321 lines
78 KiB
Go
// Copyright (C) 2019 The Android Open Source Project
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package sdk
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"reflect"
|
|
"sort"
|
|
"strings"
|
|
|
|
"android/soong/apex"
|
|
"android/soong/cc"
|
|
"android/soong/java"
|
|
|
|
"github.com/google/blueprint"
|
|
"github.com/google/blueprint/proptools"
|
|
|
|
"android/soong/android"
|
|
)
|
|
|
|
// Environment variables that affect the generated snapshot
|
|
// ========================================================
|
|
//
|
|
// SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE
|
|
// This allows the target build release (i.e. the release version of the build within which
|
|
// the snapshot will be used) of the snapshot to be specified. If unspecified then it defaults
|
|
// to the current build release version. Otherwise, it must be the name of one of the build
|
|
// releases defined in nameToBuildRelease, e.g. S, T, etc..
|
|
//
|
|
// The generated snapshot must only be used in the specified target release. If the target
|
|
// build release is not the current build release then the generated Android.bp file not be
|
|
// checked for compatibility.
|
|
//
|
|
// e.g. if setting SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE=S will cause the generated snapshot
|
|
// to be compatible with S.
|
|
//
|
|
|
|
var pctx = android.NewPackageContext("android/soong/sdk")
|
|
|
|
var (
|
|
repackageZip = pctx.AndroidStaticRule("SnapshotRepackageZip",
|
|
blueprint.RuleParams{
|
|
Command: `${config.Zip2ZipCmd} -i $in -o $out -x META-INF/**/* "**/*:$destdir"`,
|
|
CommandDeps: []string{
|
|
"${config.Zip2ZipCmd}",
|
|
},
|
|
},
|
|
"destdir")
|
|
|
|
zipFiles = pctx.AndroidStaticRule("SnapshotZipFiles",
|
|
blueprint.RuleParams{
|
|
Command: `${config.SoongZipCmd} -C $basedir -r $out.rsp -o $out`,
|
|
CommandDeps: []string{
|
|
"${config.SoongZipCmd}",
|
|
},
|
|
Rspfile: "$out.rsp",
|
|
RspfileContent: "$in",
|
|
},
|
|
"basedir")
|
|
|
|
mergeZips = pctx.AndroidStaticRule("SnapshotMergeZips",
|
|
blueprint.RuleParams{
|
|
Command: `${config.MergeZipsCmd} -s $out $in`,
|
|
CommandDeps: []string{
|
|
"${config.MergeZipsCmd}",
|
|
},
|
|
})
|
|
)
|
|
|
|
const (
|
|
soongSdkSnapshotVersionCurrent = "current"
|
|
)
|
|
|
|
type generatedContents struct {
|
|
content strings.Builder
|
|
indentLevel int
|
|
}
|
|
|
|
func (gc *generatedContents) Indent() {
|
|
gc.indentLevel++
|
|
}
|
|
|
|
func (gc *generatedContents) Dedent() {
|
|
gc.indentLevel--
|
|
}
|
|
|
|
// IndentedPrintf will add spaces to indent the line to the appropriate level before printing the
|
|
// arguments.
|
|
func (gc *generatedContents) IndentedPrintf(format string, args ...interface{}) {
|
|
_, _ = fmt.Fprintf(&(gc.content), strings.Repeat(" ", gc.indentLevel)+format, args...)
|
|
}
|
|
|
|
// UnindentedPrintf does not add spaces to indent the line to the appropriate level before printing
|
|
// the arguments.
|
|
func (gc *generatedContents) UnindentedPrintf(format string, args ...interface{}) {
|
|
_, _ = fmt.Fprintf(&(gc.content), format, args...)
|
|
}
|
|
|
|
// Collect all the members.
|
|
//
|
|
// Updates the sdk module with a list of sdkMemberVariantDep instances and details as to which
|
|
// multilibs (32/64/both) are used by this sdk variant.
|
|
func (s *sdk) collectMembers(ctx android.ModuleContext) {
|
|
s.multilibUsages = multilibNone
|
|
ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
|
|
tag := ctx.OtherModuleDependencyTag(child)
|
|
if memberTag, ok := tag.(android.SdkMemberDependencyTag); ok {
|
|
memberType := memberTag.SdkMemberType(child)
|
|
|
|
// If a nil SdkMemberType was returned then this module should not be added to the sdk.
|
|
if memberType == nil {
|
|
return false
|
|
}
|
|
|
|
// Make sure that the resolved module is allowed in the member list property.
|
|
if !memberType.IsInstance(child) {
|
|
ctx.ModuleErrorf("module %q is not valid in property %s", ctx.OtherModuleName(child), memberType.SdkPropertyName())
|
|
}
|
|
|
|
// Keep track of which multilib variants are used by the sdk.
|
|
s.multilibUsages = s.multilibUsages.addArchType(child.Target().Arch.ArchType)
|
|
|
|
exportedComponentsInfo, _ := android.OtherModuleProvider(ctx, child, android.ExportedComponentsInfoProvider)
|
|
|
|
var container android.Module
|
|
if parent != ctx.Module() {
|
|
container = parent
|
|
}
|
|
|
|
minApiLevel := android.MinApiLevelForSdkSnapshot(ctx, child)
|
|
|
|
export := memberTag.ExportMember()
|
|
s.memberVariantDeps = append(s.memberVariantDeps, sdkMemberVariantDep{
|
|
sdkVariant: s,
|
|
memberType: memberType,
|
|
variant: child,
|
|
minApiLevel: minApiLevel,
|
|
container: container,
|
|
export: export,
|
|
exportedComponentsInfo: exportedComponentsInfo,
|
|
})
|
|
|
|
// Recurse down into the member's dependencies as it may have dependencies that need to be
|
|
// automatically added to the sdk.
|
|
return true
|
|
}
|
|
|
|
return false
|
|
})
|
|
}
|
|
|
|
// A denylist of modules whose host variants will be removed from the generated snapshots above the ApiLevel
|
|
// even if they are listed in the corresponding `sdk`.
|
|
// The key is the module name
|
|
// The value is the _last_ dessert where the host variant of the module will be present
|
|
// This is a workaround to ensure that these modules are generated in <=$ApiLevel, but not in in >=$ApiLevel
|
|
var ignoreHostModuleVariantsAboveDessert = map[string]android.ApiLevel{
|
|
// ignore host variant of libdexfile and its transitive dependencies.
|
|
// The platform test that depends on them (`libunwindstack_unit_test` at the time of writing)
|
|
// no longer requires a prebuilt variant of libdexfile.
|
|
"libdexfile": android.ApiLevelUpsideDownCake,
|
|
"libartpalette": android.ApiLevelUpsideDownCake,
|
|
"libartbase": android.ApiLevelUpsideDownCake,
|
|
}
|
|
|
|
// groupMemberVariantsByMemberThenType groups the member variant dependencies so that all the
|
|
// variants of each member are grouped together within an sdkMember instance.
|
|
//
|
|
// The sdkMember instances are then grouped into slices by member type. Within each such slice the
|
|
// sdkMember instances appear in the order they were added as dependencies.
|
|
//
|
|
// Finally, the member type slices are concatenated together to form a single slice. The order in
|
|
// which they are concatenated is the order in which the member types were registered in the
|
|
// android.SdkMemberTypesRegistry.
|
|
func (s *sdk) groupMemberVariantsByMemberThenType(ctx android.ModuleContext, targetBuildRelease *buildRelease, memberVariantDeps []sdkMemberVariantDep) []*sdkMember {
|
|
byType := make(map[android.SdkMemberType][]*sdkMember)
|
|
byName := make(map[string]*sdkMember)
|
|
|
|
for _, memberVariantDep := range memberVariantDeps {
|
|
memberType := memberVariantDep.memberType
|
|
variant := memberVariantDep.variant
|
|
|
|
name := ctx.OtherModuleName(variant)
|
|
targetApiLevel, err := android.ApiLevelFromUser(ctx, targetBuildRelease.name)
|
|
if err != nil {
|
|
targetApiLevel = android.FutureApiLevel
|
|
}
|
|
if lastApiLevel, exists := ignoreHostModuleVariantsAboveDessert[name]; exists && targetApiLevel.GreaterThan(lastApiLevel) && memberVariantDep.Host() {
|
|
// ignore host variant of this module if the targetApiLevel is V and above.
|
|
continue
|
|
}
|
|
member := byName[name]
|
|
if member == nil {
|
|
member = &sdkMember{memberType: memberType, name: name}
|
|
byName[name] = member
|
|
byType[memberType] = append(byType[memberType], member)
|
|
} else if member.memberType != memberType {
|
|
// validate whether this is the same member type or and overriding member type
|
|
if memberType.Overrides(member.memberType) {
|
|
member.memberType = memberType
|
|
} else if !member.memberType.Overrides(memberType) {
|
|
ctx.ModuleErrorf("Incompatible member types %q %q", member.memberType, memberType)
|
|
}
|
|
}
|
|
|
|
// Only append new variants to the list. This is needed because a member can be both
|
|
// exported by the sdk and also be a transitive sdk member.
|
|
member.variants = appendUniqueVariants(member.variants, variant)
|
|
}
|
|
var members []*sdkMember
|
|
for _, memberListProperty := range s.memberTypeListProperties() {
|
|
memberType := memberListProperty.memberType
|
|
|
|
if !isMemberTypeSupportedByTargetBuildRelease(memberType, targetBuildRelease) {
|
|
continue
|
|
}
|
|
|
|
membersOfType := byType[memberType]
|
|
members = append(members, membersOfType...)
|
|
}
|
|
|
|
return members
|
|
}
|
|
|
|
// isMemberTypeSupportedByTargetBuildRelease returns true if the member type is supported by the
|
|
// target build release.
|
|
func isMemberTypeSupportedByTargetBuildRelease(memberType android.SdkMemberType, targetBuildRelease *buildRelease) bool {
|
|
supportedByTargetBuildRelease := true
|
|
supportedBuildReleases := memberType.SupportedBuildReleases()
|
|
if supportedBuildReleases == "" {
|
|
supportedBuildReleases = "S+"
|
|
}
|
|
|
|
set, err := parseBuildReleaseSet(supportedBuildReleases)
|
|
if err != nil {
|
|
panic(fmt.Errorf("member type %s has invalid supported build releases %q: %s",
|
|
memberType.SdkPropertyName(), supportedBuildReleases, err))
|
|
}
|
|
if !set.contains(targetBuildRelease) {
|
|
supportedByTargetBuildRelease = false
|
|
}
|
|
return supportedByTargetBuildRelease
|
|
}
|
|
|
|
func appendUniqueVariants(variants []android.Module, newVariant android.Module) []android.Module {
|
|
for _, v := range variants {
|
|
if v == newVariant {
|
|
return variants
|
|
}
|
|
}
|
|
return append(variants, newVariant)
|
|
}
|
|
|
|
// BUILD_NUMBER_FILE is the name of the file in the snapshot zip that will contain the number of
|
|
// the build from which the snapshot was produced.
|
|
const BUILD_NUMBER_FILE = "snapshot-creation-build-number.txt"
|
|
|
|
// SDK directory structure
|
|
// <sdk_root>/
|
|
// Android.bp : definition of a 'sdk' module is here. This is a hand-made one.
|
|
// <api_ver>/ : below this directory are all auto-generated
|
|
// Android.bp : definition of 'sdk_snapshot' module is here
|
|
// aidl/
|
|
// frameworks/base/core/..../IFoo.aidl : an exported AIDL file
|
|
// java/
|
|
// <module_name>.jar : the stub jar for a java library 'module_name'
|
|
// include/
|
|
// bionic/libc/include/stdlib.h : an exported header file
|
|
// include_gen/
|
|
// <module_name>/com/android/.../IFoo.h : a generated header file
|
|
// <arch>/include/ : arch-specific exported headers
|
|
// <arch>/include_gen/ : arch-specific generated headers
|
|
// <arch>/lib/
|
|
// libFoo.so : a stub library
|
|
|
|
func (s sdk) targetBuildRelease(ctx android.ModuleContext) *buildRelease {
|
|
config := ctx.Config()
|
|
targetBuildReleaseEnv := config.GetenvWithDefault("SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE", buildReleaseCurrent.name)
|
|
targetBuildRelease, err := nameToRelease(targetBuildReleaseEnv)
|
|
if err != nil {
|
|
ctx.ModuleErrorf("invalid SOONG_SDK_SNAPSHOT_TARGET_BUILD_RELEASE: %s", err)
|
|
targetBuildRelease = buildReleaseCurrent
|
|
}
|
|
|
|
return targetBuildRelease
|
|
}
|
|
|
|
// buildSnapshot is the main function in this source file. It creates rules to copy
|
|
// the contents (header files, stub libraries, etc) into the zip file.
|
|
func (s *sdk) buildSnapshot(ctx android.ModuleContext, sdkVariants []*sdk) {
|
|
|
|
targetBuildRelease := s.targetBuildRelease(ctx)
|
|
targetApiLevel, err := android.ApiLevelFromUser(ctx, targetBuildRelease.name)
|
|
if err != nil {
|
|
targetApiLevel = android.FutureApiLevel
|
|
}
|
|
|
|
// Aggregate all the sdkMemberVariantDep instances from all the sdk variants.
|
|
hasLicenses := false
|
|
var memberVariantDeps []sdkMemberVariantDep
|
|
for _, sdkVariant := range sdkVariants {
|
|
memberVariantDeps = append(memberVariantDeps, sdkVariant.memberVariantDeps...)
|
|
}
|
|
|
|
// Filter out any sdkMemberVariantDep that is a component of another.
|
|
memberVariantDeps = filterOutComponents(ctx, memberVariantDeps)
|
|
|
|
// Record the names of all the members, both explicitly specified and implicitly included. Also,
|
|
// record the names of any members that should be excluded from this snapshot.
|
|
allMembersByName := make(map[string]struct{})
|
|
exportedMembersByName := make(map[string]struct{})
|
|
excludedMembersByName := make(map[string]struct{})
|
|
|
|
addMember := func(name string, export bool, exclude bool) {
|
|
if exclude {
|
|
excludedMembersByName[name] = struct{}{}
|
|
return
|
|
}
|
|
|
|
allMembersByName[name] = struct{}{}
|
|
if export {
|
|
exportedMembersByName[name] = struct{}{}
|
|
}
|
|
}
|
|
|
|
for _, memberVariantDep := range memberVariantDeps {
|
|
name := memberVariantDep.variant.Name()
|
|
export := memberVariantDep.export
|
|
|
|
// If the minApiLevel of the member is greater than the target API level then exclude it from
|
|
// this snapshot.
|
|
exclude := memberVariantDep.minApiLevel.GreaterThan(targetApiLevel)
|
|
// Always include host variants (e.g. host tools) in the snapshot.
|
|
// Host variants should not be guarded by a min_sdk_version check. In fact, host variants
|
|
// do not have a `min_sdk_version`.
|
|
if memberVariantDep.Host() {
|
|
exclude = false
|
|
}
|
|
|
|
addMember(name, export, exclude)
|
|
|
|
// Add any components provided by the module.
|
|
for _, component := range memberVariantDep.exportedComponentsInfo.Components {
|
|
addMember(component, export, exclude)
|
|
}
|
|
|
|
if memberVariantDep.memberType == android.LicenseModuleSdkMemberType {
|
|
hasLicenses = true
|
|
}
|
|
}
|
|
|
|
snapshotDir := android.PathForModuleOut(ctx, "snapshot")
|
|
|
|
bp := android.PathForModuleOut(ctx, "snapshot", "Android.bp")
|
|
|
|
bpFile := &bpFile{
|
|
modules: make(map[string]*bpModule),
|
|
}
|
|
|
|
// Always add -current to the end
|
|
snapshotFileSuffix := "-current"
|
|
|
|
builder := &snapshotBuilder{
|
|
ctx: ctx,
|
|
sdk: s,
|
|
snapshotDir: snapshotDir.OutputPath,
|
|
copies: make(map[string]string),
|
|
filesToZip: []android.Path{bp},
|
|
bpFile: bpFile,
|
|
prebuiltModules: make(map[string]*bpModule),
|
|
allMembersByName: allMembersByName,
|
|
exportedMembersByName: exportedMembersByName,
|
|
excludedMembersByName: excludedMembersByName,
|
|
targetBuildRelease: targetBuildRelease,
|
|
}
|
|
s.builderForTests = builder
|
|
|
|
// If the sdk snapshot includes any license modules then add a package module which has a
|
|
// default_applicable_licenses property. That will prevent the LSC license process from updating
|
|
// the generated Android.bp file to add a package module that includes all licenses used by all
|
|
// the modules in that package. That would be unnecessary as every module in the sdk should have
|
|
// their own licenses property specified.
|
|
if hasLicenses {
|
|
pkg := bpFile.newModule("package")
|
|
property := "default_applicable_licenses"
|
|
pkg.AddCommentForProperty(property, `
|
|
A default list here prevents the license LSC from adding its own list which would
|
|
be unnecessary as every module in the sdk already has its own licenses property.
|
|
`)
|
|
pkg.AddProperty(property, []string{"Android-Apache-2.0"})
|
|
bpFile.AddModule(pkg)
|
|
}
|
|
|
|
// Group the variants for each member module together and then group the members of each member
|
|
// type together.
|
|
members := s.groupMemberVariantsByMemberThenType(ctx, targetBuildRelease, memberVariantDeps)
|
|
|
|
// Create the prebuilt modules for each of the member modules.
|
|
traits := s.gatherTraits()
|
|
memberNames := []string{} // soong module names of the members. contains the prebuilt_ prefix.
|
|
for _, member := range members {
|
|
memberType := member.memberType
|
|
if !memberType.ArePrebuiltsRequired() {
|
|
continue
|
|
}
|
|
|
|
name := member.name
|
|
if _, ok := excludedMembersByName[name]; ok {
|
|
continue
|
|
}
|
|
|
|
requiredTraits := traits[name]
|
|
if requiredTraits == nil {
|
|
requiredTraits = android.EmptySdkMemberTraitSet()
|
|
}
|
|
|
|
// Create the snapshot for the member.
|
|
memberCtx := &memberContext{ctx, builder, memberType, name, requiredTraits}
|
|
|
|
prebuiltModule := memberType.AddPrebuiltModule(memberCtx, member)
|
|
s.createMemberSnapshot(memberCtx, member, prebuiltModule.(*bpModule))
|
|
|
|
if member.memberType != android.LicenseModuleSdkMemberType && !builder.isInternalMember(member.name) {
|
|
// More exceptions
|
|
// 1. Skip BCP and SCCP fragments
|
|
// 2. Skip non-sdk contents of BCP and SCCP fragments
|
|
//
|
|
// The non-sdk contents of BCP/SSCP fragments should only be used for dexpreopt and hiddenapi,
|
|
// and are not available to the rest of the build.
|
|
if android.InList(member.memberType,
|
|
[]android.SdkMemberType{
|
|
// bcp
|
|
java.BootclasspathFragmentSdkMemberType,
|
|
java.JavaBootLibsSdkMemberType,
|
|
// sscp
|
|
java.SystemServerClasspathFragmentSdkMemberType,
|
|
java.JavaSystemserverLibsSdkMemberType,
|
|
},
|
|
) {
|
|
continue
|
|
}
|
|
|
|
memberNames = append(memberNames, android.PrebuiltNameFromSource(member.name))
|
|
}
|
|
}
|
|
|
|
// create an apex_contributions_defaults for this module's sdk.
|
|
// this module type is supported in V and above.
|
|
if targetApiLevel.GreaterThan(android.ApiLevelUpsideDownCake) {
|
|
ac := newModule("apex_contributions_defaults")
|
|
ac.AddProperty("name", s.Name()+".contributions")
|
|
ac.AddProperty("contents", memberNames)
|
|
bpFile.AddModule(ac)
|
|
}
|
|
|
|
// Create a transformer that will transform a module by replacing any references
|
|
// to internal members with a unique module name and setting prefer: false.
|
|
snapshotTransformer := snapshotTransformation{
|
|
builder: builder,
|
|
}
|
|
|
|
for _, module := range builder.prebuiltOrder {
|
|
// Prune any empty property sets.
|
|
module = transformModule(module, pruneEmptySetTransformer{})
|
|
|
|
// Transform the module module to make it suitable for use in the snapshot.
|
|
module = transformModule(module, snapshotTransformer)
|
|
module = transformModule(module, emptyClasspathContentsTransformation{})
|
|
if module != nil {
|
|
bpFile.AddModule(module)
|
|
}
|
|
}
|
|
|
|
// generate Android.bp
|
|
contents := generateBpContents(bpFile)
|
|
// If the snapshot is being generated for the current build release then check the syntax to make
|
|
// sure that it is compatible.
|
|
if targetBuildRelease == buildReleaseCurrent {
|
|
syntaxCheckSnapshotBpFile(ctx, contents)
|
|
}
|
|
|
|
android.WriteFileRuleVerbatim(ctx, bp, contents)
|
|
|
|
// Copy the build number file into the snapshot.
|
|
builder.CopyToSnapshot(ctx.Config().BuildNumberFile(ctx), BUILD_NUMBER_FILE)
|
|
|
|
filesToZip := android.SortedUniquePaths(builder.filesToZip)
|
|
|
|
// zip them all
|
|
zipPath := fmt.Sprintf("%s%s.zip", ctx.ModuleName(), snapshotFileSuffix)
|
|
outputZipFile := android.PathForModuleOut(ctx, zipPath).OutputPath
|
|
outputDesc := "Building snapshot for " + ctx.ModuleName()
|
|
|
|
// If there are no zips to merge then generate the output zip directly.
|
|
// Otherwise, generate an intermediate zip file into which other zips can be
|
|
// merged.
|
|
var zipFile android.OutputPath
|
|
var desc string
|
|
if len(builder.zipsToMerge) == 0 {
|
|
zipFile = outputZipFile
|
|
desc = outputDesc
|
|
} else {
|
|
intermediatePath := fmt.Sprintf("%s%s.unmerged.zip", ctx.ModuleName(), snapshotFileSuffix)
|
|
zipFile = android.PathForModuleOut(ctx, intermediatePath).OutputPath
|
|
desc = "Building intermediate snapshot for " + ctx.ModuleName()
|
|
}
|
|
|
|
ctx.Build(pctx, android.BuildParams{
|
|
Description: desc,
|
|
Rule: zipFiles,
|
|
Inputs: filesToZip,
|
|
Output: zipFile,
|
|
Args: map[string]string{
|
|
"basedir": builder.snapshotDir.String(),
|
|
},
|
|
})
|
|
|
|
if len(builder.zipsToMerge) != 0 {
|
|
ctx.Build(pctx, android.BuildParams{
|
|
Description: outputDesc,
|
|
Rule: mergeZips,
|
|
Input: zipFile,
|
|
Inputs: android.SortedUniquePaths(builder.zipsToMerge),
|
|
Output: outputZipFile,
|
|
})
|
|
}
|
|
|
|
modules := s.generateInfoData(ctx, memberVariantDeps)
|
|
|
|
// Output the modules information as pretty printed JSON.
|
|
info := android.PathForModuleOut(ctx, fmt.Sprintf("%s%s.info", ctx.ModuleName(), snapshotFileSuffix))
|
|
output, err := json.MarshalIndent(modules, "", " ")
|
|
if err != nil {
|
|
ctx.ModuleErrorf("error generating %q: %s", info, err)
|
|
}
|
|
builder.infoContents = string(output)
|
|
android.WriteFileRuleVerbatim(ctx, info, builder.infoContents)
|
|
installedInfo := ctx.InstallFile(android.PathForMainlineSdksInstall(ctx), info.Base(), info)
|
|
s.infoFile = android.OptionalPathForPath(installedInfo)
|
|
|
|
// Install the zip, making sure that the info file has been installed as well.
|
|
installedZip := ctx.InstallFile(android.PathForMainlineSdksInstall(ctx), outputZipFile.Base(), outputZipFile, installedInfo)
|
|
s.snapshotFile = android.OptionalPathForPath(installedZip)
|
|
}
|
|
|
|
type moduleInfo struct {
|
|
// The type of the module, e.g. java_sdk_library
|
|
moduleType string
|
|
// The name of the module.
|
|
name string
|
|
// A list of additional dependencies of the module.
|
|
deps []string
|
|
// Additional member specific properties.
|
|
// These will be added into the generated JSON alongside the above properties.
|
|
memberSpecific map[string]interface{}
|
|
}
|
|
|
|
func (m *moduleInfo) MarshalJSON() ([]byte, error) {
|
|
buffer := bytes.Buffer{}
|
|
|
|
separator := ""
|
|
writeObjectPair := func(key string, value interface{}) {
|
|
buffer.WriteString(fmt.Sprintf("%s%q: ", separator, key))
|
|
b, err := json.Marshal(value)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
buffer.Write(b)
|
|
separator = ","
|
|
}
|
|
|
|
buffer.WriteString("{")
|
|
writeObjectPair("@type", m.moduleType)
|
|
writeObjectPair("@name", m.name)
|
|
if m.deps != nil {
|
|
writeObjectPair("@deps", m.deps)
|
|
}
|
|
for _, k := range android.SortedKeys(m.memberSpecific) {
|
|
v := m.memberSpecific[k]
|
|
writeObjectPair(k, v)
|
|
}
|
|
buffer.WriteString("}")
|
|
return buffer.Bytes(), nil
|
|
}
|
|
|
|
var _ json.Marshaler = (*moduleInfo)(nil)
|
|
|
|
// generateInfoData creates a list of moduleInfo structures that will be marshalled into JSON.
|
|
func (s *sdk) generateInfoData(ctx android.ModuleContext, memberVariantDeps []sdkMemberVariantDep) interface{} {
|
|
modules := []*moduleInfo{}
|
|
sdkInfo := moduleInfo{
|
|
moduleType: "sdk",
|
|
name: ctx.ModuleName(),
|
|
memberSpecific: map[string]interface{}{},
|
|
}
|
|
modules = append(modules, &sdkInfo)
|
|
|
|
name2Info := map[string]*moduleInfo{}
|
|
getModuleInfo := func(module android.Module) *moduleInfo {
|
|
name := module.Name()
|
|
info := name2Info[name]
|
|
if info == nil {
|
|
moduleType := ctx.OtherModuleType(module)
|
|
// Remove any suffix added when creating modules dynamically.
|
|
moduleType = strings.Split(moduleType, "__")[0]
|
|
info = &moduleInfo{
|
|
moduleType: moduleType,
|
|
name: name,
|
|
}
|
|
|
|
additionalSdkInfo, _ := android.OtherModuleProvider(ctx, module, android.AdditionalSdkInfoProvider)
|
|
info.memberSpecific = additionalSdkInfo.Properties
|
|
|
|
name2Info[name] = info
|
|
}
|
|
return info
|
|
}
|
|
|
|
for _, memberVariantDep := range memberVariantDeps {
|
|
propertyName := memberVariantDep.memberType.SdkPropertyName()
|
|
var list []string
|
|
if v, ok := sdkInfo.memberSpecific[propertyName]; ok {
|
|
list = v.([]string)
|
|
}
|
|
|
|
memberName := memberVariantDep.variant.Name()
|
|
list = append(list, memberName)
|
|
sdkInfo.memberSpecific[propertyName] = android.SortedUniqueStrings(list)
|
|
|
|
if memberVariantDep.container != nil {
|
|
containerInfo := getModuleInfo(memberVariantDep.container)
|
|
containerInfo.deps = android.SortedUniqueStrings(append(containerInfo.deps, memberName))
|
|
}
|
|
|
|
// Make sure that the module info is created for each module.
|
|
getModuleInfo(memberVariantDep.variant)
|
|
}
|
|
|
|
for _, memberName := range android.SortedKeys(name2Info) {
|
|
info := name2Info[memberName]
|
|
modules = append(modules, info)
|
|
}
|
|
|
|
return modules
|
|
}
|
|
|
|
// filterOutComponents removes any item from the deps list that is a component of another item in
|
|
// the deps list, e.g. if the deps list contains "foo" and "foo.stubs" which is component of "foo"
|
|
// then it will remove "foo.stubs" from the deps.
|
|
func filterOutComponents(ctx android.ModuleContext, deps []sdkMemberVariantDep) []sdkMemberVariantDep {
|
|
// Collate the set of components that all the modules added to the sdk provide.
|
|
components := map[string]*sdkMemberVariantDep{}
|
|
for i := range deps {
|
|
dep := &deps[i]
|
|
for _, c := range dep.exportedComponentsInfo.Components {
|
|
components[c] = dep
|
|
}
|
|
}
|
|
|
|
// If no module provides components then return the input deps unfiltered.
|
|
if len(components) == 0 {
|
|
return deps
|
|
}
|
|
|
|
filtered := make([]sdkMemberVariantDep, 0, len(deps))
|
|
for _, dep := range deps {
|
|
name := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(dep.variant))
|
|
if owner, ok := components[name]; ok {
|
|
// This is a component of another module that is a member of the sdk.
|
|
|
|
// If the component is exported but the owning module is not then the configuration is not
|
|
// supported.
|
|
if dep.export && !owner.export {
|
|
ctx.ModuleErrorf("Module %s is internal to the SDK but provides component %s which is used outside the SDK")
|
|
continue
|
|
}
|
|
|
|
// This module must not be added to the list of members of the sdk as that would result in a
|
|
// duplicate module in the sdk snapshot.
|
|
continue
|
|
}
|
|
|
|
filtered = append(filtered, dep)
|
|
}
|
|
return filtered
|
|
}
|
|
|
|
// Check the syntax of the generated Android.bp file contents and if they are
|
|
// invalid then log an error with the contents (tagged with line numbers) and the
|
|
// errors that were found so that it is easy to see where the problem lies.
|
|
func syntaxCheckSnapshotBpFile(ctx android.ModuleContext, contents string) {
|
|
errs := android.CheckBlueprintSyntax(ctx, "Android.bp", contents)
|
|
if len(errs) != 0 {
|
|
message := &strings.Builder{}
|
|
_, _ = fmt.Fprint(message, `errors in generated Android.bp snapshot:
|
|
|
|
Generated Android.bp contents
|
|
========================================================================
|
|
`)
|
|
for i, line := range strings.Split(contents, "\n") {
|
|
_, _ = fmt.Fprintf(message, "%6d: %s\n", i+1, line)
|
|
}
|
|
|
|
_, _ = fmt.Fprint(message, `
|
|
========================================================================
|
|
|
|
Errors found:
|
|
`)
|
|
|
|
for _, err := range errs {
|
|
_, _ = fmt.Fprintf(message, "%s\n", err.Error())
|
|
}
|
|
|
|
ctx.ModuleErrorf("%s", message.String())
|
|
}
|
|
}
|
|
|
|
func extractCommonProperties(ctx android.ModuleContext, extractor *commonValueExtractor, commonProperties interface{}, inputPropertiesSlice interface{}) {
|
|
err := extractor.extractCommonProperties(commonProperties, inputPropertiesSlice)
|
|
if err != nil {
|
|
ctx.ModuleErrorf("error extracting common properties: %s", err)
|
|
}
|
|
}
|
|
|
|
type propertyTag struct {
|
|
name string
|
|
}
|
|
|
|
var _ android.BpPropertyTag = propertyTag{}
|
|
|
|
// BpPropertyTag instances to add to a property that contains references to other sdk members.
|
|
//
|
|
// These will ensure that the referenced modules are available, if required.
|
|
var requiredSdkMemberReferencePropertyTag = propertyTag{"requiredSdkMemberReferencePropertyTag"}
|
|
var optionalSdkMemberReferencePropertyTag = propertyTag{"optionalSdkMemberReferencePropertyTag"}
|
|
|
|
type snapshotTransformation struct {
|
|
identityTransformation
|
|
builder *snapshotBuilder
|
|
}
|
|
|
|
func (t snapshotTransformation) transformModule(module *bpModule) *bpModule {
|
|
if module != nil {
|
|
// If the module is an internal member then use a unique name for it.
|
|
name := module.Name()
|
|
module.setProperty("name", t.builder.snapshotSdkMemberName(name, true))
|
|
}
|
|
return module
|
|
}
|
|
|
|
func (t snapshotTransformation) transformProperty(_ string, value interface{}, tag android.BpPropertyTag) (interface{}, android.BpPropertyTag) {
|
|
if tag == requiredSdkMemberReferencePropertyTag || tag == optionalSdkMemberReferencePropertyTag {
|
|
required := tag == requiredSdkMemberReferencePropertyTag
|
|
return t.builder.snapshotSdkMemberNames(value.([]string), required), tag
|
|
} else {
|
|
return value, tag
|
|
}
|
|
}
|
|
|
|
type emptyClasspathContentsTransformation struct {
|
|
identityTransformation
|
|
}
|
|
|
|
func (t emptyClasspathContentsTransformation) transformModule(module *bpModule) *bpModule {
|
|
classpathModuleTypes := []string{
|
|
"prebuilt_bootclasspath_fragment",
|
|
"prebuilt_systemserverclasspath_fragment",
|
|
}
|
|
if module != nil && android.InList(module.moduleType, classpathModuleTypes) {
|
|
if contents, ok := module.bpPropertySet.properties["contents"].([]string); ok {
|
|
if len(contents) == 0 {
|
|
return nil
|
|
}
|
|
}
|
|
}
|
|
return module
|
|
}
|
|
|
|
type pruneEmptySetTransformer struct {
|
|
identityTransformation
|
|
}
|
|
|
|
var _ bpTransformer = (*pruneEmptySetTransformer)(nil)
|
|
|
|
func (t pruneEmptySetTransformer) transformPropertySetAfterContents(_ string, propertySet *bpPropertySet, tag android.BpPropertyTag) (*bpPropertySet, android.BpPropertyTag) {
|
|
if len(propertySet.properties) == 0 {
|
|
return nil, nil
|
|
} else {
|
|
return propertySet, tag
|
|
}
|
|
}
|
|
|
|
func generateBpContents(bpFile *bpFile) string {
|
|
contents := &generatedContents{}
|
|
contents.IndentedPrintf("// This is auto-generated. DO NOT EDIT.\n")
|
|
for _, bpModule := range bpFile.order {
|
|
contents.IndentedPrintf("\n")
|
|
contents.IndentedPrintf("%s {\n", bpModule.moduleType)
|
|
outputPropertySet(contents, bpModule.bpPropertySet)
|
|
contents.IndentedPrintf("}\n")
|
|
}
|
|
return contents.content.String()
|
|
}
|
|
|
|
func outputPropertySet(contents *generatedContents, set *bpPropertySet) {
|
|
contents.Indent()
|
|
|
|
addComment := func(name string) {
|
|
if text, ok := set.comments[name]; ok {
|
|
for _, line := range strings.Split(text, "\n") {
|
|
contents.IndentedPrintf("// %s\n", line)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Output the properties first, followed by the nested sets. This ensures a
|
|
// consistent output irrespective of whether property sets are created before
|
|
// or after the properties. This simplifies the creation of the module.
|
|
for _, name := range set.order {
|
|
value := set.getValue(name)
|
|
|
|
// Do not write property sets in the properties phase.
|
|
if _, ok := value.(*bpPropertySet); ok {
|
|
continue
|
|
}
|
|
|
|
addComment(name)
|
|
reflectValue := reflect.ValueOf(value)
|
|
outputNamedValue(contents, name, reflectValue)
|
|
}
|
|
|
|
for _, name := range set.order {
|
|
value := set.getValue(name)
|
|
|
|
// Only write property sets in the sets phase.
|
|
switch v := value.(type) {
|
|
case *bpPropertySet:
|
|
addComment(name)
|
|
contents.IndentedPrintf("%s: {\n", name)
|
|
outputPropertySet(contents, v)
|
|
contents.IndentedPrintf("},\n")
|
|
}
|
|
}
|
|
|
|
contents.Dedent()
|
|
}
|
|
|
|
// outputNamedValue outputs a value that has an associated name. The name will be indented, followed
|
|
// by the value and then followed by a , and a newline.
|
|
func outputNamedValue(contents *generatedContents, name string, value reflect.Value) {
|
|
contents.IndentedPrintf("%s: ", name)
|
|
outputUnnamedValue(contents, value)
|
|
contents.UnindentedPrintf(",\n")
|
|
}
|
|
|
|
// outputUnnamedValue outputs a single value. The value is not indented and is not followed by
|
|
// either a , or a newline. With multi-line values, e.g. slices, all but the first line will be
|
|
// indented and all but the last line will end with a newline.
|
|
func outputUnnamedValue(contents *generatedContents, value reflect.Value) {
|
|
valueType := value.Type()
|
|
switch valueType.Kind() {
|
|
case reflect.Bool:
|
|
contents.UnindentedPrintf("%t", value.Bool())
|
|
|
|
case reflect.String:
|
|
contents.UnindentedPrintf("%q", value)
|
|
|
|
case reflect.Ptr:
|
|
outputUnnamedValue(contents, value.Elem())
|
|
|
|
case reflect.Slice:
|
|
length := value.Len()
|
|
if length == 0 {
|
|
contents.UnindentedPrintf("[]")
|
|
} else {
|
|
firstValue := value.Index(0)
|
|
if length == 1 && !multiLineValue(firstValue) {
|
|
contents.UnindentedPrintf("[")
|
|
outputUnnamedValue(contents, firstValue)
|
|
contents.UnindentedPrintf("]")
|
|
} else {
|
|
contents.UnindentedPrintf("[\n")
|
|
contents.Indent()
|
|
for i := 0; i < length; i++ {
|
|
itemValue := value.Index(i)
|
|
contents.IndentedPrintf("")
|
|
outputUnnamedValue(contents, itemValue)
|
|
contents.UnindentedPrintf(",\n")
|
|
}
|
|
contents.Dedent()
|
|
contents.IndentedPrintf("]")
|
|
}
|
|
}
|
|
|
|
case reflect.Struct:
|
|
// Avoid unlimited recursion by requiring every structure to implement android.BpPrintable.
|
|
v := value.Interface()
|
|
if _, ok := v.(android.BpPrintable); !ok {
|
|
panic(fmt.Errorf("property value %#v of type %T does not implement android.BpPrintable", v, v))
|
|
}
|
|
contents.UnindentedPrintf("{\n")
|
|
contents.Indent()
|
|
for f := 0; f < valueType.NumField(); f++ {
|
|
fieldType := valueType.Field(f)
|
|
if fieldType.Anonymous {
|
|
continue
|
|
}
|
|
fieldValue := value.Field(f)
|
|
fieldName := fieldType.Name
|
|
propertyName := proptools.PropertyNameForField(fieldName)
|
|
outputNamedValue(contents, propertyName, fieldValue)
|
|
}
|
|
contents.Dedent()
|
|
contents.IndentedPrintf("}")
|
|
|
|
default:
|
|
panic(fmt.Errorf("unknown type: %T of value %#v", value, value))
|
|
}
|
|
}
|
|
|
|
// multiLineValue returns true if the supplied value may require multiple lines in the output.
|
|
func multiLineValue(value reflect.Value) bool {
|
|
kind := value.Kind()
|
|
return kind == reflect.Slice || kind == reflect.Struct
|
|
}
|
|
|
|
func (s *sdk) GetAndroidBpContentsForTests() string {
|
|
return generateBpContents(s.builderForTests.bpFile)
|
|
}
|
|
|
|
func (s *sdk) GetInfoContentsForTests() string {
|
|
return s.builderForTests.infoContents
|
|
}
|
|
|
|
type snapshotBuilder struct {
|
|
ctx android.ModuleContext
|
|
sdk *sdk
|
|
|
|
snapshotDir android.OutputPath
|
|
bpFile *bpFile
|
|
|
|
// Map from destination to source of each copy - used to eliminate duplicates and
|
|
// detect conflicts.
|
|
copies map[string]string
|
|
|
|
filesToZip android.Paths
|
|
zipsToMerge android.Paths
|
|
|
|
// The path to an empty file.
|
|
emptyFile android.WritablePath
|
|
|
|
prebuiltModules map[string]*bpModule
|
|
prebuiltOrder []*bpModule
|
|
|
|
// The set of all members by name.
|
|
allMembersByName map[string]struct{}
|
|
|
|
// The set of exported members by name.
|
|
exportedMembersByName map[string]struct{}
|
|
|
|
// The set of members which have been excluded from this snapshot; by name.
|
|
excludedMembersByName map[string]struct{}
|
|
|
|
// The target build release for which the snapshot is to be generated.
|
|
targetBuildRelease *buildRelease
|
|
|
|
// The contents of the .info file that describes the sdk contents.
|
|
infoContents string
|
|
}
|
|
|
|
func (s *snapshotBuilder) CopyToSnapshot(src android.Path, dest string) {
|
|
if existing, ok := s.copies[dest]; ok {
|
|
if existing != src.String() {
|
|
s.ctx.ModuleErrorf("conflicting copy, %s copied from both %s and %s", dest, existing, src)
|
|
return
|
|
}
|
|
} else {
|
|
path := s.snapshotDir.Join(s.ctx, dest)
|
|
s.ctx.Build(pctx, android.BuildParams{
|
|
Rule: android.Cp,
|
|
Input: src,
|
|
Output: path,
|
|
})
|
|
s.filesToZip = append(s.filesToZip, path)
|
|
|
|
s.copies[dest] = src.String()
|
|
}
|
|
}
|
|
|
|
func (s *snapshotBuilder) UnzipToSnapshot(zipPath android.Path, destDir string) {
|
|
ctx := s.ctx
|
|
|
|
// Repackage the zip file so that the entries are in the destDir directory.
|
|
// This will allow the zip file to be merged into the snapshot.
|
|
tmpZipPath := android.PathForModuleOut(ctx, "tmp", destDir+".zip").OutputPath
|
|
|
|
ctx.Build(pctx, android.BuildParams{
|
|
Description: "Repackaging zip file " + destDir + " for snapshot " + ctx.ModuleName(),
|
|
Rule: repackageZip,
|
|
Input: zipPath,
|
|
Output: tmpZipPath,
|
|
Args: map[string]string{
|
|
"destdir": destDir,
|
|
},
|
|
})
|
|
|
|
// Add the repackaged zip file to the files to merge.
|
|
s.zipsToMerge = append(s.zipsToMerge, tmpZipPath)
|
|
}
|
|
|
|
func (s *snapshotBuilder) EmptyFile() android.Path {
|
|
if s.emptyFile == nil {
|
|
ctx := s.ctx
|
|
s.emptyFile = android.PathForModuleOut(ctx, "empty")
|
|
s.ctx.Build(pctx, android.BuildParams{
|
|
Rule: android.Touch,
|
|
Output: s.emptyFile,
|
|
})
|
|
}
|
|
|
|
return s.emptyFile
|
|
}
|
|
|
|
func (s *snapshotBuilder) AddPrebuiltModule(member android.SdkMember, moduleType string) android.BpModule {
|
|
name := member.Name()
|
|
if s.prebuiltModules[name] != nil {
|
|
panic(fmt.Sprintf("Duplicate module detected, module %s has already been added", name))
|
|
}
|
|
|
|
m := s.bpFile.newModule(moduleType)
|
|
m.AddProperty("name", name)
|
|
|
|
variant := member.Variants()[0]
|
|
|
|
if s.isInternalMember(name) {
|
|
// An internal member is only referenced from the sdk snapshot which is in the
|
|
// same package so can be marked as private.
|
|
m.AddProperty("visibility", []string{"//visibility:private"})
|
|
} else {
|
|
// Extract visibility information from a member variant. All variants have the same
|
|
// visibility so it doesn't matter which one is used.
|
|
visibilityRules := android.EffectiveVisibilityRules(s.ctx, variant)
|
|
|
|
// Add any additional visibility rules needed for the prebuilts to reference each other.
|
|
err := visibilityRules.Widen(s.sdk.properties.Prebuilt_visibility)
|
|
if err != nil {
|
|
s.ctx.PropertyErrorf("prebuilt_visibility", "%s", err)
|
|
}
|
|
|
|
visibility := visibilityRules.Strings()
|
|
if len(visibility) != 0 {
|
|
m.AddProperty("visibility", visibility)
|
|
}
|
|
}
|
|
|
|
// Where available copy apex_available properties from the member.
|
|
if apexAware, ok := variant.(interface{ ApexAvailable() []string }); ok {
|
|
apexAvailable := apexAware.ApexAvailable()
|
|
if len(apexAvailable) == 0 {
|
|
// //apex_available:platform is the default.
|
|
apexAvailable = []string{android.AvailableToPlatform}
|
|
}
|
|
|
|
// Add in any baseline apex available settings.
|
|
apexAvailable = append(apexAvailable, apex.BaselineApexAvailable(member.Name())...)
|
|
|
|
// Remove duplicates and sort.
|
|
apexAvailable = android.FirstUniqueStrings(apexAvailable)
|
|
sort.Strings(apexAvailable)
|
|
|
|
m.AddProperty("apex_available", apexAvailable)
|
|
}
|
|
|
|
// The licenses are the same for all variants.
|
|
mctx := s.ctx
|
|
licenseInfo, _ := android.OtherModuleProvider(mctx, variant, android.LicenseInfoProvider)
|
|
if len(licenseInfo.Licenses) > 0 {
|
|
m.AddPropertyWithTag("licenses", licenseInfo.Licenses, s.OptionalSdkMemberReferencePropertyTag())
|
|
}
|
|
|
|
deviceSupported := false
|
|
hostSupported := false
|
|
|
|
for _, variant := range member.Variants() {
|
|
osClass := variant.Target().Os.Class
|
|
if osClass == android.Host {
|
|
hostSupported = true
|
|
} else if osClass == android.Device {
|
|
deviceSupported = true
|
|
}
|
|
}
|
|
|
|
addHostDeviceSupportedProperties(deviceSupported, hostSupported, m)
|
|
|
|
s.prebuiltModules[name] = m
|
|
s.prebuiltOrder = append(s.prebuiltOrder, m)
|
|
return m
|
|
}
|
|
|
|
func addHostDeviceSupportedProperties(deviceSupported bool, hostSupported bool, bpModule *bpModule) {
|
|
// If neither device or host is supported then this module does not support either so will not
|
|
// recognize the properties.
|
|
if !deviceSupported && !hostSupported {
|
|
return
|
|
}
|
|
|
|
if !deviceSupported {
|
|
bpModule.AddProperty("device_supported", false)
|
|
}
|
|
if hostSupported {
|
|
bpModule.AddProperty("host_supported", true)
|
|
}
|
|
}
|
|
|
|
func (s *snapshotBuilder) SdkMemberReferencePropertyTag(required bool) android.BpPropertyTag {
|
|
if required {
|
|
return requiredSdkMemberReferencePropertyTag
|
|
} else {
|
|
return optionalSdkMemberReferencePropertyTag
|
|
}
|
|
}
|
|
|
|
func (s *snapshotBuilder) OptionalSdkMemberReferencePropertyTag() android.BpPropertyTag {
|
|
return optionalSdkMemberReferencePropertyTag
|
|
}
|
|
|
|
// Get a name for sdk snapshot member. If the member is private then generate a snapshot specific
|
|
// name. As part of the processing this checks to make sure that any required members are part of
|
|
// the snapshot.
|
|
func (s *snapshotBuilder) snapshotSdkMemberName(name string, required bool) string {
|
|
if _, ok := s.allMembersByName[name]; !ok {
|
|
if required {
|
|
s.ctx.ModuleErrorf("Required member reference %s is not a member of the sdk", name)
|
|
}
|
|
return name
|
|
}
|
|
|
|
if s.isInternalMember(name) {
|
|
return s.ctx.ModuleName() + "_" + name
|
|
} else {
|
|
return name
|
|
}
|
|
}
|
|
|
|
func (s *snapshotBuilder) snapshotSdkMemberNames(members []string, required bool) []string {
|
|
var references []string = nil
|
|
for _, m := range members {
|
|
if _, ok := s.excludedMembersByName[m]; ok {
|
|
continue
|
|
}
|
|
references = append(references, s.snapshotSdkMemberName(m, required))
|
|
}
|
|
return references
|
|
}
|
|
|
|
func (s *snapshotBuilder) isInternalMember(memberName string) bool {
|
|
_, ok := s.exportedMembersByName[memberName]
|
|
return !ok
|
|
}
|
|
|
|
// Add the properties from the given SdkMemberProperties to the blueprint
|
|
// property set. This handles common properties in SdkMemberPropertiesBase and
|
|
// calls the member-specific AddToPropertySet for the rest.
|
|
func addSdkMemberPropertiesToSet(ctx *memberContext, memberProperties android.SdkMemberProperties, targetPropertySet android.BpPropertySet) {
|
|
if memberProperties.Base().Compile_multilib != "" {
|
|
targetPropertySet.AddProperty("compile_multilib", memberProperties.Base().Compile_multilib)
|
|
}
|
|
|
|
memberProperties.AddToPropertySet(ctx, targetPropertySet)
|
|
}
|
|
|
|
// sdkMemberVariantDep represents a dependency from an sdk variant onto a member variant.
|
|
type sdkMemberVariantDep struct {
|
|
// The sdk variant that depends (possibly indirectly) on the member variant.
|
|
sdkVariant *sdk
|
|
|
|
// The type of sdk member the variant is to be treated as.
|
|
memberType android.SdkMemberType
|
|
|
|
// The variant that is added to the sdk.
|
|
variant android.Module
|
|
|
|
// The optional container of this member, i.e. the module that is depended upon by the sdk
|
|
// (possibly transitively) and whose dependency on this module is why it was added to the sdk.
|
|
// Is nil if this a direct dependency of the sdk.
|
|
container android.Module
|
|
|
|
// True if the member should be exported, i.e. accessible, from outside the sdk.
|
|
export bool
|
|
|
|
// The names of additional component modules provided by the variant.
|
|
exportedComponentsInfo android.ExportedComponentsInfo
|
|
|
|
// The minimum API level on which this module is supported.
|
|
minApiLevel android.ApiLevel
|
|
}
|
|
|
|
// Host returns true if the sdk member is a host variant (e.g. host tool)
|
|
func (s *sdkMemberVariantDep) Host() bool {
|
|
return s.variant.Target().Os.Class == android.Host
|
|
}
|
|
|
|
var _ android.SdkMember = (*sdkMember)(nil)
|
|
|
|
// sdkMember groups all the variants of a specific member module together along with the name of the
|
|
// module and the member type. This is used to generate the prebuilt modules for a specific member.
|
|
type sdkMember struct {
|
|
memberType android.SdkMemberType
|
|
name string
|
|
variants []android.Module
|
|
}
|
|
|
|
func (m *sdkMember) Name() string {
|
|
return m.name
|
|
}
|
|
|
|
func (m *sdkMember) Variants() []android.Module {
|
|
return m.variants
|
|
}
|
|
|
|
// Track usages of multilib variants.
|
|
type multilibUsage int
|
|
|
|
const (
|
|
multilibNone multilibUsage = 0
|
|
multilib32 multilibUsage = 1
|
|
multilib64 multilibUsage = 2
|
|
multilibBoth = multilib32 | multilib64
|
|
)
|
|
|
|
// Add the multilib that is used in the arch type.
|
|
func (m multilibUsage) addArchType(archType android.ArchType) multilibUsage {
|
|
multilib := archType.Multilib
|
|
switch multilib {
|
|
case "":
|
|
return m
|
|
case "lib32":
|
|
return m | multilib32
|
|
case "lib64":
|
|
return m | multilib64
|
|
default:
|
|
panic(fmt.Errorf("unknown Multilib field in ArchType, expected 'lib32' or 'lib64', found %q", multilib))
|
|
}
|
|
}
|
|
|
|
func (m multilibUsage) String() string {
|
|
switch m {
|
|
case multilibNone:
|
|
return ""
|
|
case multilib32:
|
|
return "32"
|
|
case multilib64:
|
|
return "64"
|
|
case multilibBoth:
|
|
return "both"
|
|
default:
|
|
panic(fmt.Errorf("unknown multilib value, found %b, expected one of %b, %b, %b or %b",
|
|
m, multilibNone, multilib32, multilib64, multilibBoth))
|
|
}
|
|
}
|
|
|
|
// TODO(187910671): BEGIN - Remove once modules do not have an APEX and default variant.
|
|
// variantCoordinate contains the coordinates used to identify a variant of an SDK member.
|
|
type variantCoordinate struct {
|
|
// osType identifies the OS target of a variant.
|
|
osType android.OsType
|
|
// archId identifies the architecture and whether it is for the native bridge.
|
|
archId archId
|
|
// image is the image variant name.
|
|
image string
|
|
// linkType is the link type name.
|
|
linkType string
|
|
}
|
|
|
|
func getVariantCoordinate(ctx *memberContext, variant android.Module) variantCoordinate {
|
|
linkType := ""
|
|
if len(ctx.MemberType().SupportedLinkages()) > 0 {
|
|
linkType = getLinkType(variant)
|
|
}
|
|
return variantCoordinate{
|
|
osType: variant.Target().Os,
|
|
archId: archIdFromTarget(variant.Target()),
|
|
image: variant.ImageVariation().Variation,
|
|
linkType: linkType,
|
|
}
|
|
}
|
|
|
|
// selectApexVariantsWhereAvailable filters the input list of variants by selecting the APEX
|
|
// specific variant for a specific variantCoordinate when there is both an APEX and default variant.
|
|
//
|
|
// There is a long-standing issue where a module that is added to an APEX has both an APEX and
|
|
// default/platform variant created even when the module does not require a platform variant. As a
|
|
// result an indirect dependency onto a module via the APEX will use the APEX variant, whereas a
|
|
// direct dependency onto the module will use the default/platform variant. That would result in a
|
|
// failure while attempting to optimize the properties for a member as it would have two variants
|
|
// when only one was expected.
|
|
//
|
|
// This function mitigates that problem by detecting when there are two variants that differ only
|
|
// by apex variant, where one is the default/platform variant and one is the APEX variant. In that
|
|
// case it picks the APEX variant. It picks the APEX variant because that is the behavior that would
|
|
// be expected
|
|
func selectApexVariantsWhereAvailable(ctx *memberContext, variants []android.Module) []android.Module {
|
|
moduleCtx := ctx.sdkMemberContext
|
|
|
|
// Group the variants by coordinates.
|
|
variantsByCoord := make(map[variantCoordinate][]android.Module)
|
|
for _, variant := range variants {
|
|
coord := getVariantCoordinate(ctx, variant)
|
|
variantsByCoord[coord] = append(variantsByCoord[coord], variant)
|
|
}
|
|
|
|
toDiscard := make(map[android.Module]struct{})
|
|
for coord, list := range variantsByCoord {
|
|
count := len(list)
|
|
if count == 1 {
|
|
continue
|
|
}
|
|
|
|
variantsByApex := make(map[string]android.Module)
|
|
conflictDetected := false
|
|
for _, variant := range list {
|
|
apexInfo, _ := android.OtherModuleProvider(moduleCtx, variant, android.ApexInfoProvider)
|
|
apexVariationName := apexInfo.ApexVariationName
|
|
// If there are two variants for a specific APEX variation then there is conflict.
|
|
if _, ok := variantsByApex[apexVariationName]; ok {
|
|
conflictDetected = true
|
|
break
|
|
}
|
|
variantsByApex[apexVariationName] = variant
|
|
}
|
|
|
|
// If there are more than 2 apex variations or one of the apex variations is not the
|
|
// default/platform variation then there is a conflict.
|
|
if len(variantsByApex) != 2 {
|
|
conflictDetected = true
|
|
} else if _, ok := variantsByApex[""]; !ok {
|
|
conflictDetected = true
|
|
}
|
|
|
|
// If there are no conflicts then add the default/platform variation to the list to remove.
|
|
if !conflictDetected {
|
|
toDiscard[variantsByApex[""]] = struct{}{}
|
|
continue
|
|
}
|
|
|
|
// There are duplicate variants at this coordinate and they are not the default and APEX variant
|
|
// so fail.
|
|
variantDescriptions := []string{}
|
|
for _, m := range list {
|
|
variantDescriptions = append(variantDescriptions, fmt.Sprintf(" %s", m.String()))
|
|
}
|
|
|
|
moduleCtx.ModuleErrorf("multiple conflicting variants detected for OsType{%s}, %s, Image{%s}, Link{%s}\n%s",
|
|
coord.osType, coord.archId.String(), coord.image, coord.linkType,
|
|
strings.Join(variantDescriptions, "\n"))
|
|
}
|
|
|
|
// If there are any variants to discard then remove them from the list of variants, while
|
|
// preserving the order.
|
|
if len(toDiscard) > 0 {
|
|
filtered := []android.Module{}
|
|
for _, variant := range variants {
|
|
if _, ok := toDiscard[variant]; !ok {
|
|
filtered = append(filtered, variant)
|
|
}
|
|
}
|
|
variants = filtered
|
|
}
|
|
|
|
return variants
|
|
}
|
|
|
|
// TODO(187910671): END - Remove once modules do not have an APEX and default variant.
|
|
|
|
type baseInfo struct {
|
|
Properties android.SdkMemberProperties
|
|
}
|
|
|
|
func (b *baseInfo) optimizableProperties() interface{} {
|
|
return b.Properties
|
|
}
|
|
|
|
type osTypeSpecificInfo struct {
|
|
baseInfo
|
|
|
|
osType android.OsType
|
|
|
|
// The list of arch type specific info for this os type.
|
|
//
|
|
// Nil if there is one variant whose arch type is common
|
|
archInfos []*archTypeSpecificInfo
|
|
}
|
|
|
|
var _ propertiesContainer = (*osTypeSpecificInfo)(nil)
|
|
|
|
type variantPropertiesFactoryFunc func() android.SdkMemberProperties
|
|
|
|
// Create a new osTypeSpecificInfo for the specified os type and its properties
|
|
// structures populated with information from the variants.
|
|
func newOsTypeSpecificInfo(ctx android.SdkMemberContext, osType android.OsType, variantPropertiesFactory variantPropertiesFactoryFunc, osTypeVariants []android.Module) *osTypeSpecificInfo {
|
|
osInfo := &osTypeSpecificInfo{
|
|
osType: osType,
|
|
}
|
|
|
|
osSpecificVariantPropertiesFactory := func() android.SdkMemberProperties {
|
|
properties := variantPropertiesFactory()
|
|
properties.Base().Os = osType
|
|
return properties
|
|
}
|
|
|
|
// Create a structure into which properties common across the architectures in
|
|
// this os type will be stored.
|
|
osInfo.Properties = osSpecificVariantPropertiesFactory()
|
|
|
|
// Group the variants by arch type.
|
|
var variantsByArchId = make(map[archId][]android.Module)
|
|
var archIds []archId
|
|
for _, variant := range osTypeVariants {
|
|
target := variant.Target()
|
|
id := archIdFromTarget(target)
|
|
if _, ok := variantsByArchId[id]; !ok {
|
|
archIds = append(archIds, id)
|
|
}
|
|
|
|
variantsByArchId[id] = append(variantsByArchId[id], variant)
|
|
}
|
|
|
|
if commonVariants, ok := variantsByArchId[commonArchId]; ok {
|
|
if len(osTypeVariants) != 1 {
|
|
variants := []string{}
|
|
for _, m := range osTypeVariants {
|
|
variants = append(variants, fmt.Sprintf(" %s", m.String()))
|
|
}
|
|
panic(fmt.Errorf("expected to only have 1 variant of %q when arch type is common but found %d\n%s",
|
|
ctx.Name(),
|
|
len(osTypeVariants),
|
|
strings.Join(variants, "\n")))
|
|
}
|
|
|
|
// A common arch type only has one variant and its properties should be treated
|
|
// as common to the os type.
|
|
osInfo.Properties.PopulateFromVariant(ctx, commonVariants[0])
|
|
} else {
|
|
// Create an arch specific info for each supported architecture type.
|
|
for _, id := range archIds {
|
|
archVariants := variantsByArchId[id]
|
|
archInfo := newArchSpecificInfo(ctx, id, osType, osSpecificVariantPropertiesFactory, archVariants)
|
|
|
|
osInfo.archInfos = append(osInfo.archInfos, archInfo)
|
|
}
|
|
}
|
|
|
|
return osInfo
|
|
}
|
|
|
|
func (osInfo *osTypeSpecificInfo) pruneUnsupportedProperties(pruner *propertyPruner) {
|
|
if len(osInfo.archInfos) == 0 {
|
|
pruner.pruneProperties(osInfo.Properties)
|
|
} else {
|
|
for _, archInfo := range osInfo.archInfos {
|
|
archInfo.pruneUnsupportedProperties(pruner)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Optimize the properties by extracting common properties from arch type specific
|
|
// properties into os type specific properties.
|
|
func (osInfo *osTypeSpecificInfo) optimizeProperties(ctx *memberContext, commonValueExtractor *commonValueExtractor) {
|
|
// Nothing to do if there is only a single common architecture.
|
|
if len(osInfo.archInfos) == 0 {
|
|
return
|
|
}
|
|
|
|
multilib := multilibNone
|
|
for _, archInfo := range osInfo.archInfos {
|
|
multilib = multilib.addArchType(archInfo.archId.archType)
|
|
|
|
// Optimize the arch properties first.
|
|
archInfo.optimizeProperties(ctx, commonValueExtractor)
|
|
}
|
|
|
|
extractCommonProperties(ctx.sdkMemberContext, commonValueExtractor, osInfo.Properties, osInfo.archInfos)
|
|
|
|
// Choose setting for compile_multilib that is appropriate for the arch variants supplied.
|
|
osInfo.Properties.Base().Compile_multilib = multilib.String()
|
|
}
|
|
|
|
// Add the properties for an os to a property set.
|
|
//
|
|
// Maps the properties related to the os variants through to an appropriate
|
|
// module structure that will produce equivalent set of variants when it is
|
|
// processed in a build.
|
|
func (osInfo *osTypeSpecificInfo) addToPropertySet(ctx *memberContext, bpModule android.BpModule, targetPropertySet android.BpPropertySet) {
|
|
|
|
var osPropertySet android.BpPropertySet
|
|
var archPropertySet android.BpPropertySet
|
|
var archOsPrefix string
|
|
if osInfo.Properties.Base().Os_count == 1 &&
|
|
(osInfo.osType.Class == android.Device || !ctx.memberType.IsHostOsDependent()) {
|
|
// There is only one OS type present in the variants and it shouldn't have a
|
|
// variant-specific target. The latter is the case if it's either for device
|
|
// where there is only one OS (android), or for host and the member type
|
|
// isn't host OS dependent.
|
|
|
|
// Create a structure that looks like:
|
|
// module_type {
|
|
// name: "...",
|
|
// ...
|
|
// <common properties>
|
|
// ...
|
|
// <single os type specific properties>
|
|
//
|
|
// arch: {
|
|
// <arch specific sections>
|
|
// }
|
|
//
|
|
osPropertySet = bpModule
|
|
archPropertySet = osPropertySet.AddPropertySet("arch")
|
|
|
|
// Arch specific properties need to be added to an arch specific section
|
|
// within arch.
|
|
archOsPrefix = ""
|
|
} else {
|
|
// Create a structure that looks like:
|
|
// module_type {
|
|
// name: "...",
|
|
// ...
|
|
// <common properties>
|
|
// ...
|
|
// target: {
|
|
// <arch independent os specific sections, e.g. android>
|
|
// ...
|
|
// <arch and os specific sections, e.g. android_x86>
|
|
// }
|
|
//
|
|
osType := osInfo.osType
|
|
osPropertySet = targetPropertySet.AddPropertySet(osType.Name)
|
|
archPropertySet = targetPropertySet
|
|
|
|
// Arch specific properties need to be added to an os and arch specific
|
|
// section prefixed with <os>_.
|
|
archOsPrefix = osType.Name + "_"
|
|
}
|
|
|
|
// Add the os specific but arch independent properties to the module.
|
|
addSdkMemberPropertiesToSet(ctx, osInfo.Properties, osPropertySet)
|
|
|
|
// Add arch (and possibly os) specific sections for each set of arch (and possibly
|
|
// os) specific properties.
|
|
//
|
|
// The archInfos list will be empty if the os contains variants for the common
|
|
// architecture.
|
|
for _, archInfo := range osInfo.archInfos {
|
|
archInfo.addToPropertySet(ctx, archPropertySet, archOsPrefix)
|
|
}
|
|
}
|
|
|
|
func (osInfo *osTypeSpecificInfo) isHostVariant() bool {
|
|
osClass := osInfo.osType.Class
|
|
return osClass == android.Host
|
|
}
|
|
|
|
var _ isHostVariant = (*osTypeSpecificInfo)(nil)
|
|
|
|
func (osInfo *osTypeSpecificInfo) String() string {
|
|
return fmt.Sprintf("OsType{%s}", osInfo.osType)
|
|
}
|
|
|
|
// archId encapsulates the information needed to identify a combination of arch type and native
|
|
// bridge support.
|
|
//
|
|
// Conceptually, native bridge support is a facet of an android.Target, not an android.Arch as it is
|
|
// essentially using one android.Arch to implement another. However, in terms of the handling of
|
|
// the variants native bridge is treated as part of the arch variation. See the ArchVariation method
|
|
// on android.Target.
|
|
//
|
|
// So, it makes sense when optimizing the variants to combine native bridge with the arch type.
|
|
type archId struct {
|
|
// The arch type of the variant's target.
|
|
archType android.ArchType
|
|
|
|
// True if the variants is for the native bridge, false otherwise.
|
|
nativeBridge bool
|
|
}
|
|
|
|
// propertyName returns the name of the property corresponding to use for this arch id.
|
|
func (i *archId) propertyName() string {
|
|
name := i.archType.Name
|
|
if i.nativeBridge {
|
|
// Note: This does not result in a valid property because there is no architecture specific
|
|
// native bridge property, only a generic "native_bridge" property. However, this will be used
|
|
// in error messages if there is an attempt to use this in a generated bp file.
|
|
name += "_native_bridge"
|
|
}
|
|
return name
|
|
}
|
|
|
|
func (i *archId) String() string {
|
|
return fmt.Sprintf("ArchType{%s}, NativeBridge{%t}", i.archType, i.nativeBridge)
|
|
}
|
|
|
|
// archIdFromTarget returns an archId initialized from information in the supplied target.
|
|
func archIdFromTarget(target android.Target) archId {
|
|
return archId{
|
|
archType: target.Arch.ArchType,
|
|
nativeBridge: target.NativeBridge == android.NativeBridgeEnabled,
|
|
}
|
|
}
|
|
|
|
// commonArchId is the archId for the common architecture.
|
|
var commonArchId = archId{archType: android.Common}
|
|
|
|
type archTypeSpecificInfo struct {
|
|
baseInfo
|
|
|
|
archId archId
|
|
osType android.OsType
|
|
|
|
imageVariantInfos []*imageVariantSpecificInfo
|
|
}
|
|
|
|
var _ propertiesContainer = (*archTypeSpecificInfo)(nil)
|
|
|
|
// Create a new archTypeSpecificInfo for the specified arch type and its properties
|
|
// structures populated with information from the variants.
|
|
func newArchSpecificInfo(ctx android.SdkMemberContext, archId archId, osType android.OsType, variantPropertiesFactory variantPropertiesFactoryFunc, archVariants []android.Module) *archTypeSpecificInfo {
|
|
|
|
// Create an arch specific info into which the variant properties can be copied.
|
|
archInfo := &archTypeSpecificInfo{archId: archId, osType: osType}
|
|
|
|
// Create the properties into which the arch type specific properties will be
|
|
// added.
|
|
archInfo.Properties = variantPropertiesFactory()
|
|
|
|
// if there are multiple supported link variants, we want to nest based on linkage even if there
|
|
// is only one variant, otherwise, if there is only one variant we can populate based on the arch
|
|
if len(archVariants) == 1 && len(ctx.MemberType().SupportedLinkages()) <= 1 {
|
|
archInfo.Properties.PopulateFromVariant(ctx, archVariants[0])
|
|
} else {
|
|
// Group the variants by image type.
|
|
variantsByImage := make(map[string][]android.Module)
|
|
for _, variant := range archVariants {
|
|
image := variant.ImageVariation().Variation
|
|
variantsByImage[image] = append(variantsByImage[image], variant)
|
|
}
|
|
|
|
// Create the image variant info in a fixed order.
|
|
for _, imageVariantName := range android.SortedKeys(variantsByImage) {
|
|
variants := variantsByImage[imageVariantName]
|
|
archInfo.imageVariantInfos = append(archInfo.imageVariantInfos, newImageVariantSpecificInfo(ctx, imageVariantName, variantPropertiesFactory, variants))
|
|
}
|
|
}
|
|
|
|
return archInfo
|
|
}
|
|
|
|
// Get the link type of the variant
|
|
//
|
|
// If the variant is not differentiated by link type then it returns "",
|
|
// otherwise it returns one of "static" or "shared".
|
|
func getLinkType(variant android.Module) string {
|
|
linkType := ""
|
|
if linkable, ok := variant.(cc.LinkableInterface); ok {
|
|
if linkable.Shared() && linkable.Static() {
|
|
panic(fmt.Errorf("expected variant %q to be either static or shared but was both", variant.String()))
|
|
} else if linkable.Shared() {
|
|
linkType = "shared"
|
|
} else if linkable.Static() {
|
|
linkType = "static"
|
|
} else {
|
|
panic(fmt.Errorf("expected variant %q to be either static or shared but was neither", variant.String()))
|
|
}
|
|
}
|
|
return linkType
|
|
}
|
|
|
|
func (archInfo *archTypeSpecificInfo) pruneUnsupportedProperties(pruner *propertyPruner) {
|
|
if len(archInfo.imageVariantInfos) == 0 {
|
|
pruner.pruneProperties(archInfo.Properties)
|
|
} else {
|
|
for _, imageVariantInfo := range archInfo.imageVariantInfos {
|
|
imageVariantInfo.pruneUnsupportedProperties(pruner)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Optimize the properties by extracting common properties from link type specific
|
|
// properties into arch type specific properties.
|
|
func (archInfo *archTypeSpecificInfo) optimizeProperties(ctx *memberContext, commonValueExtractor *commonValueExtractor) {
|
|
if len(archInfo.imageVariantInfos) == 0 {
|
|
return
|
|
}
|
|
|
|
// Optimize the image variant properties first.
|
|
for _, imageVariantInfo := range archInfo.imageVariantInfos {
|
|
imageVariantInfo.optimizeProperties(ctx, commonValueExtractor)
|
|
}
|
|
|
|
extractCommonProperties(ctx.sdkMemberContext, commonValueExtractor, archInfo.Properties, archInfo.imageVariantInfos)
|
|
}
|
|
|
|
// Add the properties for an arch type to a property set.
|
|
func (archInfo *archTypeSpecificInfo) addToPropertySet(ctx *memberContext, archPropertySet android.BpPropertySet, archOsPrefix string) {
|
|
archPropertySuffix := archInfo.archId.propertyName()
|
|
propertySetName := archOsPrefix + archPropertySuffix
|
|
archTypePropertySet := archPropertySet.AddPropertySet(propertySetName)
|
|
// Enable the <os>_<arch> variant explicitly when we've disabled it by default on host.
|
|
if ctx.memberType.IsHostOsDependent() && archInfo.osType.Class == android.Host {
|
|
archTypePropertySet.AddProperty("enabled", true)
|
|
}
|
|
addSdkMemberPropertiesToSet(ctx, archInfo.Properties, archTypePropertySet)
|
|
|
|
for _, imageVariantInfo := range archInfo.imageVariantInfos {
|
|
imageVariantInfo.addToPropertySet(ctx, archTypePropertySet)
|
|
}
|
|
|
|
// If this is for a native bridge architecture then make sure that the property set does not
|
|
// contain any properties as providing native bridge specific properties is not currently
|
|
// supported.
|
|
if archInfo.archId.nativeBridge {
|
|
propertySetContents := getPropertySetContents(archTypePropertySet)
|
|
if propertySetContents != "" {
|
|
ctx.SdkModuleContext().ModuleErrorf("Architecture variant %q of sdk member %q has properties distinct from other variants; this is not yet supported. The properties are:\n%s",
|
|
propertySetName, ctx.name, propertySetContents)
|
|
}
|
|
}
|
|
}
|
|
|
|
// getPropertySetContents returns the string representation of the contents of a property set, after
|
|
// recursively pruning any empty nested property sets.
|
|
func getPropertySetContents(propertySet android.BpPropertySet) string {
|
|
set := propertySet.(*bpPropertySet)
|
|
set.transformContents(pruneEmptySetTransformer{})
|
|
if len(set.properties) != 0 {
|
|
contents := &generatedContents{}
|
|
contents.Indent()
|
|
outputPropertySet(contents, set)
|
|
setAsString := contents.content.String()
|
|
return setAsString
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func (archInfo *archTypeSpecificInfo) String() string {
|
|
return archInfo.archId.String()
|
|
}
|
|
|
|
type imageVariantSpecificInfo struct {
|
|
baseInfo
|
|
|
|
imageVariant string
|
|
|
|
linkInfos []*linkTypeSpecificInfo
|
|
}
|
|
|
|
func newImageVariantSpecificInfo(ctx android.SdkMemberContext, imageVariant string, variantPropertiesFactory variantPropertiesFactoryFunc, imageVariants []android.Module) *imageVariantSpecificInfo {
|
|
|
|
// Create an image variant specific info into which the variant properties can be copied.
|
|
imageInfo := &imageVariantSpecificInfo{imageVariant: imageVariant}
|
|
|
|
// Create the properties into which the image variant specific properties will be added.
|
|
imageInfo.Properties = variantPropertiesFactory()
|
|
|
|
// if there are multiple supported link variants, we want to nest even if there is only one
|
|
// variant, otherwise, if there is only one variant we can populate based on the image
|
|
if len(imageVariants) == 1 && len(ctx.MemberType().SupportedLinkages()) <= 1 {
|
|
imageInfo.Properties.PopulateFromVariant(ctx, imageVariants[0])
|
|
} else {
|
|
// There is more than one variant for this image variant which must be differentiated by link
|
|
// type. Or there are multiple supported linkages and we need to nest based on link type.
|
|
for _, linkVariant := range imageVariants {
|
|
linkType := getLinkType(linkVariant)
|
|
if linkType == "" {
|
|
panic(fmt.Errorf("expected one arch specific variant as it is not identified by link type but found %d", len(imageVariants)))
|
|
} else {
|
|
linkInfo := newLinkSpecificInfo(ctx, linkType, variantPropertiesFactory, linkVariant)
|
|
|
|
imageInfo.linkInfos = append(imageInfo.linkInfos, linkInfo)
|
|
}
|
|
}
|
|
}
|
|
|
|
return imageInfo
|
|
}
|
|
|
|
func (imageInfo *imageVariantSpecificInfo) pruneUnsupportedProperties(pruner *propertyPruner) {
|
|
if len(imageInfo.linkInfos) == 0 {
|
|
pruner.pruneProperties(imageInfo.Properties)
|
|
} else {
|
|
for _, linkInfo := range imageInfo.linkInfos {
|
|
linkInfo.pruneUnsupportedProperties(pruner)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Optimize the properties by extracting common properties from link type specific
|
|
// properties into arch type specific properties.
|
|
func (imageInfo *imageVariantSpecificInfo) optimizeProperties(ctx *memberContext, commonValueExtractor *commonValueExtractor) {
|
|
if len(imageInfo.linkInfos) == 0 {
|
|
return
|
|
}
|
|
|
|
extractCommonProperties(ctx.sdkMemberContext, commonValueExtractor, imageInfo.Properties, imageInfo.linkInfos)
|
|
}
|
|
|
|
// Add the properties for an arch type to a property set.
|
|
func (imageInfo *imageVariantSpecificInfo) addToPropertySet(ctx *memberContext, propertySet android.BpPropertySet) {
|
|
if imageInfo.imageVariant != android.CoreVariation {
|
|
propertySet = propertySet.AddPropertySet(imageInfo.imageVariant)
|
|
}
|
|
|
|
addSdkMemberPropertiesToSet(ctx, imageInfo.Properties, propertySet)
|
|
|
|
usedLinkages := make(map[string]bool, len(imageInfo.linkInfos))
|
|
for _, linkInfo := range imageInfo.linkInfos {
|
|
usedLinkages[linkInfo.linkType] = true
|
|
linkInfo.addToPropertySet(ctx, propertySet)
|
|
}
|
|
|
|
// If not all supported linkages had existing variants, we need to disable the unsupported variant
|
|
if len(imageInfo.linkInfos) < len(ctx.MemberType().SupportedLinkages()) {
|
|
for _, l := range ctx.MemberType().SupportedLinkages() {
|
|
if _, ok := usedLinkages[l]; !ok {
|
|
otherLinkagePropertySet := propertySet.AddPropertySet(l)
|
|
otherLinkagePropertySet.AddProperty("enabled", false)
|
|
}
|
|
}
|
|
}
|
|
|
|
// If this is for a non-core image variant then make sure that the property set does not contain
|
|
// any properties as providing non-core image variant specific properties for prebuilts is not
|
|
// currently supported.
|
|
if imageInfo.imageVariant != android.CoreVariation {
|
|
propertySetContents := getPropertySetContents(propertySet)
|
|
if propertySetContents != "" {
|
|
ctx.SdkModuleContext().ModuleErrorf("Image variant %q of sdk member %q has properties distinct from other variants; this is not yet supported. The properties are:\n%s",
|
|
imageInfo.imageVariant, ctx.name, propertySetContents)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (imageInfo *imageVariantSpecificInfo) String() string {
|
|
return imageInfo.imageVariant
|
|
}
|
|
|
|
type linkTypeSpecificInfo struct {
|
|
baseInfo
|
|
|
|
linkType string
|
|
}
|
|
|
|
var _ propertiesContainer = (*linkTypeSpecificInfo)(nil)
|
|
|
|
// Create a new linkTypeSpecificInfo for the specified link type and its properties
|
|
// structures populated with information from the variant.
|
|
func newLinkSpecificInfo(ctx android.SdkMemberContext, linkType string, variantPropertiesFactory variantPropertiesFactoryFunc, linkVariant android.Module) *linkTypeSpecificInfo {
|
|
linkInfo := &linkTypeSpecificInfo{
|
|
baseInfo: baseInfo{
|
|
// Create the properties into which the link type specific properties will be
|
|
// added.
|
|
Properties: variantPropertiesFactory(),
|
|
},
|
|
linkType: linkType,
|
|
}
|
|
linkInfo.Properties.PopulateFromVariant(ctx, linkVariant)
|
|
return linkInfo
|
|
}
|
|
|
|
func (l *linkTypeSpecificInfo) addToPropertySet(ctx *memberContext, propertySet android.BpPropertySet) {
|
|
linkPropertySet := propertySet.AddPropertySet(l.linkType)
|
|
addSdkMemberPropertiesToSet(ctx, l.Properties, linkPropertySet)
|
|
}
|
|
|
|
func (l *linkTypeSpecificInfo) pruneUnsupportedProperties(pruner *propertyPruner) {
|
|
pruner.pruneProperties(l.Properties)
|
|
}
|
|
|
|
func (l *linkTypeSpecificInfo) String() string {
|
|
return fmt.Sprintf("LinkType{%s}", l.linkType)
|
|
}
|
|
|
|
type memberContext struct {
|
|
sdkMemberContext android.ModuleContext
|
|
builder *snapshotBuilder
|
|
memberType android.SdkMemberType
|
|
name string
|
|
|
|
// The set of traits required of this member.
|
|
requiredTraits android.SdkMemberTraitSet
|
|
}
|
|
|
|
func (m *memberContext) ModuleErrorf(fmt string, args ...interface{}) {
|
|
m.sdkMemberContext.ModuleErrorf(fmt, args...)
|
|
}
|
|
|
|
func (m *memberContext) SdkModuleContext() android.ModuleContext {
|
|
return m.sdkMemberContext
|
|
}
|
|
|
|
func (m *memberContext) SnapshotBuilder() android.SnapshotBuilder {
|
|
return m.builder
|
|
}
|
|
|
|
func (m *memberContext) MemberType() android.SdkMemberType {
|
|
return m.memberType
|
|
}
|
|
|
|
func (m *memberContext) Name() string {
|
|
return m.name
|
|
}
|
|
|
|
func (m *memberContext) RequiresTrait(trait android.SdkMemberTrait) bool {
|
|
return m.requiredTraits.Contains(trait)
|
|
}
|
|
|
|
func (m *memberContext) IsTargetBuildBeforeTiramisu() bool {
|
|
return m.builder.targetBuildRelease.EarlierThan(buildReleaseT)
|
|
}
|
|
|
|
var _ android.SdkMemberContext = (*memberContext)(nil)
|
|
|
|
func (s *sdk) createMemberSnapshot(ctx *memberContext, member *sdkMember, bpModule *bpModule) {
|
|
|
|
memberType := member.memberType
|
|
|
|
// Do not add the prefer property if the member snapshot module is a source module type.
|
|
moduleCtx := ctx.sdkMemberContext
|
|
if !memberType.UsesSourceModuleTypeInSnapshot() {
|
|
// Set prefer. Setting this to false is not strictly required as that is the default but it does
|
|
// provide a convenient hook to post-process the generated Android.bp file, e.g. in tests to
|
|
// check the behavior when a prebuilt is preferred. It also makes it explicit what the default
|
|
// behavior is for the module.
|
|
bpModule.insertAfter("name", "prefer", false)
|
|
}
|
|
|
|
variants := selectApexVariantsWhereAvailable(ctx, member.variants)
|
|
|
|
// Group the variants by os type.
|
|
variantsByOsType := make(map[android.OsType][]android.Module)
|
|
for _, variant := range variants {
|
|
osType := variant.Target().Os
|
|
variantsByOsType[osType] = append(variantsByOsType[osType], variant)
|
|
}
|
|
|
|
osCount := len(variantsByOsType)
|
|
variantPropertiesFactory := func() android.SdkMemberProperties {
|
|
properties := memberType.CreateVariantPropertiesStruct()
|
|
base := properties.Base()
|
|
base.Os_count = osCount
|
|
return properties
|
|
}
|
|
|
|
osTypeToInfo := make(map[android.OsType]*osTypeSpecificInfo)
|
|
|
|
// The set of properties that are common across all architectures and os types.
|
|
commonProperties := variantPropertiesFactory()
|
|
commonProperties.Base().Os = android.CommonOS
|
|
|
|
// Create a property pruner that will prune any properties unsupported by the target build
|
|
// release.
|
|
targetBuildRelease := ctx.builder.targetBuildRelease
|
|
unsupportedPropertyPruner := newPropertyPrunerByBuildRelease(commonProperties, targetBuildRelease)
|
|
|
|
// Create common value extractor that can be used to optimize the properties.
|
|
commonValueExtractor := newCommonValueExtractor(commonProperties)
|
|
|
|
// The list of property structures which are os type specific but common across
|
|
// architectures within that os type.
|
|
var osSpecificPropertiesContainers []*osTypeSpecificInfo
|
|
|
|
for osType, osTypeVariants := range variantsByOsType {
|
|
osInfo := newOsTypeSpecificInfo(ctx, osType, variantPropertiesFactory, osTypeVariants)
|
|
osTypeToInfo[osType] = osInfo
|
|
// Add the os specific properties to a list of os type specific yet architecture
|
|
// independent properties structs.
|
|
osSpecificPropertiesContainers = append(osSpecificPropertiesContainers, osInfo)
|
|
|
|
osInfo.pruneUnsupportedProperties(unsupportedPropertyPruner)
|
|
|
|
// Optimize the properties across all the variants for a specific os type.
|
|
osInfo.optimizeProperties(ctx, commonValueExtractor)
|
|
}
|
|
|
|
// Extract properties which are common across all architectures and os types.
|
|
extractCommonProperties(moduleCtx, commonValueExtractor, commonProperties, osSpecificPropertiesContainers)
|
|
|
|
// Add the common properties to the module.
|
|
addSdkMemberPropertiesToSet(ctx, commonProperties, bpModule)
|
|
|
|
// Create a target property set into which target specific properties can be
|
|
// added.
|
|
targetPropertySet := bpModule.AddPropertySet("target")
|
|
|
|
// If the member is host OS dependent and has host_supported then disable by
|
|
// default and enable each host OS variant explicitly. This avoids problems
|
|
// with implicitly enabled OS variants when the snapshot is used, which might
|
|
// be different from this run (e.g. different build OS).
|
|
if ctx.memberType.IsHostOsDependent() {
|
|
hostSupported := bpModule.getValue("host_supported") == true // Missing means false.
|
|
if hostSupported {
|
|
hostPropertySet := targetPropertySet.AddPropertySet("host")
|
|
hostPropertySet.AddProperty("enabled", false)
|
|
}
|
|
}
|
|
|
|
// Iterate over the os types in a fixed order.
|
|
for _, osType := range s.getPossibleOsTypes() {
|
|
osInfo := osTypeToInfo[osType]
|
|
if osInfo == nil {
|
|
continue
|
|
}
|
|
|
|
osInfo.addToPropertySet(ctx, bpModule, targetPropertySet)
|
|
}
|
|
}
|
|
|
|
// Compute the list of possible os types that this sdk could support.
|
|
func (s *sdk) getPossibleOsTypes() []android.OsType {
|
|
var osTypes []android.OsType
|
|
for _, osType := range android.OsTypeList() {
|
|
if s.DeviceSupported() {
|
|
if osType.Class == android.Device {
|
|
osTypes = append(osTypes, osType)
|
|
}
|
|
}
|
|
if s.HostSupported() {
|
|
if osType.Class == android.Host {
|
|
osTypes = append(osTypes, osType)
|
|
}
|
|
}
|
|
}
|
|
sort.SliceStable(osTypes, func(i, j int) bool { return osTypes[i].Name < osTypes[j].Name })
|
|
return osTypes
|
|
}
|
|
|
|
// Given a set of properties (struct value), return the value of the field within that
|
|
// struct (or one of its embedded structs).
|
|
type fieldAccessorFunc func(structValue reflect.Value) reflect.Value
|
|
|
|
// Checks the metadata to determine whether the property should be ignored for the
|
|
// purposes of common value extraction or not.
|
|
type extractorMetadataPredicate func(metadata propertiesContainer) bool
|
|
|
|
// Indicates whether optimizable properties are provided by a host variant or
|
|
// not.
|
|
type isHostVariant interface {
|
|
isHostVariant() bool
|
|
}
|
|
|
|
// A property that can be optimized by the commonValueExtractor.
|
|
type extractorProperty struct {
|
|
// The name of the field for this property. It is a "."-separated path for
|
|
// fields in non-anonymous substructs.
|
|
name string
|
|
|
|
// Filter that can use metadata associated with the properties being optimized
|
|
// to determine whether the field should be ignored during common value
|
|
// optimization.
|
|
filter extractorMetadataPredicate
|
|
|
|
// Retrieves the value on which common value optimization will be performed.
|
|
getter fieldAccessorFunc
|
|
|
|
// True if the field should never be cleared.
|
|
//
|
|
// This is set to true if and only if the field is annotated with `sdk:"keep"`.
|
|
keep bool
|
|
|
|
// The empty value for the field.
|
|
emptyValue reflect.Value
|
|
|
|
// True if the property can support arch variants false otherwise.
|
|
archVariant bool
|
|
}
|
|
|
|
func (p extractorProperty) String() string {
|
|
return p.name
|
|
}
|
|
|
|
// Supports extracting common values from a number of instances of a properties
|
|
// structure into a separate common set of properties.
|
|
type commonValueExtractor struct {
|
|
// The properties that the extractor can optimize.
|
|
properties []extractorProperty
|
|
}
|
|
|
|
// Create a new common value extractor for the structure type for the supplied
|
|
// properties struct.
|
|
//
|
|
// The returned extractor can be used on any properties structure of the same type
|
|
// as the supplied set of properties.
|
|
func newCommonValueExtractor(propertiesStruct interface{}) *commonValueExtractor {
|
|
structType := getStructValue(reflect.ValueOf(propertiesStruct)).Type()
|
|
extractor := &commonValueExtractor{}
|
|
extractor.gatherFields(structType, nil, "")
|
|
return extractor
|
|
}
|
|
|
|
// Gather the fields from the supplied structure type from which common values will
|
|
// be extracted.
|
|
//
|
|
// This is recursive function. If it encounters a struct then it will recurse
|
|
// into it, passing in the accessor for the field and the struct name as prefix
|
|
// for the nested fields. That will then be used in the accessors for the fields
|
|
// in the embedded struct.
|
|
func (e *commonValueExtractor) gatherFields(structType reflect.Type, containingStructAccessor fieldAccessorFunc, namePrefix string) {
|
|
for f := 0; f < structType.NumField(); f++ {
|
|
field := structType.Field(f)
|
|
if field.PkgPath != "" {
|
|
// Ignore unexported fields.
|
|
continue
|
|
}
|
|
|
|
// Ignore fields tagged with sdk:"ignore".
|
|
if proptools.HasTag(field, "sdk", "ignore") {
|
|
continue
|
|
}
|
|
|
|
var filter extractorMetadataPredicate
|
|
|
|
// Add a filter
|
|
if proptools.HasTag(field, "sdk", "ignored-on-host") {
|
|
filter = func(metadata propertiesContainer) bool {
|
|
if m, ok := metadata.(isHostVariant); ok {
|
|
if m.isHostVariant() {
|
|
return false
|
|
}
|
|
}
|
|
return true
|
|
}
|
|
}
|
|
|
|
keep := proptools.HasTag(field, "sdk", "keep")
|
|
|
|
// Save a copy of the field index for use in the function.
|
|
fieldIndex := f
|
|
|
|
name := namePrefix + field.Name
|
|
|
|
fieldGetter := func(value reflect.Value) reflect.Value {
|
|
if containingStructAccessor != nil {
|
|
// This is an embedded structure so first access the field for the embedded
|
|
// structure.
|
|
value = containingStructAccessor(value)
|
|
}
|
|
|
|
// Skip through interface and pointer values to find the structure.
|
|
value = getStructValue(value)
|
|
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
panic(fmt.Errorf("%s for fieldIndex %d of field %s of value %#v", r, fieldIndex, name, value.Interface()))
|
|
}
|
|
}()
|
|
|
|
// Return the field.
|
|
return value.Field(fieldIndex)
|
|
}
|
|
|
|
if field.Type.Kind() == reflect.Struct {
|
|
// Gather fields from the nested or embedded structure.
|
|
var subNamePrefix string
|
|
if field.Anonymous {
|
|
subNamePrefix = namePrefix
|
|
} else {
|
|
subNamePrefix = name + "."
|
|
}
|
|
e.gatherFields(field.Type, fieldGetter, subNamePrefix)
|
|
} else {
|
|
property := extractorProperty{
|
|
name,
|
|
filter,
|
|
fieldGetter,
|
|
keep,
|
|
reflect.Zero(field.Type),
|
|
proptools.HasTag(field, "android", "arch_variant"),
|
|
}
|
|
e.properties = append(e.properties, property)
|
|
}
|
|
}
|
|
}
|
|
|
|
func getStructValue(value reflect.Value) reflect.Value {
|
|
foundStruct:
|
|
for {
|
|
kind := value.Kind()
|
|
switch kind {
|
|
case reflect.Interface, reflect.Ptr:
|
|
value = value.Elem()
|
|
case reflect.Struct:
|
|
break foundStruct
|
|
default:
|
|
panic(fmt.Errorf("expecting struct, interface or pointer, found %v of kind %s", value, kind))
|
|
}
|
|
}
|
|
return value
|
|
}
|
|
|
|
// A container of properties to be optimized.
|
|
//
|
|
// Allows additional information to be associated with the properties, e.g. for
|
|
// filtering.
|
|
type propertiesContainer interface {
|
|
fmt.Stringer
|
|
|
|
// Get the properties that need optimizing.
|
|
optimizableProperties() interface{}
|
|
}
|
|
|
|
// Extract common properties from a slice of property structures of the same type.
|
|
//
|
|
// All the property structures must be of the same type.
|
|
// commonProperties - must be a pointer to the structure into which common properties will be added.
|
|
// inputPropertiesSlice - must be a slice of propertiesContainer interfaces.
|
|
//
|
|
// Iterates over each exported field (capitalized name) and checks to see whether they
|
|
// have the same value (using DeepEquals) across all the input properties. If it does not then no
|
|
// change is made. Otherwise, the common value is stored in the field in the commonProperties
|
|
// and the field in each of the input properties structure is set to its default value. Nested
|
|
// structs are visited recursively and their non-struct fields are compared.
|
|
func (e *commonValueExtractor) extractCommonProperties(commonProperties interface{}, inputPropertiesSlice interface{}) error {
|
|
commonPropertiesValue := reflect.ValueOf(commonProperties)
|
|
commonStructValue := commonPropertiesValue.Elem()
|
|
|
|
sliceValue := reflect.ValueOf(inputPropertiesSlice)
|
|
|
|
for _, property := range e.properties {
|
|
fieldGetter := property.getter
|
|
filter := property.filter
|
|
if filter == nil {
|
|
filter = func(metadata propertiesContainer) bool {
|
|
return true
|
|
}
|
|
}
|
|
|
|
// Check to see if all the structures have the same value for the field. The commonValue
|
|
// is nil on entry to the loop and if it is nil on exit then there is no common value or
|
|
// all the values have been filtered out, otherwise it points to the common value.
|
|
var commonValue *reflect.Value
|
|
|
|
// Assume that all the values will be the same.
|
|
//
|
|
// While similar to this is not quite the same as commonValue == nil. If all the values
|
|
// have been filtered out then this will be false but commonValue == nil will be true.
|
|
valuesDiffer := false
|
|
|
|
for i := 0; i < sliceValue.Len(); i++ {
|
|
container := sliceValue.Index(i).Interface().(propertiesContainer)
|
|
itemValue := reflect.ValueOf(container.optimizableProperties())
|
|
fieldValue := fieldGetter(itemValue)
|
|
|
|
if !filter(container) {
|
|
expectedValue := property.emptyValue.Interface()
|
|
actualValue := fieldValue.Interface()
|
|
if !reflect.DeepEqual(expectedValue, actualValue) {
|
|
return fmt.Errorf("field %q is supposed to be ignored for %q but is set to %#v instead of %#v", property, container, actualValue, expectedValue)
|
|
}
|
|
continue
|
|
}
|
|
|
|
if commonValue == nil {
|
|
// Use the first value as the commonProperties value.
|
|
commonValue = &fieldValue
|
|
} else {
|
|
// If the value does not match the current common value then there is
|
|
// no value in common so break out.
|
|
if !reflect.DeepEqual(fieldValue.Interface(), commonValue.Interface()) {
|
|
commonValue = nil
|
|
valuesDiffer = true
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
// If the fields all have common value then store it in the common struct field
|
|
// and set the input struct's field to the empty value.
|
|
if commonValue != nil {
|
|
emptyValue := property.emptyValue
|
|
fieldGetter(commonStructValue).Set(*commonValue)
|
|
if !property.keep {
|
|
for i := 0; i < sliceValue.Len(); i++ {
|
|
container := sliceValue.Index(i).Interface().(propertiesContainer)
|
|
itemValue := reflect.ValueOf(container.optimizableProperties())
|
|
fieldValue := fieldGetter(itemValue)
|
|
fieldValue.Set(emptyValue)
|
|
}
|
|
}
|
|
}
|
|
|
|
if valuesDiffer && !property.archVariant {
|
|
// The values differ but the property does not support arch variants so it
|
|
// is an error.
|
|
var details strings.Builder
|
|
for i := 0; i < sliceValue.Len(); i++ {
|
|
container := sliceValue.Index(i).Interface().(propertiesContainer)
|
|
itemValue := reflect.ValueOf(container.optimizableProperties())
|
|
fieldValue := fieldGetter(itemValue)
|
|
|
|
_, _ = fmt.Fprintf(&details, "\n %q has value %q", container.String(), fieldValue.Interface())
|
|
}
|
|
|
|
return fmt.Errorf("field %q is not tagged as \"arch_variant\" but has arch specific properties:%s", property.String(), details.String())
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|