Move hiddenapi to Soong

Perform hiddenapi CSV generation and dex encoding for Soong modules
in Soong.  This fixes an issue where dexpreopting was happening on
a different jar than was being installed.

Bug: 122856783
Test: m checkbuild
Test: no change out/target/common/obj/PACKAGING/hiddenapi-flags.csv
Test: only ordering change to out/target/common/obj/PACKAGING/hiddenapi-greylist.csv
Test: cts/tests/signature/runSignatureTests.sh
Change-Id: I4fc481efc29e73cb2bdaacf672e86d5f6f0075ae
This commit is contained in:
Colin Cross 2019-01-16 15:15:52 -08:00
parent 56abb83628
commit 8faf8fc060
7 changed files with 188 additions and 0 deletions

View file

@ -243,6 +243,7 @@ bootstrap_go_package {
"java/droiddoc.go",
"java/gen.go",
"java/genrule.go",
"java/hiddenapi.go",
"java/jacoco.go",
"java/java.go",
"java/jdeps.go",

View file

@ -983,6 +983,18 @@ func (c *config) EnforceSystemCertificateWhitelist() []string {
return c.productVariables.EnforceSystemCertificateWhitelist
}
func (c *config) HiddenAPIPublicList() string {
return String(c.productVariables.HiddenAPIPublicList)
}
func (c *config) HiddenAPIFlags() string {
return String(c.productVariables.HiddenAPIFlags)
}
func (c *config) HiddenAPIExtraAppUsageJars() []string {
return c.productVariables.HiddenAPIExtraAppUsageJars
}
func stringSlice(s *[]string) []string {
if s != nil {
return *s

View file

@ -271,6 +271,11 @@ type productVariables struct {
EnforceSystemCertificate *bool `json:",omitempty"`
EnforceSystemCertificateWhitelist []string `json:",omitempty"`
// TODO(ccross): move these to a Singleton in Soong
HiddenAPIPublicList *string `json:",omitempty"`
HiddenAPIFlags *string `json:",omitempty"`
HiddenAPIExtraAppUsageJars []string `json:",omitempty"`
}
func boolPtr(v bool) *bool {

View file

@ -154,4 +154,7 @@ func init() {
pctx.SourcePathsVariable("ManifestMergerClasspath", ":", ManifestMergerClasspath...)
pctx.HostBinToolVariable("ZipAlign", "zipalign")
pctx.HostBinToolVariable("Class2Greylist", "class2greylist")
pctx.HostBinToolVariable("HiddenAPI", "hiddenapi")
}

View file

@ -78,4 +78,7 @@ func makeVarsProvider(ctx android.MakeVarsContext) {
ctx.Strict("ANDROID_MANIFEST_MERGER_DEPS", "${ManifestMergerJars}")
ctx.Strict("ANDROID_MANIFEST_MERGER",
"${JavaCmd} -classpath ${ManifestMergerClasspath} com.android.manifmerger.Merger")
ctx.Strict("CLASS2GREYLIST", "${Class2Greylist}")
ctx.Strict("HIDDENAPI", "${HiddenAPI}")
}

150
java/hiddenapi.go Normal file
View file

@ -0,0 +1,150 @@
// Copyright 2019 Google Inc. All rights reserved.
//
// 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 java
import (
"sort"
"strings"
"sync"
"github.com/google/blueprint"
"android/soong/android"
)
var hiddenAPIGenerateCSVRule = pctx.AndroidStaticRule("hiddenAPIGenerateCSV", blueprint.RuleParams{
Command: "${config.Class2Greylist} --public-api-list ${publicAPIList} $in $outFlag $out",
CommandDeps: []string{"${config.Class2Greylist}"},
}, "outFlag", "publicAPIList")
func hiddenAPIGenerateCSV(ctx android.ModuleContext, classesJar android.Path) {
flagsCSV := android.PathForModuleOut(ctx, "hiddenapi", "flags.csv")
metadataCSV := android.PathForModuleOut(ctx, "hiddenapi", "metadata.csv")
publicList := &bootImagePath{ctx.Config().HiddenAPIPublicList()}
ctx.Build(pctx, android.BuildParams{
Rule: hiddenAPIGenerateCSVRule,
Description: "hiddenapi flags",
Input: classesJar,
Output: flagsCSV,
Implicit: publicList,
Args: map[string]string{
"outFlag": "--write-flags-csv",
"publicAPIList": publicList.String(),
},
})
ctx.Build(pctx, android.BuildParams{
Rule: hiddenAPIGenerateCSVRule,
Description: "hiddenapi metadata",
Input: classesJar,
Output: metadataCSV,
Implicit: publicList,
Args: map[string]string{
"outFlag": "--write-metadata-csv",
"publicAPIList": publicList.String(),
},
})
hiddenAPISaveCSVOutputs(ctx, flagsCSV, metadataCSV)
}
var hiddenAPIEncodeDexRule = pctx.AndroidStaticRule("hiddenAPIEncodeDex", blueprint.RuleParams{
Command: `rm -rf $tmpDir && mkdir -p $tmpDir && mkdir $tmpDir/dex-input && mkdir $tmpDir/dex-output && ` +
`unzip -o -q $in 'classes*.dex' -d $tmpDir/dex-input && ` +
`for INPUT_DEX in $$(find $tmpDir/dex-input -maxdepth 1 -name 'classes*.dex' | sort); do ` +
` echo "--input-dex=$${INPUT_DEX}"; ` +
` echo "--output-dex=$tmpDir/dex-output/$$(basename $${INPUT_DEX})"; ` +
`done | xargs ${config.HiddenAPI} encode --api-flags=$flags && ` +
`${config.SoongZipCmd} -o $tmpDir/dex.jar -C $tmpDir/dex-output -f "$tmpDir/dex-output/classes*.dex" && ` +
`${config.MergeZipsCmd} -D -zipToNotStrip $tmpDir/dex.jar -stripFile "classes*.dex" $out $tmpDir/dex.jar $in`,
CommandDeps: []string{
"${config.HiddenAPI}",
"${config.SoongZipCmd}",
"${config.MergeZipsCmd}",
},
}, "flags", "tmpDir")
func hiddenAPIEncodeDex(ctx android.ModuleContext, output android.WritablePath, dexInput android.WritablePath) {
if ctx.Config().IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") {
output = dexInput
return
}
flags := &bootImagePath{ctx.Config().HiddenAPIFlags()}
ctx.Build(pctx, android.BuildParams{
Rule: hiddenAPIEncodeDexRule,
Description: "hiddenapi encode dex",
Input: dexInput,
Output: output,
Implicit: flags,
Args: map[string]string{
"flags": flags.String(),
"tmpDir": android.PathForModuleOut(ctx, "hiddenapi", "dex").String(),
},
})
hiddenAPISaveDexInputs(ctx, dexInput)
}
const hiddenAPIOutputsKey = "hiddenAPIOutputsKey"
var hiddenAPIOutputsLock sync.Mutex
func hiddenAPIGetOutputs(config android.Config) (*android.Paths, *android.Paths, *android.Paths) {
type threePathsPtrs [3]*android.Paths
s := config.Once(hiddenAPIOutputsKey, func() interface{} {
return threePathsPtrs{new(android.Paths), new(android.Paths), new(android.Paths)}
}).(threePathsPtrs)
return s[0], s[1], s[2]
}
func hiddenAPISaveCSVOutputs(ctx android.ModuleContext, flagsCSV, metadataCSV android.Path) {
flagsCSVList, metadataCSVList, _ := hiddenAPIGetOutputs(ctx.Config())
hiddenAPIOutputsLock.Lock()
defer hiddenAPIOutputsLock.Unlock()
*flagsCSVList = append(*flagsCSVList, flagsCSV)
*metadataCSVList = append(*metadataCSVList, metadataCSV)
}
func hiddenAPISaveDexInputs(ctx android.ModuleContext, dexInput android.Path) {
_, _, dexInputList := hiddenAPIGetOutputs(ctx.Config())
hiddenAPIOutputsLock.Lock()
defer hiddenAPIOutputsLock.Unlock()
*dexInputList = append(*dexInputList, dexInput)
}
func init() {
android.RegisterMakeVarsProvider(pctx, hiddenAPIMakeVars)
}
func hiddenAPIMakeVars(ctx android.MakeVarsContext) {
flagsCSVList, metadataCSVList, dexInputList := hiddenAPIGetOutputs(ctx.Config())
export := func(name string, paths *android.Paths) {
s := paths.Strings()
sort.Strings(s)
ctx.Strict(name, strings.Join(s, " "))
}
export("SOONG_HIDDENAPI_FLAGS", flagsCSVList)
export("SOONG_HIDDENAPI_GREYLIST_METADATA", metadataCSVList)
export("SOONG_HIDDENAPI_DEX_INPUTS", dexInputList)
}

View file

@ -1172,12 +1172,25 @@ func (j *Module) compile(ctx android.ModuleContext, extraSrcJars ...android.Path
j.implementationAndResourcesJar = implementationAndResourcesJar
if ctx.Device() && (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
// Dex compilation
var dexOutputFile android.ModuleOutPath
dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
if ctx.Failed() {
return
}
// Hidden API CSV generation and dex encoding
isBootJar := inList(ctx.ModuleName(), ctx.Config().BootJars())
if isBootJar || inList(ctx.ModuleName(), ctx.Config().HiddenAPIExtraAppUsageJars()) {
// Derive the greylist from classes jar.
hiddenAPIGenerateCSV(ctx, j.implementationJarFile)
}
if isBootJar {
hiddenAPIJar := android.PathForModuleOut(ctx, "hiddenapi", jarName)
hiddenAPIEncodeDex(ctx, hiddenAPIJar, dexOutputFile)
dexOutputFile = hiddenAPIJar
}
// merge dex jar with resources if necessary
if j.resourceJar != nil {
jars := android.Paths{dexOutputFile, j.resourceJar}
@ -1189,6 +1202,7 @@ func (j *Module) compile(ctx android.ModuleContext, extraSrcJars ...android.Path
j.dexJarFile = dexOutputFile
// Dexpreopting
j.dexpreopter.isInstallable = Bool(j.properties.Installable)
j.dexpreopter.uncompressedDex = j.deviceProperties.UncompressDex
dexOutputFile = j.dexpreopt(ctx, dexOutputFile)