Merge "Remove global state from sysprop libraries" (5e510d62) · Commits · e / os / android_build_soong

java/Android.bp

+0 −1

Original line number	Diff line number	Diff line
		@@ -58,7 +58,6 @@ bootstrap_go_package {
		"sdk_library.go",
		"sdk_library_external.go",
		"support_libraries.go",
		"sysprop.go",
		"system_modules.go",
		"testing.go",
		"tradefed.go",

java/java.go

+62 −53

Original line number	Diff line number	Diff line
		@@ -370,6 +370,10 @@ type CompilerDeviceProperties struct {
		// If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
		// Defaults to false.
		V4_signature *bool

		// Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
		// public stubs library.
		SyspropPublicStub string `blueprint:"mutated"`
		}

		// Functionality common to Module and Import
		@@ -580,6 +584,16 @@ type JavaInfo struct {

		var JavaInfoProvider = blueprint.NewProvider(JavaInfo{})

		// SyspropPublicStubInfo contains info about the sysprop public stub library that corresponds to
		// the sysprop implementation library.
		type SyspropPublicStubInfo struct {
		// JavaInfo is the JavaInfoProvider of the sysprop public stub library that corresponds to
		// the sysprop implementation library.
		JavaInfo JavaInfo
		}

		var SyspropPublicStubInfoProvider = blueprint.NewProvider(SyspropPublicStubInfo{})

		// Methods that need to be implemented for a module that is added to apex java_libs property.
		type ApexDependency interface {
		HeaderJars() android.Paths
		@@ -666,6 +680,7 @@ var (
		instrumentationForTag = dependencyTag{name: "instrumentation_for"}
		extraLintCheckTag = dependencyTag{name: "extra-lint-check"}
		jniLibTag = dependencyTag{name: "jnilib"}
		syspropPublicStubDepTag = dependencyTag{name: "sysprop public stub"}
		jniInstallTag = installDependencyTag{name: "jni install"}
		binaryInstallTag = installDependencyTag{name: "binary install"}
		usesLibTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion)
		@@ -810,35 +825,17 @@ func (j *Module) deps(ctx android.BottomUpMutatorContext) {
		j.linter.deps(ctx)

		sdkDeps(ctx, sdkContext(j), j.dexer)
		}

		syspropPublicStubs := syspropPublicStubs(ctx.Config())

		// rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
		// and redirects dependency to public stub depending on the link type.
		rewriteSyspropLibs := func(libs []string, prop string) []string {
		// make a copy
		ret := android.CopyOf(libs)

		for idx, lib := range libs {
		stub, ok := syspropPublicStubs[lib]

		if !ok {
		continue
		}

		linkType, _ := j.getLinkType(ctx.ModuleName())
		// only platform modules can use internal props
		if linkType != javaPlatform {
		ret[idx] = stub
		}
		if j.deviceProperties.SyspropPublicStub != "" {
		// This is a sysprop implementation library that has a corresponding sysprop public
		// stubs library, and a dependency on it so that dependencies on the implementation can
		// be forwarded to the public stubs library when necessary.
		ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
		}

		return ret
		}

		libDeps := ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
		ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
		libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
		ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)

		// Add dependency on libraries that provide additional hidden api annotations.
		ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
		@@ -853,15 +850,11 @@ func (j *Module) deps(ctx android.BottomUpMutatorContext) {
		// if true, enable enforcement
		// PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
		// exception list of java_library names to allow inter-partition dependency
		for idx, lib := range j.properties.Libs {
		for idx := range j.properties.Libs {
		if libDeps[idx] == nil {
		continue
		}

		if _, ok := syspropPublicStubs[lib]; ok {
		continue
		}

		if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
		// java_sdk_library is always allowed at inter-partition dependency.
		// So, skip check.
		@@ -1131,6 +1124,8 @@ func (j *Module) collectDeps(ctx android.ModuleContext) deps {
		}
		}

		linkType, _ := j.getLinkType(ctx.ModuleName())

		ctx.VisitDirectDeps(func(module android.Module) {
		otherName := ctx.OtherModuleName(module)
		tag := ctx.OtherModuleDependencyTag(module)
		@@ -1153,6 +1148,14 @@ func (j *Module) collectDeps(ctx android.ModuleContext) deps {
		}
		} else if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
		dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
		if linkType != javaPlatform &&
		ctx.OtherModuleHasProvider(module, SyspropPublicStubInfoProvider) {
		// dep is a sysprop implementation library, but this module is not linking against
		// the platform, so it gets the sysprop public stubs library instead. Replace
		// dep with the JavaInfo from the SyspropPublicStubInfoProvider.
		syspropDep := ctx.OtherModuleProvider(module, SyspropPublicStubInfoProvider).(SyspropPublicStubInfo)
		dep = syspropDep.JavaInfo
		}
		switch tag {
		case bootClasspathTag:
		deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
		@@ -1211,6 +1214,12 @@ func (j *Module) collectDeps(ctx android.ModuleContext) deps {
		deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
		case kotlinAnnotationsTag:
		deps.kotlinAnnotations = dep.HeaderJars
		case syspropPublicStubDepTag:
		// This is a sysprop implementation library, forward the JavaInfoProvider from
		// the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
		ctx.SetProvider(SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
		JavaInfo: dep,
		})
		}
		} else if dep, ok := module.(android.SourceFileProducer); ok {
		switch tag {

java/sdk_library_external.go

+9 −0

Original line number	Diff line number	Diff line
		@@ -75,10 +75,15 @@ func (j *Module) allowListedInterPartitionJavaLibrary(ctx android.EarlyModuleCon
		return inList(j.Name(), ctx.Config().InterPartitionJavaLibraryAllowList())
		}

		func (j *Module) syspropWithPublicStubs() bool {
		return j.deviceProperties.SyspropPublicStub != ""
		}

		type javaSdkLibraryEnforceContext interface {
		Name() string
		allowListedInterPartitionJavaLibrary(ctx android.EarlyModuleContext) bool
		partitionGroup(ctx android.EarlyModuleContext) partitionGroup
		syspropWithPublicStubs() bool
		}

		var _ javaSdkLibraryEnforceContext = (*Module)(nil)
		@@ -88,6 +93,10 @@ func (j *Module) checkPartitionsForJavaDependency(ctx android.EarlyModuleContext
		return
		}

		if dep.syspropWithPublicStubs() {
		return
		}

		// If product interface is not enforced, skip check between system and product partition.
		// But still need to check between product and vendor partition because product interface flag
		// just represents enforcement between product and system, and vendor interface enforcement

java/sysprop.go

deleted100644 → 0

+0 −64

Original line number	Diff line number	Diff line
		// 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 java

		// This file contains a map to redirect dependencies towards sysprop_library. If a sysprop_library
		// is owned by Platform, and the client module links against system API, the public stub of the
		// sysprop_library should be used. The map will contain public stub names of sysprop_libraries.

		import (
		"sync"

		"android/soong/android"
		)

		type syspropLibraryInterface interface {
		BaseModuleName() string
		Owner() string
		HasPublicStub() bool
		JavaPublicStubName() string
		}

		var (
		syspropPublicStubsKey = android.NewOnceKey("syspropPublicStubsJava")
		syspropPublicStubsLock sync.Mutex
		)

		func init() {
		android.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
		ctx.BottomUp("sysprop_java", SyspropMutator).Parallel()
		})
		}

		func syspropPublicStubs(config android.Config) map[string]string {
		return config.Once(syspropPublicStubsKey, func() interface{} {
		return make(map[string]string)
		}).(map[string]string)
		}

		// gather list of sysprop libraries owned by platform.
		func SyspropMutator(mctx android.BottomUpMutatorContext) {
		if m, ok := mctx.Module().(syspropLibraryInterface); ok {
		if m.Owner() != "Platform" \|\| !m.HasPublicStub() {
		return
		}

		syspropPublicStubs := syspropPublicStubs(mctx.Config())
		syspropPublicStubsLock.Lock()
		defer syspropPublicStubsLock.Unlock()

		syspropPublicStubs[m.BaseModuleName()] = m.JavaPublicStubName()
		}
		}

sysprop/sysprop_library.go

+49 −60

Original line number	Diff line number	Diff line
		@@ -40,6 +40,7 @@ type syspropGenProperties struct {
		Srcs []string `android:"path"`
		Scope string
		Name *string
		Check_api *string
		}

		type syspropJavaGenRule struct {
		@@ -68,10 +69,6 @@ var (
		func init() {
		pctx.HostBinToolVariable("soongZipCmd", "soong_zip")
		pctx.HostBinToolVariable("syspropJavaCmd", "sysprop_java")

		android.PreArchMutators(func(ctx android.RegisterMutatorsContext) {
		ctx.BottomUp("sysprop_deps", syspropDepsMutator).Parallel()
		})
		}

		// syspropJavaGenRule module generates srcjar containing generated java APIs.
		@@ -103,6 +100,12 @@ func (g *syspropJavaGenRule) GenerateAndroidBuildActions(ctx android.ModuleConte
		}
		}

		func (g *syspropJavaGenRule) DepsMutator(ctx android.BottomUpMutatorContext) {
		// Add a dependency from the stubs to sysprop library so that the generator rule can depend on
		// the check API rule of the sysprop library.
		ctx.AddFarVariationDependencies(nil, nil, proptools.String(g.properties.Check_api))
		}

		func (g *syspropJavaGenRule) OutputFiles(tag string) (android.Paths, error) {
		switch tag {
		case "":
		@@ -157,9 +160,6 @@ type syspropLibraryProperties struct {
		// If set to true, build a variant of the module for the host. Defaults to false.
		Host_supported *bool

		// Whether public stub exists or not.
		Public_stub *bool `blueprint:"mutated"`

		Cpp struct {
		// Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
		// Forwarded to cc_library.min_sdk_version
		@@ -202,12 +202,9 @@ func (m *syspropLibrary) CcImplementationModuleName() string {
		return "lib" + m.BaseModuleName()
		}

		func (m *syspropLibrary) JavaPublicStubName() string {
		if proptools.Bool(m.properties.Public_stub) {
		func (m *syspropLibrary) javaPublicStubName() string {
		return m.BaseModuleName() + "_public"
		}
		return ""
		}

		func (m *syspropLibrary) javaGenModuleName() string {
		return m.BaseModuleName() + "_java_gen"
		@@ -221,10 +218,6 @@ func (m *syspropLibrary) BaseModuleName() string {
		return m.ModuleBase.Name()
		}

		func (m *syspropLibrary) HasPublicStub() bool {
		return proptools.Bool(m.properties.Public_stub)
		}

		func (m *syspropLibrary) CurrentSyspropApiFile() android.OptionalPath {
		return m.currentApiFile
		}
		@@ -409,6 +402,7 @@ type javaLibraryProperties struct {
		Installable *bool
		Libs []string
		Stem *string
		SyspropPublicStub string
		}

		func syspropLibraryHook(ctx android.LoadHookContext, m *syspropLibrary) {
		@@ -493,8 +487,17 @@ func syspropLibraryHook(ctx android.LoadHookContext, m *syspropLibrary) {
		Srcs: m.properties.Srcs,
		Scope: scope,
		Name: proptools.StringPtr(m.javaGenModuleName()),
		Check_api: proptools.StringPtr(ctx.ModuleName()),
		})

		// if platform sysprop_library is installed in /system or /system-ext, we regard it as an API
		// and allow any modules (even from different partition) to link against the sysprop_library.
		// To do that, we create a public stub and expose it to modules with sdk_version: system_*.
		var publicStub string
		if isOwnerPlatform && installedInSystem {
		publicStub = m.javaPublicStubName()
		}

		ctx.CreateModule(java.LibraryFactory, &javaLibraryProperties{
		Name: proptools.StringPtr(m.BaseModuleName()),
		Srcs: []string{":" + m.javaGenModuleName()},
		@@ -504,21 +507,19 @@ func syspropLibraryHook(ctx android.LoadHookContext, m *syspropLibrary) {
		Installable: m.properties.Installable,
		Sdk_version: proptools.StringPtr("core_current"),
		Libs: []string{javaSyspropStub},
		SyspropPublicStub: publicStub,
		})

		// if platform sysprop_library is installed in /system or /system-ext, we regard it as an API
		// and allow any modules (even from different partition) to link against the sysprop_library.
		// To do that, we create a public stub and expose it to modules with sdk_version: system_*.
		if isOwnerPlatform && installedInSystem {
		m.properties.Public_stub = proptools.BoolPtr(true)
		if publicStub != "" {
		ctx.CreateModule(syspropJavaGenFactory, &syspropGenProperties{
		Srcs: m.properties.Srcs,
		Scope: "public",
		Name: proptools.StringPtr(m.javaGenPublicStubName()),
		Check_api: proptools.StringPtr(ctx.ModuleName()),
		})

		ctx.CreateModule(java.LibraryFactory, &javaLibraryProperties{
		Name: proptools.StringPtr(m.JavaPublicStubName()),
		Name: proptools.StringPtr(publicStub),
		Srcs: []string{":" + m.javaGenPublicStubName()},
		Installable: proptools.BoolPtr(false),
		Sdk_version: proptools.StringPtr("core_current"),
		@@ -537,15 +538,3 @@ func syspropLibraryHook(ctx android.LoadHookContext, m *syspropLibrary) {
		libraries = append(libraries, "//"+ctx.ModuleDir()+":"+ctx.ModuleName())
		}
		}

		// syspropDepsMutator adds dependencies from java implementation library to sysprop library.
		// java implementation library then depends on check API rule of sysprop library.
		func syspropDepsMutator(ctx android.BottomUpMutatorContext) {
		if m, ok := ctx.Module().(*syspropLibrary); ok {
		ctx.AddReverseDependency(m, nil, m.javaGenModuleName())

		if proptools.Bool(m.properties.Public_stub) {
		ctx.AddReverseDependency(m, nil, m.javaGenPublicStubName())
		}
		}
		}