f9b1da0fcb
The registration of module types and singletons is duplicated between init() functions that register them for use in the build runtime and test context creation code that registers them for testing. This is a proof of concept for a mechanism that will allow the code to be shared. It defines a RegistrationContext interface that is implemented by both the TestContext and the new initRegistrationContext type. An instance of the the latter is available through the InitRegistrationContext variable. The intent is that the registration of the module types and singleton types will be extracted from the init() function into a separate function that takes a RegistrationContext parameter. That method is called from init() passing in the InitRegistrationContext and from a test passing in the TestContext. Something like this: func init() { RegisterBuildComponents(android.InitRegistrationContext) } func RegisterBuildComponents(ctx android.RegistrationContext) { ctx.RegisterModuleType(....) .... } A test would do something like this: ctx := android.NewTestContext() RegisterBuildComponents(ctx) Test: m nothing Change-Id: I97173cabb6d6cf7ce98fdb5f73418438b1997b35
1298 lines
45 KiB
Go
Executable file
1298 lines
45 KiB
Go
Executable file
// Copyright 2015 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
|
|
|
|
// This file contains the module types for compiling Android apps.
|
|
|
|
import (
|
|
"path/filepath"
|
|
"reflect"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/google/blueprint"
|
|
"github.com/google/blueprint/proptools"
|
|
|
|
"android/soong/android"
|
|
"android/soong/cc"
|
|
"android/soong/tradefed"
|
|
)
|
|
|
|
var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"}
|
|
|
|
func init() {
|
|
RegisterAppBuildComponents(android.InitRegistrationContext)
|
|
|
|
initAndroidAppImportVariantGroupTypes()
|
|
}
|
|
|
|
func RegisterAppBuildComponents(ctx android.RegistrationContext) {
|
|
ctx.RegisterModuleType("android_app", AndroidAppFactory)
|
|
ctx.RegisterModuleType("android_test", AndroidTestFactory)
|
|
ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
|
|
ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
|
|
ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
|
|
ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
|
|
ctx.RegisterModuleType("android_app_import", AndroidAppImportFactory)
|
|
ctx.RegisterModuleType("android_test_import", AndroidTestImportFactory)
|
|
}
|
|
|
|
// AndroidManifest.xml merging
|
|
// package splits
|
|
|
|
type appProperties struct {
|
|
// Names of extra android_app_certificate modules to sign the apk with in the form ":module".
|
|
Additional_certificates []string
|
|
|
|
// If set, create package-export.apk, which other packages can
|
|
// use to get PRODUCT-agnostic resource data like IDs and type definitions.
|
|
Export_package_resources *bool
|
|
|
|
// Specifies that this app should be installed to the priv-app directory,
|
|
// where the system will grant it additional privileges not available to
|
|
// normal apps.
|
|
Privileged *bool
|
|
|
|
// list of resource labels to generate individual resource packages
|
|
Package_splits []string
|
|
|
|
// Names of modules to be overridden. Listed modules can only be other binaries
|
|
// (in Make or Soong).
|
|
// This does not completely prevent installation of the overridden binaries, but if both
|
|
// binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
|
|
// from PRODUCT_PACKAGES.
|
|
Overrides []string
|
|
|
|
// list of native libraries that will be provided in or alongside the resulting jar
|
|
Jni_libs []string `android:"arch_variant"`
|
|
|
|
// STL library to use for JNI libraries.
|
|
Stl *string `android:"arch_variant"`
|
|
|
|
// Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
|
|
// flag so that they are used from inside the APK at runtime. Defaults to true for android_test modules unless
|
|
// sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
|
|
// android_app modules that are embedded to APEXes, defaults to false for other module types where the native
|
|
// libraries are generally preinstalled outside the APK.
|
|
Use_embedded_native_libs *bool
|
|
|
|
// Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
|
|
// they are used from inside the APK at runtime.
|
|
Use_embedded_dex *bool
|
|
|
|
// Forces native libraries to always be packaged into the APK,
|
|
// Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
|
|
// True for android_test* modules.
|
|
AlwaysPackageNativeLibs bool `blueprint:"mutated"`
|
|
|
|
// If set, find and merge all NOTICE files that this module and its dependencies have and store
|
|
// it in the APK as an asset.
|
|
Embed_notices *bool
|
|
}
|
|
|
|
// android_app properties that can be overridden by override_android_app
|
|
type overridableAppProperties struct {
|
|
// The name of a certificate in the default certificate directory, blank to use the default product certificate,
|
|
// or an android_app_certificate module name in the form ":module".
|
|
Certificate *string
|
|
|
|
// the package name of this app. The package name in the manifest file is used if one was not given.
|
|
Package_name *string
|
|
}
|
|
|
|
type AndroidApp struct {
|
|
Library
|
|
aapt
|
|
android.OverridableModuleBase
|
|
|
|
usesLibrary usesLibrary
|
|
|
|
certificate Certificate
|
|
|
|
appProperties appProperties
|
|
|
|
overridableAppProperties overridableAppProperties
|
|
|
|
installJniLibs []jniLib
|
|
|
|
bundleFile android.Path
|
|
|
|
// the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
|
|
installApkName string
|
|
|
|
installDir android.InstallPath
|
|
|
|
onDeviceDir string
|
|
|
|
additionalAaptFlags []string
|
|
|
|
noticeOutputs android.NoticeOutputs
|
|
}
|
|
|
|
func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
|
|
return nil
|
|
}
|
|
|
|
func (a *AndroidApp) ExportedStaticPackages() android.Paths {
|
|
return nil
|
|
}
|
|
|
|
func (a *AndroidApp) OutputFile() android.Path {
|
|
return a.outputFile
|
|
}
|
|
|
|
var _ AndroidLibraryDependency = (*AndroidApp)(nil)
|
|
|
|
type Certificate struct {
|
|
Pem, Key android.Path
|
|
}
|
|
|
|
func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
|
|
a.Module.deps(ctx)
|
|
|
|
if String(a.appProperties.Stl) == "c++_shared" && a.sdkVersion() == "" {
|
|
ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
|
|
}
|
|
|
|
sdkDep := decodeSdkDep(ctx, sdkContext(a))
|
|
if sdkDep.hasFrameworkLibs() {
|
|
a.aapt.deps(ctx, sdkDep)
|
|
}
|
|
|
|
tag := &jniDependencyTag{}
|
|
for _, jniTarget := range ctx.MultiTargets() {
|
|
variation := append(jniTarget.Variations(),
|
|
blueprint.Variation{Mutator: "link", Variation: "shared"})
|
|
ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
|
|
}
|
|
|
|
a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
|
|
}
|
|
|
|
func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
|
|
cert := android.SrcIsModule(a.getCertString(ctx))
|
|
if cert != "" {
|
|
ctx.AddDependency(ctx.Module(), certificateTag, cert)
|
|
}
|
|
|
|
for _, cert := range a.appProperties.Additional_certificates {
|
|
cert = android.SrcIsModule(cert)
|
|
if cert != "" {
|
|
ctx.AddDependency(ctx.Module(), certificateTag, cert)
|
|
} else {
|
|
ctx.PropertyErrorf("additional_certificates",
|
|
`must be names of android_app_certificate modules in the form ":module"`)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
a.generateAndroidBuildActions(ctx)
|
|
}
|
|
|
|
func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
a.checkPlatformAPI(ctx)
|
|
a.checkSdkVersion(ctx)
|
|
a.generateAndroidBuildActions(ctx)
|
|
}
|
|
|
|
// Returns true if the native libraries should be stored in the APK uncompressed and the
|
|
// extractNativeLibs application flag should be set to false in the manifest.
|
|
func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
|
|
minSdkVersion, err := sdkVersionToNumber(ctx, a.minSdkVersion())
|
|
if err != nil {
|
|
ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
|
|
}
|
|
|
|
return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
|
|
!a.IsForPlatform()
|
|
}
|
|
|
|
// Returns whether this module should have the dex file stored uncompressed in the APK.
|
|
func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
|
|
if Bool(a.appProperties.Use_embedded_dex) {
|
|
return true
|
|
}
|
|
|
|
// Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
|
|
// be preinstalled as prebuilts).
|
|
if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
|
|
return true
|
|
}
|
|
|
|
if ctx.Config().UnbundledBuild() {
|
|
return false
|
|
}
|
|
|
|
return shouldUncompressDex(ctx, &a.dexpreopter)
|
|
}
|
|
|
|
func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
|
|
return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
|
|
!a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
|
|
}
|
|
|
|
func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
|
|
a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
|
|
|
|
// Ask manifest_fixer to add or update the application element indicating this app has no code.
|
|
a.aapt.hasNoCode = !a.hasCode(ctx)
|
|
|
|
aaptLinkFlags := []string{}
|
|
|
|
// Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided.
|
|
hasProduct := false
|
|
for _, f := range a.aaptProperties.Aaptflags {
|
|
if strings.HasPrefix(f, "--product") {
|
|
hasProduct = true
|
|
break
|
|
}
|
|
}
|
|
if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
|
|
aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
|
|
}
|
|
|
|
if !Bool(a.aaptProperties.Aapt_include_all_resources) {
|
|
// Product AAPT config
|
|
for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
|
|
aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
|
|
}
|
|
|
|
// Product AAPT preferred config
|
|
if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
|
|
aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
|
|
}
|
|
}
|
|
|
|
manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
|
|
if overridden || a.overridableAppProperties.Package_name != nil {
|
|
// The product override variable has a priority over the package_name property.
|
|
if !overridden {
|
|
manifestPackageName = *a.overridableAppProperties.Package_name
|
|
}
|
|
aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
|
|
}
|
|
|
|
aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
|
|
|
|
a.aapt.splitNames = a.appProperties.Package_splits
|
|
a.aapt.sdkLibraries = a.exportedSdkLibs
|
|
|
|
a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
|
|
|
|
// apps manifests are handled by aapt, don't let Module see them
|
|
a.properties.Manifest = nil
|
|
}
|
|
|
|
func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
|
|
var staticLibProguardFlagFiles android.Paths
|
|
ctx.VisitDirectDeps(func(m android.Module) {
|
|
if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
|
|
staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
|
|
}
|
|
})
|
|
|
|
staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
|
|
|
|
a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
|
|
a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
|
|
}
|
|
|
|
func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
|
|
|
|
var installDir string
|
|
if ctx.ModuleName() == "framework-res" {
|
|
// framework-res.apk is installed as system/framework/framework-res.apk
|
|
installDir = "framework"
|
|
} else if a.Privileged() {
|
|
installDir = filepath.Join("priv-app", a.installApkName)
|
|
} else {
|
|
installDir = filepath.Join("app", a.installApkName)
|
|
}
|
|
a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
|
|
a.dexpreopter.isInstallable = Bool(a.properties.Installable)
|
|
a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
|
|
|
|
a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
|
|
a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
|
|
a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
|
|
a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
|
|
a.dexpreopter.manifestFile = a.mergedManifestFile
|
|
|
|
a.deviceProperties.UncompressDex = a.dexpreopter.uncompressedDex
|
|
|
|
if ctx.ModuleName() != "framework-res" {
|
|
a.Module.compile(ctx, a.aaptSrcJar)
|
|
}
|
|
|
|
return a.maybeStrippedDexJarFile
|
|
}
|
|
|
|
func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
|
|
var jniJarFile android.WritablePath
|
|
if len(jniLibs) > 0 {
|
|
if a.shouldEmbedJnis(ctx) {
|
|
jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
|
|
TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
|
|
} else {
|
|
a.installJniLibs = jniLibs
|
|
}
|
|
}
|
|
return jniJarFile
|
|
}
|
|
|
|
func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
|
|
// Collect NOTICE files from all dependencies.
|
|
seenModules := make(map[android.Module]bool)
|
|
noticePathSet := make(map[android.Path]bool)
|
|
|
|
ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
|
|
// Have we already seen this?
|
|
if _, ok := seenModules[child]; ok {
|
|
return false
|
|
}
|
|
seenModules[child] = true
|
|
|
|
// Skip host modules.
|
|
if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
|
|
return false
|
|
}
|
|
|
|
path := child.(android.Module).NoticeFile()
|
|
if path.Valid() {
|
|
noticePathSet[path.Path()] = true
|
|
}
|
|
return true
|
|
})
|
|
|
|
// If the app has one, add it too.
|
|
if a.NoticeFile().Valid() {
|
|
noticePathSet[a.NoticeFile().Path()] = true
|
|
}
|
|
|
|
if len(noticePathSet) == 0 {
|
|
return
|
|
}
|
|
var noticePaths []android.Path
|
|
for path := range noticePathSet {
|
|
noticePaths = append(noticePaths, path)
|
|
}
|
|
sort.Slice(noticePaths, func(i, j int) bool {
|
|
return noticePaths[i].String() < noticePaths[j].String()
|
|
})
|
|
|
|
a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
|
|
}
|
|
|
|
// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
|
|
// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
|
|
func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
|
|
if android.SrcIsModule(certPropValue) == "" {
|
|
var mainCert Certificate
|
|
if certPropValue != "" {
|
|
defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
|
|
mainCert = Certificate{
|
|
defaultDir.Join(ctx, certPropValue+".x509.pem"),
|
|
defaultDir.Join(ctx, certPropValue+".pk8"),
|
|
}
|
|
} else {
|
|
pem, key := ctx.Config().DefaultAppCertificate(ctx)
|
|
mainCert = Certificate{pem, key}
|
|
}
|
|
certificates = append([]Certificate{mainCert}, certificates...)
|
|
}
|
|
|
|
if !m.Platform() {
|
|
certPath := certificates[0].Pem.String()
|
|
systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
|
|
if strings.HasPrefix(certPath, systemCertPath) {
|
|
enforceSystemCert := ctx.Config().EnforceSystemCertificate()
|
|
whitelist := ctx.Config().EnforceSystemCertificateWhitelist()
|
|
|
|
if enforceSystemCert && !inList(m.Name(), whitelist) {
|
|
ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
|
|
}
|
|
}
|
|
}
|
|
|
|
return certificates
|
|
}
|
|
|
|
func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
|
|
var apkDeps android.Paths
|
|
|
|
a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
|
|
a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
|
|
|
|
// Check if the install APK name needs to be overridden.
|
|
a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
|
|
|
|
if ctx.ModuleName() == "framework-res" {
|
|
// framework-res.apk is installed as system/framework/framework-res.apk
|
|
a.installDir = android.PathForModuleInstall(ctx, "framework")
|
|
} else if a.Privileged() {
|
|
a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
|
|
} else if ctx.InstallInTestcases() {
|
|
a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
|
|
} else {
|
|
a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
|
|
}
|
|
a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
|
|
|
|
a.noticeBuildActions(ctx)
|
|
if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
|
|
a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
|
|
}
|
|
|
|
// Process all building blocks, from AAPT to certificates.
|
|
a.aaptBuildActions(ctx)
|
|
|
|
if a.usesLibrary.enforceUsesLibraries() {
|
|
manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
|
|
apkDeps = append(apkDeps, manifestCheckFile)
|
|
}
|
|
|
|
a.proguardBuildActions(ctx)
|
|
|
|
dexJarFile := a.dexBuildActions(ctx)
|
|
|
|
jniLibs, certificateDeps := collectAppDeps(ctx, a.shouldEmbedJnis(ctx))
|
|
jniJarFile := a.jniBuildActions(jniLibs, ctx)
|
|
|
|
if ctx.Failed() {
|
|
return
|
|
}
|
|
|
|
certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
|
|
a.certificate = certificates[0]
|
|
|
|
// Build a final signed app package.
|
|
packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
|
|
CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps)
|
|
a.outputFile = packageFile
|
|
|
|
for _, split := range a.aapt.splits {
|
|
// Sign the split APKs
|
|
packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
|
|
CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps)
|
|
a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
|
|
}
|
|
|
|
// Build an app bundle.
|
|
bundleFile := android.PathForModuleOut(ctx, "base.zip")
|
|
BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
|
|
a.bundleFile = bundleFile
|
|
|
|
// Install the app package.
|
|
if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
|
|
ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
|
|
for _, extra := range a.extraOutputFiles {
|
|
ctx.InstallFile(a.installDir, extra.Base(), extra)
|
|
}
|
|
}
|
|
}
|
|
|
|
func collectAppDeps(ctx android.ModuleContext, shouldCollectRecursiveNativeDeps bool) ([]jniLib, []Certificate) {
|
|
var jniLibs []jniLib
|
|
var certificates []Certificate
|
|
seenModulePaths := make(map[string]bool)
|
|
|
|
ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
|
|
otherName := ctx.OtherModuleName(module)
|
|
tag := ctx.OtherModuleDependencyTag(module)
|
|
|
|
if IsJniDepTag(tag) || tag == cc.SharedDepTag {
|
|
if dep, ok := module.(*cc.Module); ok {
|
|
if dep.IsNdk() || dep.IsStubs() {
|
|
return false
|
|
}
|
|
|
|
lib := dep.OutputFile()
|
|
path := lib.Path()
|
|
if seenModulePaths[path.String()] {
|
|
return false
|
|
}
|
|
seenModulePaths[path.String()] = true
|
|
|
|
if lib.Valid() {
|
|
jniLibs = append(jniLibs, jniLib{
|
|
name: ctx.OtherModuleName(module),
|
|
path: path,
|
|
target: module.Target(),
|
|
})
|
|
} else {
|
|
ctx.ModuleErrorf("dependency %q missing output file", otherName)
|
|
}
|
|
} else {
|
|
ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
|
|
}
|
|
|
|
return shouldCollectRecursiveNativeDeps
|
|
}
|
|
|
|
if tag == certificateTag {
|
|
if dep, ok := module.(*AndroidAppCertificate); ok {
|
|
certificates = append(certificates, dep.Certificate)
|
|
} else {
|
|
ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
|
|
}
|
|
}
|
|
|
|
return false
|
|
})
|
|
|
|
return jniLibs, certificates
|
|
}
|
|
|
|
func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
|
|
certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
|
|
if overridden {
|
|
return ":" + certificate
|
|
}
|
|
return String(a.overridableAppProperties.Certificate)
|
|
}
|
|
|
|
// For OutputFileProducer interface
|
|
func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
|
|
switch tag {
|
|
case ".aapt.srcjar":
|
|
return []android.Path{a.aaptSrcJar}, nil
|
|
}
|
|
return a.Library.OutputFiles(tag)
|
|
}
|
|
|
|
func (a *AndroidApp) Privileged() bool {
|
|
return Bool(a.appProperties.Privileged)
|
|
}
|
|
|
|
// android_app compiles sources and Android resources into an Android application package `.apk` file.
|
|
func AndroidAppFactory() android.Module {
|
|
module := &AndroidApp{}
|
|
|
|
module.Module.deviceProperties.Optimize.EnabledByDefault = true
|
|
module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
|
|
|
|
module.Module.properties.Instrument = true
|
|
module.Module.properties.Installable = proptools.BoolPtr(true)
|
|
|
|
module.AddProperties(
|
|
&module.Module.properties,
|
|
&module.Module.deviceProperties,
|
|
&module.Module.dexpreoptProperties,
|
|
&module.Module.protoProperties,
|
|
&module.aaptProperties,
|
|
&module.appProperties,
|
|
&module.overridableAppProperties,
|
|
&module.usesLibrary.usesLibraryProperties)
|
|
|
|
module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
|
|
return class == android.Device && ctx.Config().DevicePrefer32BitApps()
|
|
})
|
|
|
|
android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
|
|
android.InitDefaultableModule(module)
|
|
android.InitOverridableModule(module, &module.appProperties.Overrides)
|
|
android.InitApexModule(module)
|
|
|
|
return module
|
|
}
|
|
|
|
type appTestProperties struct {
|
|
Instrumentation_for *string
|
|
|
|
// if specified, the instrumentation target package name in the manifest is overwritten by it.
|
|
Instrumentation_target_package *string
|
|
}
|
|
|
|
type AndroidTest struct {
|
|
AndroidApp
|
|
|
|
appTestProperties appTestProperties
|
|
|
|
testProperties testProperties
|
|
|
|
testConfig android.Path
|
|
data android.Paths
|
|
}
|
|
|
|
func (a *AndroidTest) InstallInTestcases() bool {
|
|
return true
|
|
}
|
|
|
|
func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
if a.appTestProperties.Instrumentation_target_package != nil {
|
|
a.additionalAaptFlags = append(a.additionalAaptFlags,
|
|
"--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
|
|
} else if a.appTestProperties.Instrumentation_for != nil {
|
|
// Check if the instrumentation target package is overridden.
|
|
manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
|
|
if overridden {
|
|
a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
|
|
}
|
|
}
|
|
a.generateAndroidBuildActions(ctx)
|
|
|
|
a.testConfig = tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
|
|
a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config)
|
|
if a.overridableAppProperties.Package_name != nil {
|
|
fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
|
|
rule := android.NewRuleBuilder()
|
|
rule.Command().BuiltTool(ctx, "test_config_fixer").
|
|
FlagWithInput("--manifest ", a.manifestPath).
|
|
FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name).
|
|
Input(a.testConfig).
|
|
Output(fixedConfig)
|
|
rule.Build(pctx, ctx, "fix_test_config", "fix test config")
|
|
a.testConfig = fixedConfig
|
|
}
|
|
a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
|
|
}
|
|
|
|
func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
|
|
a.AndroidApp.DepsMutator(ctx)
|
|
}
|
|
|
|
func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
|
|
a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
|
|
if a.appTestProperties.Instrumentation_for != nil {
|
|
// The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
|
|
// but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
|
|
// use instrumentationForTag instead of libTag.
|
|
ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
|
|
}
|
|
}
|
|
|
|
// android_test compiles test sources and Android resources into an Android application package `.apk` file and
|
|
// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
|
|
func AndroidTestFactory() android.Module {
|
|
module := &AndroidTest{}
|
|
|
|
module.Module.deviceProperties.Optimize.EnabledByDefault = true
|
|
|
|
module.Module.properties.Instrument = true
|
|
module.Module.properties.Installable = proptools.BoolPtr(true)
|
|
module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
|
|
module.appProperties.AlwaysPackageNativeLibs = true
|
|
module.Module.dexpreopter.isTest = true
|
|
|
|
module.AddProperties(
|
|
&module.Module.properties,
|
|
&module.Module.deviceProperties,
|
|
&module.Module.dexpreoptProperties,
|
|
&module.Module.protoProperties,
|
|
&module.aaptProperties,
|
|
&module.appProperties,
|
|
&module.appTestProperties,
|
|
&module.overridableAppProperties,
|
|
&module.usesLibrary.usesLibraryProperties,
|
|
&module.testProperties)
|
|
|
|
android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
|
|
android.InitDefaultableModule(module)
|
|
android.InitOverridableModule(module, &module.appProperties.Overrides)
|
|
return module
|
|
}
|
|
|
|
type appTestHelperAppProperties struct {
|
|
// list of compatibility suites (for example "cts", "vts") that the module should be
|
|
// installed into.
|
|
Test_suites []string `android:"arch_variant"`
|
|
|
|
// Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
|
|
// doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
|
|
// explicitly.
|
|
Auto_gen_config *bool
|
|
}
|
|
|
|
type AndroidTestHelperApp struct {
|
|
AndroidApp
|
|
|
|
appTestHelperAppProperties appTestHelperAppProperties
|
|
}
|
|
|
|
func (a *AndroidTestHelperApp) InstallInTestcases() bool {
|
|
return true
|
|
}
|
|
|
|
// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
|
|
// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
|
|
// test.
|
|
func AndroidTestHelperAppFactory() android.Module {
|
|
module := &AndroidTestHelperApp{}
|
|
|
|
module.Module.deviceProperties.Optimize.EnabledByDefault = true
|
|
|
|
module.Module.properties.Installable = proptools.BoolPtr(true)
|
|
module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
|
|
module.appProperties.AlwaysPackageNativeLibs = true
|
|
module.Module.dexpreopter.isTest = true
|
|
|
|
module.AddProperties(
|
|
&module.Module.properties,
|
|
&module.Module.deviceProperties,
|
|
&module.Module.dexpreoptProperties,
|
|
&module.Module.protoProperties,
|
|
&module.aaptProperties,
|
|
&module.appProperties,
|
|
&module.appTestHelperAppProperties,
|
|
&module.overridableAppProperties,
|
|
&module.usesLibrary.usesLibraryProperties)
|
|
|
|
android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
|
|
android.InitDefaultableModule(module)
|
|
return module
|
|
}
|
|
|
|
type AndroidAppCertificate struct {
|
|
android.ModuleBase
|
|
properties AndroidAppCertificateProperties
|
|
Certificate Certificate
|
|
}
|
|
|
|
type AndroidAppCertificateProperties struct {
|
|
// Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
|
|
Certificate *string
|
|
}
|
|
|
|
// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
|
|
// the signing key.
|
|
func AndroidAppCertificateFactory() android.Module {
|
|
module := &AndroidAppCertificate{}
|
|
module.AddProperties(&module.properties)
|
|
android.InitAndroidModule(module)
|
|
return module
|
|
}
|
|
|
|
func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
cert := String(c.properties.Certificate)
|
|
c.Certificate = Certificate{
|
|
android.PathForModuleSrc(ctx, cert+".x509.pem"),
|
|
android.PathForModuleSrc(ctx, cert+".pk8"),
|
|
}
|
|
}
|
|
|
|
type OverrideAndroidApp struct {
|
|
android.ModuleBase
|
|
android.OverrideModuleBase
|
|
}
|
|
|
|
func (i *OverrideAndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
// All the overrides happen in the base module.
|
|
// TODO(jungjw): Check the base module type.
|
|
}
|
|
|
|
// override_android_app is used to create an android_app module based on another android_app by overriding
|
|
// some of its properties.
|
|
func OverrideAndroidAppModuleFactory() android.Module {
|
|
m := &OverrideAndroidApp{}
|
|
m.AddProperties(&overridableAppProperties{})
|
|
|
|
android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
|
|
android.InitOverrideModule(m)
|
|
return m
|
|
}
|
|
|
|
type OverrideAndroidTest struct {
|
|
android.ModuleBase
|
|
android.OverrideModuleBase
|
|
}
|
|
|
|
func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
// All the overrides happen in the base module.
|
|
// TODO(jungjw): Check the base module type.
|
|
}
|
|
|
|
// override_android_test is used to create an android_app module based on another android_test by overriding
|
|
// some of its properties.
|
|
func OverrideAndroidTestModuleFactory() android.Module {
|
|
m := &OverrideAndroidTest{}
|
|
m.AddProperties(&overridableAppProperties{})
|
|
m.AddProperties(&appTestProperties{})
|
|
|
|
android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
|
|
android.InitOverrideModule(m)
|
|
return m
|
|
}
|
|
|
|
type AndroidAppImport struct {
|
|
android.ModuleBase
|
|
android.DefaultableModuleBase
|
|
prebuilt android.Prebuilt
|
|
|
|
properties AndroidAppImportProperties
|
|
dpiVariants interface{}
|
|
archVariants interface{}
|
|
|
|
outputFile android.Path
|
|
certificate *Certificate
|
|
|
|
dexpreopter
|
|
|
|
usesLibrary usesLibrary
|
|
|
|
installPath android.InstallPath
|
|
}
|
|
|
|
type AndroidAppImportProperties struct {
|
|
// A prebuilt apk to import
|
|
Apk *string
|
|
|
|
// The name of a certificate in the default certificate directory or an android_app_certificate
|
|
// module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
|
|
Certificate *string
|
|
|
|
// Set this flag to true if the prebuilt apk is already signed. The certificate property must not
|
|
// be set for presigned modules.
|
|
Presigned *bool
|
|
|
|
// Sign with the default system dev certificate. Must be used judiciously. Most imported apps
|
|
// need to either specify a specific certificate or be presigned.
|
|
Default_dev_cert *bool
|
|
|
|
// Specifies that this app should be installed to the priv-app directory,
|
|
// where the system will grant it additional privileges not available to
|
|
// normal apps.
|
|
Privileged *bool
|
|
|
|
// Names of modules to be overridden. Listed modules can only be other binaries
|
|
// (in Make or Soong).
|
|
// This does not completely prevent installation of the overridden binaries, but if both
|
|
// binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
|
|
// from PRODUCT_PACKAGES.
|
|
Overrides []string
|
|
|
|
// Optional name for the installed app. If unspecified, it is derived from the module name.
|
|
Filename *string
|
|
}
|
|
|
|
// Updates properties with variant-specific values.
|
|
func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
|
|
config := ctx.Config()
|
|
|
|
dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
|
|
// Try DPI variant matches in the reverse-priority order so that the highest priority match
|
|
// overwrites everything else.
|
|
// TODO(jungjw): Can we optimize this by making it priority order?
|
|
for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
|
|
MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
|
|
}
|
|
if config.ProductAAPTPreferredConfig() != "" {
|
|
MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
|
|
}
|
|
|
|
archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
|
|
archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
|
|
MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
|
|
}
|
|
|
|
func MergePropertiesFromVariant(ctx android.BaseModuleContext,
|
|
dst interface{}, variantGroup reflect.Value, variant string) {
|
|
src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
|
|
if !src.IsValid() {
|
|
return
|
|
}
|
|
|
|
err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
|
|
if err != nil {
|
|
if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
|
|
ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
|
|
} else {
|
|
panic(err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
|
|
cert := android.SrcIsModule(String(a.properties.Certificate))
|
|
if cert != "" {
|
|
ctx.AddDependency(ctx.Module(), certificateTag, cert)
|
|
}
|
|
|
|
a.usesLibrary.deps(ctx, true)
|
|
}
|
|
|
|
func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
|
|
ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
|
|
rule := android.NewRuleBuilder()
|
|
rule.Command().
|
|
Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
|
|
BuiltTool(ctx, "zip2zip").
|
|
FlagWithInput("-i ", inputPath).
|
|
FlagWithOutput("-o ", outputPath).
|
|
FlagWithArg("-0 ", "'lib/**/*.so'").
|
|
Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
|
|
rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
|
|
}
|
|
|
|
// Returns whether this module should have the dex file stored uncompressed in the APK.
|
|
func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
|
|
if ctx.Config().UnbundledBuild() {
|
|
return false
|
|
}
|
|
|
|
// Uncompress dex in APKs of privileged apps
|
|
if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
|
|
return true
|
|
}
|
|
|
|
return shouldUncompressDex(ctx, &a.dexpreopter)
|
|
}
|
|
|
|
func (a *AndroidAppImport) uncompressDex(
|
|
ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
|
|
rule := android.NewRuleBuilder()
|
|
rule.Command().
|
|
Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
|
|
BuiltTool(ctx, "zip2zip").
|
|
FlagWithInput("-i ", inputPath).
|
|
FlagWithOutput("-o ", outputPath).
|
|
FlagWithArg("-0 ", "'classes*.dex'").
|
|
Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
|
|
rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
|
|
}
|
|
|
|
func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
a.generateAndroidBuildActions(ctx)
|
|
}
|
|
|
|
func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
|
|
numCertPropsSet := 0
|
|
if String(a.properties.Certificate) != "" {
|
|
numCertPropsSet++
|
|
}
|
|
if Bool(a.properties.Presigned) {
|
|
numCertPropsSet++
|
|
}
|
|
if Bool(a.properties.Default_dev_cert) {
|
|
numCertPropsSet++
|
|
}
|
|
if numCertPropsSet != 1 {
|
|
ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
|
|
}
|
|
|
|
_, certificates := collectAppDeps(ctx, false)
|
|
|
|
// TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
|
|
// TODO: LOCAL_PACKAGE_SPLITS
|
|
|
|
srcApk := a.prebuilt.SingleSourcePath(ctx)
|
|
|
|
if a.usesLibrary.enforceUsesLibraries() {
|
|
srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
|
|
}
|
|
|
|
// TODO: Install or embed JNI libraries
|
|
|
|
// Uncompress JNI libraries in the apk
|
|
jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
|
|
a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
|
|
|
|
var installDir android.InstallPath
|
|
if Bool(a.properties.Privileged) {
|
|
installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
|
|
} else {
|
|
installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
|
|
}
|
|
|
|
a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
|
|
a.dexpreopter.isInstallable = true
|
|
a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
|
|
a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
|
|
|
|
a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
|
|
a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
|
|
a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
|
|
a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
|
|
|
|
dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
|
|
if a.dexpreopter.uncompressedDex {
|
|
dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
|
|
a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
|
|
dexOutput = dexUncompressed
|
|
}
|
|
|
|
// Sign or align the package
|
|
// TODO: Handle EXTERNAL
|
|
if !Bool(a.properties.Presigned) {
|
|
// If the certificate property is empty at this point, default_dev_cert must be set to true.
|
|
// Which makes processMainCert's behavior for the empty cert string WAI.
|
|
certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
|
|
if len(certificates) != 1 {
|
|
ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
|
|
}
|
|
a.certificate = &certificates[0]
|
|
signed := android.PathForModuleOut(ctx, "signed", ctx.ModuleName()+".apk")
|
|
SignAppPackage(ctx, signed, dexOutput, certificates)
|
|
a.outputFile = signed
|
|
} else {
|
|
alignedApk := android.PathForModuleOut(ctx, "zip-aligned", ctx.ModuleName()+".apk")
|
|
TransformZipAlign(ctx, alignedApk, dexOutput)
|
|
a.outputFile = alignedApk
|
|
}
|
|
|
|
// TODO: Optionally compress the output apk.
|
|
|
|
a.installPath = ctx.InstallFile(installDir,
|
|
proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk"), a.outputFile)
|
|
|
|
// TODO: androidmk converter jni libs
|
|
}
|
|
|
|
func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
|
|
return &a.prebuilt
|
|
}
|
|
|
|
func (a *AndroidAppImport) Name() string {
|
|
return a.prebuilt.Name(a.ModuleBase.Name())
|
|
}
|
|
|
|
func (a *AndroidAppImport) OutputFile() android.Path {
|
|
return a.outputFile
|
|
}
|
|
|
|
var dpiVariantGroupType reflect.Type
|
|
var archVariantGroupType reflect.Type
|
|
|
|
func initAndroidAppImportVariantGroupTypes() {
|
|
dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
|
|
|
|
archNames := make([]string, len(android.ArchTypeList()))
|
|
for i, archType := range android.ArchTypeList() {
|
|
archNames[i] = archType.Name
|
|
}
|
|
archVariantGroupType = createVariantGroupType(archNames, "Arch")
|
|
}
|
|
|
|
// Populates all variant struct properties at creation time.
|
|
func (a *AndroidAppImport) populateAllVariantStructs() {
|
|
a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
|
|
a.AddProperties(a.dpiVariants)
|
|
|
|
a.archVariants = reflect.New(archVariantGroupType).Interface()
|
|
a.AddProperties(a.archVariants)
|
|
}
|
|
|
|
func (a *AndroidAppImport) Privileged() bool {
|
|
return Bool(a.properties.Privileged)
|
|
}
|
|
|
|
func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
|
|
props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
|
|
|
|
variantFields := make([]reflect.StructField, len(variants))
|
|
for i, variant := range variants {
|
|
variantFields[i] = reflect.StructField{
|
|
Name: proptools.FieldNameForProperty(variant),
|
|
Type: props,
|
|
}
|
|
}
|
|
|
|
variantGroupStruct := reflect.StructOf(variantFields)
|
|
return reflect.StructOf([]reflect.StructField{
|
|
{
|
|
Name: variantGroupName,
|
|
Type: variantGroupStruct,
|
|
},
|
|
})
|
|
}
|
|
|
|
// android_app_import imports a prebuilt apk with additional processing specified in the module.
|
|
// DPI-specific apk source files can be specified using dpi_variants. Example:
|
|
//
|
|
// android_app_import {
|
|
// name: "example_import",
|
|
// apk: "prebuilts/example.apk",
|
|
// dpi_variants: {
|
|
// mdpi: {
|
|
// apk: "prebuilts/example_mdpi.apk",
|
|
// },
|
|
// xhdpi: {
|
|
// apk: "prebuilts/example_xhdpi.apk",
|
|
// },
|
|
// },
|
|
// certificate: "PRESIGNED",
|
|
// }
|
|
func AndroidAppImportFactory() android.Module {
|
|
module := &AndroidAppImport{}
|
|
module.AddProperties(&module.properties)
|
|
module.AddProperties(&module.dexpreoptProperties)
|
|
module.AddProperties(&module.usesLibrary.usesLibraryProperties)
|
|
module.populateAllVariantStructs()
|
|
android.AddLoadHook(module, func(ctx android.LoadHookContext) {
|
|
module.processVariants(ctx)
|
|
})
|
|
|
|
InitJavaModule(module, android.DeviceSupported)
|
|
android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
|
|
|
|
return module
|
|
}
|
|
|
|
type AndroidTestImport struct {
|
|
AndroidAppImport
|
|
|
|
testProperties testProperties
|
|
|
|
data android.Paths
|
|
}
|
|
|
|
func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
|
a.generateAndroidBuildActions(ctx)
|
|
|
|
a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
|
|
}
|
|
|
|
// android_test_import imports a prebuilt test apk with additional processing specified in the
|
|
// module. DPI or arch variant configurations can be made as with android_app_import.
|
|
func AndroidTestImportFactory() android.Module {
|
|
module := &AndroidTestImport{}
|
|
module.AddProperties(&module.properties)
|
|
module.AddProperties(&module.dexpreoptProperties)
|
|
module.AddProperties(&module.usesLibrary.usesLibraryProperties)
|
|
module.AddProperties(&module.testProperties)
|
|
module.populateAllVariantStructs()
|
|
android.AddLoadHook(module, func(ctx android.LoadHookContext) {
|
|
module.processVariants(ctx)
|
|
})
|
|
|
|
InitJavaModule(module, android.DeviceSupported)
|
|
android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
|
|
|
|
return module
|
|
}
|
|
|
|
type UsesLibraryProperties struct {
|
|
// A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
|
|
Uses_libs []string
|
|
|
|
// A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
|
|
// required=false.
|
|
Optional_uses_libs []string
|
|
|
|
// If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
|
|
// to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
|
|
Enforce_uses_libs *bool
|
|
}
|
|
|
|
// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
|
|
// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
|
|
// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
|
|
// with knowledge of their shared libraries.
|
|
type usesLibrary struct {
|
|
usesLibraryProperties UsesLibraryProperties
|
|
}
|
|
|
|
func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
|
|
if !ctx.Config().UnbundledBuild() {
|
|
ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
|
|
ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
|
|
// Only add these extra dependencies if the module depends on framework libs. This avoids
|
|
// creating a cyclic dependency:
|
|
// e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
|
|
if hasFrameworkLibs {
|
|
// dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs
|
|
// to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each
|
|
// library to dexpreopt.
|
|
ctx.AddVariationDependencies(nil, usesLibTag,
|
|
"org.apache.http.legacy",
|
|
"android.hidl.base-V1.0-java",
|
|
"android.hidl.manager-V1.0-java")
|
|
}
|
|
}
|
|
}
|
|
|
|
// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
|
|
// build.
|
|
func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
|
|
optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
|
|
return optionalUsesLibs
|
|
}
|
|
|
|
// usesLibraryPaths returns a map of module names of shared library dependencies to the paths to their dex jars.
|
|
func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) map[string]android.Path {
|
|
usesLibPaths := make(map[string]android.Path)
|
|
|
|
if !ctx.Config().UnbundledBuild() {
|
|
ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
|
|
if lib, ok := m.(Dependency); ok {
|
|
if dexJar := lib.DexJar(); dexJar != nil {
|
|
usesLibPaths[ctx.OtherModuleName(m)] = dexJar
|
|
} else {
|
|
ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must produce a dex jar, does it have installable: true?",
|
|
ctx.OtherModuleName(m))
|
|
}
|
|
} else if ctx.Config().AllowMissingDependencies() {
|
|
ctx.AddMissingDependencies([]string{ctx.OtherModuleName(m)})
|
|
} else {
|
|
ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library",
|
|
ctx.OtherModuleName(m))
|
|
}
|
|
})
|
|
}
|
|
|
|
return usesLibPaths
|
|
}
|
|
|
|
// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
|
|
// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
|
|
// unconditionally in the future.
|
|
func (u *usesLibrary) enforceUsesLibraries() bool {
|
|
defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
|
|
len(u.usesLibraryProperties.Optional_uses_libs) > 0
|
|
return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
|
|
}
|
|
|
|
// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
|
|
// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
|
|
func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
|
|
outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
|
|
|
|
rule := android.NewRuleBuilder()
|
|
cmd := rule.Command().BuiltTool(ctx, "manifest_check").
|
|
Flag("--enforce-uses-libraries").
|
|
Input(manifest).
|
|
FlagWithOutput("-o ", outputFile)
|
|
|
|
for _, lib := range u.usesLibraryProperties.Uses_libs {
|
|
cmd.FlagWithArg("--uses-library ", lib)
|
|
}
|
|
|
|
for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
|
|
cmd.FlagWithArg("--optional-uses-library ", lib)
|
|
}
|
|
|
|
rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
|
|
|
|
return outputFile
|
|
}
|
|
|
|
// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
|
|
// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
|
|
func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
|
|
outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
|
|
|
|
rule := android.NewRuleBuilder()
|
|
aapt := ctx.Config().HostToolPath(ctx, "aapt")
|
|
rule.Command().
|
|
Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
|
|
Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
|
|
Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
|
|
Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
|
|
rule.Command().Text("cp -f").Input(apk).Output(outputFile)
|
|
|
|
rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
|
|
|
|
return outputFile
|
|
}
|