95e89a8cb9
Eliminate another duplicated list of all modules. This one has a couple of workarounds due to different naming of impl libs, and bluetooth not being ready. Bug: 169103987 Test: m framework-all and diff intermediates (no diffs) Merged-In: Ia8627c6e3977cd271e389ec482388ff73661881d Change-Id: Ia8627c6e3977cd271e389ec482388ff73661881d
342 lines
12 KiB
Go
342 lines
12 KiB
Go
// Copyright (C) 2021 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 api
|
|
|
|
import (
|
|
"sort"
|
|
|
|
"github.com/google/blueprint/proptools"
|
|
|
|
"android/soong/android"
|
|
"android/soong/genrule"
|
|
"android/soong/java"
|
|
)
|
|
|
|
const art = "art.module.public.api"
|
|
const conscrypt = "conscrypt.module.public.api"
|
|
const i18n = "i18n.module.public.api"
|
|
var core_libraries_modules = []string{art, conscrypt, i18n}
|
|
|
|
// The intention behind this soong plugin is to generate a number of "merged"
|
|
// API-related modules that would otherwise require a large amount of very
|
|
// similar Android.bp boilerplate to define. For example, the merged current.txt
|
|
// API definitions (created by merging the non-updatable current.txt with all
|
|
// the module current.txts). This simplifies the addition of new android
|
|
// modules, by reducing the number of genrules etc a new module must be added to.
|
|
|
|
// The properties of the combined_apis module type.
|
|
type CombinedApisProperties struct {
|
|
// Module libraries in the bootclasspath
|
|
Bootclasspath []string
|
|
// Module libraries on the bootclasspath if include_nonpublic_framework_api is true.
|
|
Conditional_bootclasspath []string
|
|
// Module libraries in system server
|
|
System_server_classpath []string
|
|
}
|
|
|
|
type CombinedApis struct {
|
|
android.ModuleBase
|
|
|
|
properties CombinedApisProperties
|
|
}
|
|
|
|
func init() {
|
|
registerBuildComponents(android.InitRegistrationContext)
|
|
}
|
|
|
|
func registerBuildComponents(ctx android.RegistrationContext) {
|
|
ctx.RegisterModuleType("combined_apis", combinedApisModuleFactory)
|
|
}
|
|
|
|
var PrepareForCombinedApisTest = android.FixtureRegisterWithContext(registerBuildComponents)
|
|
|
|
func (a *CombinedApis) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
}
|
|
|
|
type genruleProps struct {
|
|
Name *string
|
|
Cmd *string
|
|
Dists []android.Dist
|
|
Out []string
|
|
Srcs []string
|
|
Tools []string
|
|
Visibility []string
|
|
}
|
|
|
|
type libraryProps struct {
|
|
Name *string
|
|
Sdk_version *string
|
|
Static_libs []string
|
|
Visibility []string
|
|
}
|
|
|
|
type fgProps struct {
|
|
Name *string
|
|
Srcs []string
|
|
Visibility []string
|
|
}
|
|
|
|
// Struct to pass parameters for the various merged [current|removed].txt file modules we create.
|
|
type MergedTxtDefinition struct {
|
|
// "current.txt" or "removed.txt"
|
|
TxtFilename string
|
|
// The module for the non-updatable / non-module part of the api.
|
|
BaseTxt string
|
|
// The list of modules that are relevant for this merged txt.
|
|
Modules []string
|
|
// The output tag for each module to use.e.g. {.public.api.txt} for current.txt
|
|
ModuleTag string
|
|
// public, system, module-lib or system-server
|
|
Scope string
|
|
}
|
|
|
|
func createMergedTxt(ctx android.LoadHookContext, txt MergedTxtDefinition) {
|
|
metalavaCmd := "$(location metalava)"
|
|
// Silence reflection warnings. See b/168689341
|
|
metalavaCmd += " -J--add-opens=java.base/java.util=ALL-UNNAMED "
|
|
metalavaCmd += " --quiet --no-banner --format=v2 "
|
|
|
|
filename := txt.TxtFilename
|
|
if txt.Scope != "public" {
|
|
filename = txt.Scope + "-" + filename
|
|
}
|
|
|
|
props := genruleProps{}
|
|
props.Name = proptools.StringPtr(ctx.ModuleName() + "-" + filename)
|
|
props.Tools = []string{"metalava"}
|
|
props.Out = []string{filename}
|
|
props.Cmd = proptools.StringPtr(metalavaCmd + "$(in) --api $(out)")
|
|
props.Srcs = append([]string{txt.BaseTxt}, createSrcs(txt.Modules, txt.ModuleTag)...)
|
|
props.Dists = []android.Dist{
|
|
{
|
|
Targets: []string{"droidcore"},
|
|
Dir: proptools.StringPtr("api"),
|
|
Dest: proptools.StringPtr(filename),
|
|
},
|
|
{
|
|
Targets: []string{"sdk"},
|
|
Dir: proptools.StringPtr("apistubs/android/" + txt.Scope + "/api"),
|
|
Dest: proptools.StringPtr(txt.TxtFilename),
|
|
},
|
|
}
|
|
props.Visibility = []string{"//visibility:public"}
|
|
ctx.CreateModule(genrule.GenRuleFactory, &props)
|
|
}
|
|
|
|
func createMergedStubsSrcjar(ctx android.LoadHookContext, modules []string) {
|
|
props := genruleProps{}
|
|
props.Name = proptools.StringPtr(ctx.ModuleName() + "-current.srcjar")
|
|
props.Tools = []string{"merge_zips"}
|
|
props.Out = []string{"current.srcjar"}
|
|
props.Cmd = proptools.StringPtr("$(location merge_zips) $(out) $(in)")
|
|
props.Srcs = append([]string{":api-stubs-docs-non-updatable"}, createSrcs(modules, "{.public.stubs.source}")...)
|
|
props.Visibility = []string{"//visibility:private"} // Used by make module in //development, mind
|
|
ctx.CreateModule(genrule.GenRuleFactory, &props)
|
|
}
|
|
|
|
// This produces the same annotations.zip as framework-doc-stubs, but by using
|
|
// outputs from individual modules instead of all the source code.
|
|
func createMergedAnnotations(ctx android.LoadHookContext, modules []string) {
|
|
props := genruleProps{}
|
|
props.Name = proptools.StringPtr("sdk-annotations.zip")
|
|
props.Tools = []string{"merge_annotation_zips", "soong_zip"}
|
|
props.Out = []string{"annotations.zip"}
|
|
props.Cmd = proptools.StringPtr("$(location merge_annotation_zips) $(genDir)/out $(in) && " +
|
|
"$(location soong_zip) -o $(out) -C $(genDir)/out -D $(genDir)/out")
|
|
props.Srcs = append([]string{":android-non-updatable-doc-stubs{.annotations.zip}"}, createSrcs(modules, "{.public.annotations.zip}")...)
|
|
ctx.CreateModule(genrule.GenRuleFactory, &props)
|
|
}
|
|
|
|
func createFilteredApiVersions(ctx android.LoadHookContext, modules []string) {
|
|
// For the filtered api versions, we prune all APIs except art module's APIs. because
|
|
// 1) ART apis are available by default to all modules, while other module-to-module deps are
|
|
// explicit and probably receive more scrutiny anyway
|
|
// 2) The number of ART/libcore APIs is large, so not linting them would create a large gap
|
|
// 3) It's a compromise. Ideally we wouldn't be filtering out any module APIs, and have
|
|
// per-module lint databases that excludes just that module's APIs. Alas, that's more
|
|
// difficult to achieve.
|
|
modules = remove(modules, art)
|
|
|
|
props := genruleProps{}
|
|
props.Name = proptools.StringPtr("api-versions-xml-public-filtered")
|
|
props.Tools = []string{"api_versions_trimmer"}
|
|
props.Out = []string{"api-versions-public-filtered.xml"}
|
|
props.Cmd = proptools.StringPtr("$(location api_versions_trimmer) $(out) $(in)")
|
|
// Note: order matters: first parameter is the full api-versions.xml
|
|
// after that the stubs files in any order
|
|
// stubs files are all modules that export API surfaces EXCEPT ART
|
|
props.Srcs = append([]string{":framework-doc-stubs{.api_versions.xml}"}, createSrcs(modules, ".stubs{.jar}")...)
|
|
props.Dists = []android.Dist{{Targets: []string{"sdk"}}}
|
|
ctx.CreateModule(genrule.GenRuleFactory, &props)
|
|
}
|
|
|
|
func createMergedPublicStubs(ctx android.LoadHookContext, modules []string) {
|
|
props := libraryProps{}
|
|
props.Name = proptools.StringPtr("all-modules-public-stubs")
|
|
props.Static_libs = transformArray(modules, "", ".stubs")
|
|
props.Sdk_version = proptools.StringPtr("module_current")
|
|
props.Visibility = []string{"//frameworks/base"}
|
|
ctx.CreateModule(java.LibraryFactory, &props)
|
|
}
|
|
|
|
func createMergedSystemStubs(ctx android.LoadHookContext, modules []string) {
|
|
props := libraryProps{}
|
|
props.Name = proptools.StringPtr("all-modules-system-stubs")
|
|
props.Static_libs = transformArray(modules, "", ".stubs.system")
|
|
props.Sdk_version = proptools.StringPtr("module_current")
|
|
props.Visibility = []string{"//frameworks/base"}
|
|
ctx.CreateModule(java.LibraryFactory, &props)
|
|
}
|
|
|
|
func createMergedFrameworkImpl(ctx android.LoadHookContext, modules []string) {
|
|
// This module is for the "framework-all" module, which should not include the core libraries.
|
|
modules = removeAll(modules, core_libraries_modules)
|
|
// TODO(b/214988855): remove the line below when framework-bluetooth has an impl jar.
|
|
modules = remove(modules, "framework-bluetooth")
|
|
props := libraryProps{}
|
|
props.Name = proptools.StringPtr("all-framework-module-impl")
|
|
props.Static_libs = transformArray(modules, "", ".impl")
|
|
// Media module's impl jar is called "updatable-media"
|
|
for i, v := range props.Static_libs {
|
|
if v == "framework-media.impl" {
|
|
props.Static_libs[i] = "updatable-media"
|
|
}
|
|
}
|
|
props.Sdk_version = proptools.StringPtr("module_current")
|
|
props.Visibility = []string{"//frameworks/base"}
|
|
ctx.CreateModule(java.LibraryFactory, &props)
|
|
}
|
|
|
|
func createMergedFrameworkModuleLibStubs(ctx android.LoadHookContext, modules []string) {
|
|
// The user of this module compiles against the "core" SDK, so remove core libraries to avoid dupes.
|
|
modules = removeAll(modules, core_libraries_modules)
|
|
props := libraryProps{}
|
|
props.Name = proptools.StringPtr("framework-updatable-stubs-module_libs_api")
|
|
props.Static_libs = transformArray(modules, "", ".stubs.module_lib")
|
|
props.Sdk_version = proptools.StringPtr("module_current")
|
|
props.Visibility = []string{"//frameworks/base"}
|
|
ctx.CreateModule(java.LibraryFactory, &props)
|
|
}
|
|
|
|
func createPublicStubsSourceFilegroup(ctx android.LoadHookContext, modules []string) {
|
|
props := fgProps{}
|
|
props.Name = proptools.StringPtr("all-modules-public-stubs-source")
|
|
props.Srcs = createSrcs(modules, "{.public.stubs.source}")
|
|
props.Visibility = []string{"//frameworks/base"}
|
|
ctx.CreateModule(android.FileGroupFactory, &props)
|
|
}
|
|
|
|
func createMergedTxts(ctx android.LoadHookContext, bootclasspath, system_server_classpath []string) {
|
|
var textFiles []MergedTxtDefinition
|
|
|
|
tagSuffix := []string{".api.txt}", ".removed-api.txt}"}
|
|
for i, f := range []string{"current.txt", "removed.txt"} {
|
|
textFiles = append(textFiles, MergedTxtDefinition{
|
|
TxtFilename: f,
|
|
BaseTxt: ":non-updatable-" + f,
|
|
Modules: bootclasspath,
|
|
ModuleTag: "{.public" + tagSuffix[i],
|
|
Scope: "public",
|
|
})
|
|
textFiles = append(textFiles, MergedTxtDefinition{
|
|
TxtFilename: f,
|
|
BaseTxt: ":non-updatable-system-" + f,
|
|
Modules: bootclasspath,
|
|
ModuleTag: "{.system" + tagSuffix[i],
|
|
Scope: "system",
|
|
})
|
|
textFiles = append(textFiles, MergedTxtDefinition{
|
|
TxtFilename: f,
|
|
BaseTxt: ":non-updatable-module-lib-" + f,
|
|
Modules: bootclasspath,
|
|
ModuleTag: "{.module-lib" + tagSuffix[i],
|
|
Scope: "module-lib",
|
|
})
|
|
textFiles = append(textFiles, MergedTxtDefinition{
|
|
TxtFilename: f,
|
|
BaseTxt: ":non-updatable-system-server-" + f,
|
|
Modules: system_server_classpath,
|
|
ModuleTag: "{.system-server" + tagSuffix[i],
|
|
Scope: "system-server",
|
|
})
|
|
}
|
|
for _, txt := range textFiles {
|
|
createMergedTxt(ctx, txt)
|
|
}
|
|
}
|
|
|
|
func (a *CombinedApis) createInternalModules(ctx android.LoadHookContext) {
|
|
bootclasspath := a.properties.Bootclasspath
|
|
if ctx.Config().VendorConfig("ANDROID").Bool("include_nonpublic_framework_api") {
|
|
bootclasspath = append(bootclasspath, a.properties.Conditional_bootclasspath...)
|
|
sort.Strings(bootclasspath)
|
|
}
|
|
createMergedTxts(ctx, bootclasspath, a.properties.System_server_classpath)
|
|
|
|
createMergedStubsSrcjar(ctx, bootclasspath)
|
|
|
|
createMergedPublicStubs(ctx, bootclasspath)
|
|
createMergedSystemStubs(ctx, bootclasspath)
|
|
createMergedFrameworkModuleLibStubs(ctx, bootclasspath)
|
|
createMergedFrameworkImpl(ctx, bootclasspath)
|
|
|
|
createMergedAnnotations(ctx, bootclasspath)
|
|
|
|
createFilteredApiVersions(ctx, bootclasspath)
|
|
|
|
createPublicStubsSourceFilegroup(ctx, bootclasspath)
|
|
}
|
|
|
|
func combinedApisModuleFactory() android.Module {
|
|
module := &CombinedApis{}
|
|
module.AddProperties(&module.properties)
|
|
android.InitAndroidModule(module)
|
|
android.AddLoadHook(module, func(ctx android.LoadHookContext) { module.createInternalModules(ctx) })
|
|
return module
|
|
}
|
|
|
|
// Various utility methods below.
|
|
|
|
// Creates an array of ":<m><tag>" for each m in <modules>.
|
|
func createSrcs(modules []string, tag string) []string {
|
|
return transformArray(modules, ":", tag)
|
|
}
|
|
|
|
// Creates an array of "<prefix><m><suffix>", for each m in <modules>.
|
|
func transformArray(modules []string, prefix, suffix string) []string {
|
|
a := make([]string, 0, len(modules))
|
|
for _, module := range modules {
|
|
a = append(a, prefix+module+suffix)
|
|
}
|
|
return a
|
|
}
|
|
|
|
func removeAll(s []string, vs []string) []string {
|
|
for _, v := range vs {
|
|
s = remove(s, v)
|
|
}
|
|
return s
|
|
}
|
|
|
|
func remove(s []string, v string) []string {
|
|
s2 := make([]string, 0, len(s))
|
|
for _, sv := range s {
|
|
if sv != v {
|
|
s2 = append(s2, sv)
|
|
}
|
|
}
|
|
return s2
|
|
}
|