Fix Soong code, remove dead code, and clean up code for Java fuzz

(cherry picked from commit fdf043a7b1)

Test: built fuzz targets locally and tested them with Jazzer
Change-Id: I3ff487ba4e34289e0f53f2077463f524f4bf4f11
This commit is contained in:
Cory Barker
2023-02-03 00:20:52 +00:00
committed by LaMont Jones
parent a2244043ea
commit eaf7f5ecb9
4 changed files with 71 additions and 156 deletions

View File

@@ -133,13 +133,19 @@ func (library *Library) AndroidMkEntries() []android.AndroidMkEntries {
return entriesList return entriesList
} }
func (j *JavaFuzzLibrary) AndroidMkEntries() []android.AndroidMkEntries { func (j *JavaFuzzTest) AndroidMkEntries() []android.AndroidMkEntries {
entriesList := j.Library.AndroidMkEntries() entriesList := j.Library.AndroidMkEntries()
entries := &entriesList[0] entries := &entriesList[0]
entries.ExtraEntries = append(entries.ExtraEntries, func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) { entries.ExtraEntries = append(entries.ExtraEntries, func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
entries.AddStrings("LOCAL_COMPATIBILITY_SUITE", "null-suite") entries.AddStrings("LOCAL_COMPATIBILITY_SUITE", "null-suite")
androidMkWriteTestData(j.jniFilePaths, entries)
androidMkWriteTestData(android.Paths{j.implementationJarFile}, entries) androidMkWriteTestData(android.Paths{j.implementationJarFile}, entries)
androidMkWriteTestData(j.jniFilePaths, entries)
if j.fuzzPackagedModule.Corpus != nil {
androidMkWriteTestData(j.fuzzPackagedModule.Corpus, entries)
}
if j.fuzzPackagedModule.Dictionary != nil {
androidMkWriteTestData(android.Paths{j.fuzzPackagedModule.Dictionary}, entries)
}
}) })
return entriesList return entriesList
} }

View File

@@ -19,12 +19,12 @@ import (
"sort" "sort"
"strings" "strings"
"github.com/google/blueprint"
"github.com/google/blueprint/proptools"
"android/soong/android" "android/soong/android"
"android/soong/cc" "android/soong/cc"
"android/soong/fuzz" "android/soong/fuzz"
"github.com/google/blueprint"
"github.com/google/blueprint/proptools"
) )
const ( const (
@@ -32,63 +32,63 @@ const (
targetString = "target" targetString = "target"
) )
type jniProperties struct {
// list of jni libs
Jni_libs []string
// sanitization
Sanitizers []string
}
func init() { func init() {
RegisterJavaFuzzBuildComponents(android.InitRegistrationContext) RegisterJavaFuzzBuildComponents(android.InitRegistrationContext)
} }
func RegisterJavaFuzzBuildComponents(ctx android.RegistrationContext) { func RegisterJavaFuzzBuildComponents(ctx android.RegistrationContext) {
ctx.RegisterModuleType("java_fuzz", JavaFuzzFactory) ctx.RegisterModuleType("java_fuzz", JavaFuzzFactory)
ctx.RegisterModuleType("java_fuzz_host", JavaFuzzHostFactory) ctx.RegisterSingletonType("java_fuzz_packaging", javaFuzzPackagingFactory)
ctx.RegisterSingletonType("java_fuzz_host_packaging", javaFuzzHostPackagingFactory)
ctx.RegisterSingletonType("java_fuzz_device_packaging", javaFuzzDevicePackagingFactory)
} }
type JavaFuzzLibrary struct { type JavaFuzzTest struct {
Library Test
fuzzPackagedModule fuzz.FuzzPackagedModule fuzzPackagedModule fuzz.FuzzPackagedModule
jniProperties jniProperties
jniFilePaths android.Paths jniFilePaths android.Paths
} }
// IsSanitizerEnabledForJni implemented to make JavaFuzzLibrary implement // java_fuzz builds and links sources into a `.jar` file for the device.
// cc.JniSanitizeable. It returns a bool for whether a cc dependency should be // This generates .class files in a jar which can then be instrumented before
// sanitized for the given sanitizer or not. // fuzzing in Android Runtime (ART: Android OS on emulator or device)
func (j *JavaFuzzLibrary) IsSanitizerEnabledForJni(ctx android.BaseModuleContext, sanitizerName string) bool { func JavaFuzzFactory() android.Module {
// TODO: once b/231370928 is resolved, please uncomment the loop module := &JavaFuzzTest{}
// for _, s := range j.jniProperties.Sanitizers {
// if sanitizerName == s { module.addHostAndDeviceProperties()
// return true module.AddProperties(&module.testProperties)
// } module.AddProperties(&module.fuzzPackagedModule.FuzzProperties)
// }
return false module.Module.properties.Installable = proptools.BoolPtr(true)
module.Module.dexpreopter.isTest = true
module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
android.AddLoadHook(module, func(ctx android.LoadHookContext) {
disableLinuxBionic := struct {
Target struct {
Linux_bionic struct {
Enabled *bool
}
}
}{}
disableLinuxBionic.Target.Linux_bionic.Enabled = proptools.BoolPtr(false)
ctx.AppendProperties(&disableLinuxBionic)
})
InitJavaModuleMultiTargets(module, android.HostAndDeviceSupported)
return module
} }
func (j *JavaFuzzLibrary) DepsMutator(mctx android.BottomUpMutatorContext) { func (j *JavaFuzzTest) DepsMutator(ctx android.BottomUpMutatorContext) {
if len(j.jniProperties.Jni_libs) > 0 { if len(j.testProperties.Jni_libs) > 0 {
if j.fuzzPackagedModule.FuzzProperties.Fuzz_config == nil { for _, target := range ctx.MultiTargets() {
config := &fuzz.FuzzConfig{}
j.fuzzPackagedModule.FuzzProperties.Fuzz_config = config
}
// this will be used by the ingestion pipeline to determine the version
// of jazzer to add to the fuzzer package
j.fuzzPackagedModule.FuzzProperties.Fuzz_config.IsJni = proptools.BoolPtr(true)
for _, target := range mctx.MultiTargets() {
sharedLibVariations := append(target.Variations(), blueprint.Variation{Mutator: "link", Variation: "shared"}) sharedLibVariations := append(target.Variations(), blueprint.Variation{Mutator: "link", Variation: "shared"})
mctx.AddFarVariationDependencies(sharedLibVariations, cc.JniFuzzLibTag, j.jniProperties.Jni_libs...) ctx.AddFarVariationDependencies(sharedLibVariations, jniLibTag, j.testProperties.Jni_libs...)
} }
} }
j.Library.DepsMutator(mctx)
j.deps(ctx)
} }
func (j *JavaFuzzLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) { func (j *JavaFuzzTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
if j.fuzzPackagedModule.FuzzProperties.Corpus != nil { if j.fuzzPackagedModule.FuzzProperties.Corpus != nil {
j.fuzzPackagedModule.Corpus = android.PathsForModuleSrc(ctx, j.fuzzPackagedModule.FuzzProperties.Corpus) j.fuzzPackagedModule.Corpus = android.PathsForModuleSrc(ctx, j.fuzzPackagedModule.FuzzProperties.Corpus)
} }
@@ -105,21 +105,15 @@ func (j *JavaFuzzLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext)
} }
_, sharedDeps := cc.CollectAllSharedDependencies(ctx) _, sharedDeps := cc.CollectAllSharedDependencies(ctx)
for _, dep := range sharedDeps { for _, dep := range sharedDeps {
sharedLibInfo := ctx.OtherModuleProvider(dep, cc.SharedLibraryInfoProvider).(cc.SharedLibraryInfo) sharedLibInfo := ctx.OtherModuleProvider(dep, cc.SharedLibraryInfoProvider).(cc.SharedLibraryInfo)
if sharedLibInfo.SharedLibrary != nil { if sharedLibInfo.SharedLibrary != nil {
// The .class jars are output in slightly different locations arch := "lib"
// relative to the jni libs. Therefore, for consistency across
// host and device fuzzers of jni lib location, we save it in a
// native_libs directory.
var relPath string
if sharedLibInfo.Target.Arch.ArchType.Multilib == "lib64" { if sharedLibInfo.Target.Arch.ArchType.Multilib == "lib64" {
relPath = filepath.Join("lib64", sharedLibInfo.SharedLibrary.Base()) arch = "lib64"
} else {
relPath = filepath.Join("lib", sharedLibInfo.SharedLibrary.Base())
} }
libPath := android.PathForModuleOut(ctx, relPath)
libPath := android.PathForModuleOut(ctx, filepath.Join(arch, sharedLibInfo.SharedLibrary.Base()))
ctx.Build(pctx, android.BuildParams{ ctx.Build(pctx, android.BuildParams{
Rule: android.Cp, Rule: android.Cp,
Input: sharedLibInfo.SharedLibrary, Input: sharedLibInfo.SharedLibrary,
@@ -129,104 +123,35 @@ func (j *JavaFuzzLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext)
} else { } else {
ctx.PropertyErrorf("jni_libs", "%q of type %q is not supported", dep.Name(), ctx.OtherModuleType(dep)) ctx.PropertyErrorf("jni_libs", "%q of type %q is not supported", dep.Name(), ctx.OtherModuleType(dep))
} }
} }
j.Library.GenerateAndroidBuildActions(ctx) j.Test.GenerateAndroidBuildActions(ctx)
} }
// java_fuzz_host builds and links sources into a `.jar` file for the host. type javaFuzzPackager struct {
//
// By default, a java_fuzz produces a `.jar` file containing `.class` files.
// This jar is not suitable for installing on a device.
func JavaFuzzHostFactory() android.Module {
module := &JavaFuzzLibrary{}
module.addHostProperties()
module.AddProperties(&module.jniProperties)
module.Module.properties.Installable = proptools.BoolPtr(true)
module.AddProperties(&module.fuzzPackagedModule.FuzzProperties)
// java_fuzz packaging rules collide when both linux_glibc and linux_bionic are enabled, disable the linux_bionic variants.
android.AddLoadHook(module, func(ctx android.LoadHookContext) {
disableLinuxBionic := struct {
Target struct {
Linux_bionic struct {
Enabled *bool
}
}
}{}
disableLinuxBionic.Target.Linux_bionic.Enabled = proptools.BoolPtr(false)
ctx.AppendProperties(&disableLinuxBionic)
})
InitJavaModuleMultiTargets(module, android.HostSupportedNoCross)
return module
}
// java_fuzz builds and links sources into a `.jar` file for the device.
// This generates .class files in a jar which can then be instrumented before
// fuzzing in Android Runtime (ART: Android OS on emulator or device)
func JavaFuzzFactory() android.Module {
module := &JavaFuzzLibrary{}
module.addHostAndDeviceProperties()
module.AddProperties(&module.jniProperties)
module.Module.properties.Installable = proptools.BoolPtr(true)
module.AddProperties(&module.fuzzPackagedModule.FuzzProperties)
module.Module.dexpreopter.isTest = true
module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
InitJavaModuleMultiTargets(module, android.DeviceSupported)
return module
}
// Responsible for generating rules that package host fuzz targets into
// a zip file.
type javaFuzzHostPackager struct {
fuzz.FuzzPackager fuzz.FuzzPackager
} }
// Responsible for generating rules that package device fuzz targets into func javaFuzzPackagingFactory() android.Singleton {
// a zip file. return &javaFuzzPackager{}
type javaFuzzDevicePackager struct {
fuzz.FuzzPackager
} }
func javaFuzzHostPackagingFactory() android.Singleton { func (s *javaFuzzPackager) GenerateBuildActions(ctx android.SingletonContext) {
return &javaFuzzHostPackager{}
}
func javaFuzzDevicePackagingFactory() android.Singleton {
return &javaFuzzDevicePackager{}
}
func (s *javaFuzzHostPackager) GenerateBuildActions(ctx android.SingletonContext) {
generateBuildActions(&s.FuzzPackager, hostString, ctx)
}
func (s *javaFuzzDevicePackager) GenerateBuildActions(ctx android.SingletonContext) {
generateBuildActions(&s.FuzzPackager, targetString, ctx)
}
func generateBuildActions(s *fuzz.FuzzPackager, hostOrTargetString string, ctx android.SingletonContext) {
// Map between each architecture + host/device combination. // Map between each architecture + host/device combination.
archDirs := make(map[fuzz.ArchOs][]fuzz.FileToZip) archDirs := make(map[fuzz.ArchOs][]fuzz.FileToZip)
// List of individual fuzz targets.
s.FuzzTargets = make(map[string]bool) s.FuzzTargets = make(map[string]bool)
ctx.VisitAllModules(func(module android.Module) { ctx.VisitAllModules(func(module android.Module) {
// Discard non-fuzz targets. // Discard non-fuzz targets.
javaFuzzModule, ok := module.(*JavaFuzzLibrary) javaFuzzModule, ok := module.(*JavaFuzzTest)
if !ok { if !ok {
return return
} }
if hostOrTargetString == hostString { hostOrTargetString := "target"
if !javaFuzzModule.Host() { if javaFuzzModule.Host() {
return hostOrTargetString = "host"
}
} else if hostOrTargetString == targetString {
if javaFuzzModule.Host() || javaFuzzModule.Target().HostCross {
return
}
} }
fuzzModuleValidator := fuzz.FuzzModule{ fuzzModuleValidator := fuzz.FuzzModule{
@@ -246,7 +171,7 @@ func generateBuildActions(s *fuzz.FuzzPackager, hostOrTargetString string, ctx a
var files []fuzz.FileToZip var files []fuzz.FileToZip
builder := android.NewRuleBuilder(pctx, ctx) builder := android.NewRuleBuilder(pctx, ctx)
// Package the artifacts (data, corpus, config and dictionary into a zipfile. // Package the artifacts (data, corpus, config and dictionary) into a zipfile.
files = s.PackageArtifacts(ctx, module, javaFuzzModule.fuzzPackagedModule, archDir, builder) files = s.PackageArtifacts(ctx, module, javaFuzzModule.fuzzPackagedModule, archDir, builder)
// Add .jar // Add .jar
@@ -261,27 +186,14 @@ func generateBuildActions(s *fuzz.FuzzPackager, hostOrTargetString string, ctx a
if !ok { if !ok {
return return
} }
}) })
s.CreateFuzzPackage(ctx, archDirs, fuzz.Java, pctx) s.CreateFuzzPackage(ctx, archDirs, fuzz.Java, pctx)
} }
func (s *javaFuzzHostPackager) MakeVars(ctx android.MakeVarsContext) { func (s *javaFuzzPackager) MakeVars(ctx android.MakeVarsContext) {
packages := s.Packages.Strings() packages := s.Packages.Strings()
sort.Strings(packages) sort.Strings(packages)
ctx.Strict("SOONG_JAVA_FUZZ_PACKAGING_ARCH_MODULES", strings.Join(packages, " "))
ctx.Strict("SOONG_JAVA_FUZZ_HOST_PACKAGING_ARCH_MODULES", strings.Join(packages, " "))
// Preallocate the slice of fuzz targets to minimize memory allocations. // Preallocate the slice of fuzz targets to minimize memory allocations.
s.PreallocateSlice(ctx, "ALL_JAVA_FUZZ_HOST_TARGETS") s.PreallocateSlice(ctx, "ALL_JAVA_FUZZ_TARGETS")
}
func (s *javaFuzzDevicePackager) MakeVars(ctx android.MakeVarsContext) {
packages := s.Packages.Strings()
sort.Strings(packages)
ctx.Strict("SOONG_JAVA_FUZZ_DEVICE_PACKAGING_ARCH_MODULES", strings.Join(packages, " "))
// Preallocate the slice of fuzz targets to minimize memory allocations.
s.PreallocateSlice(ctx, "ALL_JAVA_FUZZ_DEVICE_TARGETS")
} }

View File

@@ -31,17 +31,15 @@ var prepForJavaFuzzTest = android.GroupFixturePreparers(
func TestJavaFuzz(t *testing.T) { func TestJavaFuzz(t *testing.T) {
result := prepForJavaFuzzTest.RunTestWithBp(t, ` result := prepForJavaFuzzTest.RunTestWithBp(t, `
java_fuzz_host { java_fuzz {
name: "foo", name: "foo",
srcs: ["a.java"], srcs: ["a.java"],
host_supported: true,
device_supported: false,
libs: ["bar"], libs: ["bar"],
static_libs: ["baz"], static_libs: ["baz"],
jni_libs: [ jni_libs: [
"libjni", "libjni",
],
sanitizers: [
"address",
"fuzzer",
], ],
} }
@@ -84,7 +82,7 @@ func TestJavaFuzz(t *testing.T) {
} }
ctx := result.TestContext ctx := result.TestContext
foo := ctx.ModuleForTests("foo", osCommonTarget).Module().(*JavaFuzzLibrary) foo := ctx.ModuleForTests("foo", osCommonTarget).Module().(*JavaFuzzTest)
expected := "lib64/libjni.so" expected := "lib64/libjni.so"
if runtime.GOOS == "darwin" { if runtime.GOOS == "darwin" {

View File

@@ -1156,7 +1156,6 @@ func (j *TestHost) DepsMutator(ctx android.BottomUpMutatorContext) {
} }
j.addDataDeviceBinsDeps(ctx) j.addDataDeviceBinsDeps(ctx)
j.deps(ctx) j.deps(ctx)
} }