blob: 94f6bb10a14636afb908717672ff6e4f690f33da [file] [log] [blame]
Colin Cross30e076a2015-04-13 13:58:27 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17// This file contains the module types for compiling Android apps.
18
19import (
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070020 "path/filepath"
21 "reflect"
Jaewoong Jung5b425e22019-06-17 17:40:56 -070022 "sort"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070023 "strings"
Colin Cross30e076a2015-04-13 13:58:27 -070024
Colin Cross50ddcc42019-05-16 12:28:22 -070025 "github.com/google/blueprint"
26 "github.com/google/blueprint/proptools"
27
Colin Cross635c3b02016-05-18 15:37:25 -070028 "android/soong/android"
Colin Crossa4f08812018-10-02 22:03:40 -070029 "android/soong/cc"
Colin Cross303e21f2018-08-07 16:49:25 -070030 "android/soong/tradefed"
Colin Cross30e076a2015-04-13 13:58:27 -070031)
32
Jaewoong Jung3e18b192019-06-11 12:25:34 -070033var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"}
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070034
Colin Cross3bc7ffa2017-11-22 16:19:37 -080035func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000036 RegisterAppBuildComponents(android.InitRegistrationContext)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -070037
38 initAndroidAppImportVariantGroupTypes()
Colin Cross3bc7ffa2017-11-22 16:19:37 -080039}
40
Paul Duffinf9b1da02019-12-18 19:51:55 +000041func RegisterAppBuildComponents(ctx android.RegistrationContext) {
42 ctx.RegisterModuleType("android_app", AndroidAppFactory)
43 ctx.RegisterModuleType("android_test", AndroidTestFactory)
44 ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
45 ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
46 ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
47 ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
48 ctx.RegisterModuleType("android_app_import", AndroidAppImportFactory)
49 ctx.RegisterModuleType("android_test_import", AndroidTestImportFactory)
50}
51
Colin Cross30e076a2015-04-13 13:58:27 -070052// AndroidManifest.xml merging
53// package splits
54
Colin Crossfabb6082018-02-20 17:22:23 -080055type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -070056 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -070057 Additional_certificates []string
58
59 // If set, create package-export.apk, which other packages can
60 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -080061 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -070062
Colin Cross16056062017-12-13 22:46:28 -080063 // Specifies that this app should be installed to the priv-app directory,
64 // where the system will grant it additional privileges not available to
65 // normal apps.
66 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -070067
68 // list of resource labels to generate individual resource packages
69 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -040070
71 // Names of modules to be overridden. Listed modules can only be other binaries
72 // (in Make or Soong).
73 // This does not completely prevent installation of the overridden binaries, but if both
74 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
75 // from PRODUCT_PACKAGES.
76 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -070077
78 // list of native libraries that will be provided in or alongside the resulting jar
79 Jni_libs []string `android:"arch_variant"`
80
Jaewoong Jungbc625cd2019-05-06 15:48:44 -070081 // STL library to use for JNI libraries.
82 Stl *string `android:"arch_variant"`
83
Colin Crosse4246ab2019-02-05 21:55:21 -080084 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
85 // flag so that they are used from inside the APK at runtime. Defaults to true for android_test modules unless
Jiyong Park52cd06f2019-11-11 10:14:32 +090086 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
87 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
88 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -080089 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -080090
91 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
92 // they are used from inside the APK at runtime.
93 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -070094
95 // Forces native libraries to always be packaged into the APK,
96 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
97 // True for android_test* modules.
98 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -070099
100 // If set, find and merge all NOTICE files that this module and its dependencies have and store
101 // it in the APK as an asset.
102 Embed_notices *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700103}
104
Jaewoong Jung525443a2019-02-28 15:35:54 -0800105// android_app properties that can be overridden by override_android_app
106type overridableAppProperties struct {
107 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
108 // or an android_app_certificate module name in the form ":module".
109 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700110
111 // the package name of this app. The package name in the manifest file is used if one was not given.
112 Package_name *string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800113}
114
Colin Cross30e076a2015-04-13 13:58:27 -0700115type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700116 Library
117 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800118 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700119
Colin Cross50ddcc42019-05-16 12:28:22 -0700120 usesLibrary usesLibrary
121
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900122 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700123
Colin Crossfabb6082018-02-20 17:22:23 -0800124 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700125
Jaewoong Jung525443a2019-02-28 15:35:54 -0800126 overridableAppProperties overridableAppProperties
127
Colin Crossa4f08812018-10-02 22:03:40 -0700128 installJniLibs []jniLib
Colin Crossf6237212018-10-29 23:14:58 -0700129
130 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800131
132 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
133 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800134
Colin Cross70dda7e2019-10-01 22:05:35 -0700135 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700136
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700137 onDeviceDir string
138
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800139 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700140
141 noticeOutputs android.NoticeOutputs
Colin Crosse1731a52017-12-14 11:22:55 -0800142}
143
Colin Cross89c31582018-04-30 15:55:11 -0700144func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
145 return nil
146}
147
Colin Cross66f78822018-05-02 12:58:28 -0700148func (a *AndroidApp) ExportedStaticPackages() android.Paths {
149 return nil
150}
151
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900152func (a *AndroidApp) OutputFile() android.Path {
153 return a.outputFile
154}
155
Colin Crossa97c5d32018-03-28 14:58:31 -0700156var _ AndroidLibraryDependency = (*AndroidApp)(nil)
157
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900158type Certificate struct {
159 Pem, Key android.Path
Colin Cross30e076a2015-04-13 13:58:27 -0700160}
161
Colin Cross46c9b8b2017-06-22 16:51:17 -0700162func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
163 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700164
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700165 if String(a.appProperties.Stl) == "c++_shared" && a.sdkVersion() == "" {
166 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
167 }
168
Paul Duffin250e6192019-06-07 10:44:37 +0100169 sdkDep := decodeSdkDep(ctx, sdkContext(a))
170 if sdkDep.hasFrameworkLibs() {
171 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700172 }
Colin Crossa4f08812018-10-02 22:03:40 -0700173
Peter Collingbournead84f972019-12-17 16:46:18 -0800174 tag := &jniDependencyTag{}
Colin Crossa4f08812018-10-02 22:03:40 -0700175 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700176 variation := append(jniTarget.Variations(),
177 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossa4f08812018-10-02 22:03:40 -0700178 ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
179 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700180
Paul Duffin250e6192019-06-07 10:44:37 +0100181 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700182}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700183
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700184func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800185 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700186 if cert != "" {
187 ctx.AddDependency(ctx.Module(), certificateTag, cert)
188 }
189
190 for _, cert := range a.appProperties.Additional_certificates {
191 cert = android.SrcIsModule(cert)
192 if cert != "" {
193 ctx.AddDependency(ctx.Module(), certificateTag, cert)
194 } else {
195 ctx.PropertyErrorf("additional_certificates",
196 `must be names of android_app_certificate modules in the form ":module"`)
197 }
198 }
Colin Cross30e076a2015-04-13 13:58:27 -0700199}
200
Jeongik Cha538c0d02019-07-11 15:54:27 +0900201func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
202 a.generateAndroidBuildActions(ctx)
203}
204
Colin Cross46c9b8b2017-06-22 16:51:17 -0700205func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jeongik Cha538c0d02019-07-11 15:54:27 +0900206 a.checkPlatformAPI(ctx)
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900207 a.checkSdkVersion(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700208 a.generateAndroidBuildActions(ctx)
209}
210
Sasha Smundak6ad77252019-05-01 13:16:22 -0700211// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800212// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700213func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Colin Crosse4246ab2019-02-05 21:55:21 -0800214 minSdkVersion, err := sdkVersionToNumber(ctx, a.minSdkVersion())
215 if err != nil {
216 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
217 }
218
Jiyong Park52cd06f2019-11-11 10:14:32 +0900219 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
220 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800221}
222
Colin Cross43f08db2018-11-12 10:13:39 -0800223// Returns whether this module should have the dex file stored uncompressed in the APK.
224func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800225 if Bool(a.appProperties.Use_embedded_dex) {
226 return true
227 }
228
Colin Cross53a87f52019-06-25 13:35:30 -0700229 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
230 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900231 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000232 return true
233 }
234
Colin Cross53a87f52019-06-25 13:35:30 -0700235 if ctx.Config().UnbundledBuild() {
236 return false
237 }
238
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700239 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700240}
241
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700242func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
243 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900244 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700245}
246
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800247func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000248 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
249
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700250 // Ask manifest_fixer to add or update the application element indicating this app has no code.
251 a.aapt.hasNoCode = !a.hasCode(ctx)
252
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800253 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800254
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800255 // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided.
Colin Crosse78dcd32018-04-19 15:25:19 -0700256 hasProduct := false
257 for _, f := range a.aaptProperties.Aaptflags {
258 if strings.HasPrefix(f, "--product") {
259 hasProduct = true
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800260 break
Colin Crosse78dcd32018-04-19 15:25:19 -0700261 }
262 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700263 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800264 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700265 }
266
Dan Willemsen72be5902018-10-24 20:24:57 -0700267 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
268 // Product AAPT config
269 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800270 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700271 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700272
Dan Willemsen72be5902018-10-24 20:24:57 -0700273 // Product AAPT preferred config
274 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800275 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700276 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700277 }
278
Jiyong Park7f67f482019-01-05 12:57:48 +0900279 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700280 if overridden || a.overridableAppProperties.Package_name != nil {
281 // The product override variable has a priority over the package_name property.
282 if !overridden {
283 manifestPackageName = *a.overridableAppProperties.Package_name
284 }
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800285 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Park7f67f482019-01-05 12:57:48 +0900286 }
287
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800288 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
289
Colin Crosse560c4a2019-03-19 16:03:11 -0700290 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700291 a.aapt.sdkLibraries = a.exportedSdkLibs
Colin Crosse560c4a2019-03-19 16:03:11 -0700292
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800293 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700294
Colin Cross46c9b8b2017-06-22 16:51:17 -0700295 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700296 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800297}
Colin Cross30e076a2015-04-13 13:58:27 -0700298
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800299func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700300 var staticLibProguardFlagFiles android.Paths
301 ctx.VisitDirectDeps(func(m android.Module) {
302 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
303 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
304 }
305 })
306
307 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
308
309 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
310 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800311}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800312
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800313func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800314
315 var installDir string
316 if ctx.ModuleName() == "framework-res" {
317 // framework-res.apk is installed as system/framework/framework-res.apk
318 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900319 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800320 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800321 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800322 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800323 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800324 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000325 a.dexpreopter.isInstallable = Bool(a.properties.Installable)
326 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -0700327
328 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
329 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
330 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
331 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
332 a.dexpreopter.manifestFile = a.mergedManifestFile
333
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000334 a.deviceProperties.UncompressDex = a.dexpreopter.uncompressedDex
Colin Cross5a0dcd52018-10-05 14:20:06 -0700335
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800336 if ctx.ModuleName() != "framework-res" {
337 a.Module.compile(ctx, a.aaptSrcJar)
338 }
Colin Cross30e076a2015-04-13 13:58:27 -0700339
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800340 return a.maybeStrippedDexJarFile
341}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800342
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800343func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700344 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700345 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700346 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700347 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700348 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Colin Crossa4f08812018-10-02 22:03:40 -0700349 } else {
350 a.installJniLibs = jniLibs
351 }
352 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800353 return jniJarFile
354}
Colin Crossa4f08812018-10-02 22:03:40 -0700355
Jaewoong Jung0949f312019-09-11 10:25:18 -0700356func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700357 // Collect NOTICE files from all dependencies.
358 seenModules := make(map[android.Module]bool)
359 noticePathSet := make(map[android.Path]bool)
360
361 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
362 // Have we already seen this?
363 if _, ok := seenModules[child]; ok {
364 return false
365 }
366 seenModules[child] = true
367
368 // Skip host modules.
369 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
370 return false
371 }
372
373 path := child.(android.Module).NoticeFile()
374 if path.Valid() {
375 noticePathSet[path.Path()] = true
376 }
377 return true
378 })
379
380 // If the app has one, add it too.
381 if a.NoticeFile().Valid() {
382 noticePathSet[a.NoticeFile().Path()] = true
383 }
384
385 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700386 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700387 }
388 var noticePaths []android.Path
389 for path := range noticePathSet {
390 noticePaths = append(noticePaths, path)
391 }
392 sort.Slice(noticePaths, func(i, j int) bool {
393 return noticePaths[i].String() < noticePaths[j].String()
394 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700395
Jaewoong Jung0949f312019-09-11 10:25:18 -0700396 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700397}
398
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700399// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
400// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
401func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
402 if android.SrcIsModule(certPropValue) == "" {
403 var mainCert Certificate
404 if certPropValue != "" {
405 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
406 mainCert = Certificate{
407 defaultDir.Join(ctx, certPropValue+".x509.pem"),
408 defaultDir.Join(ctx, certPropValue+".pk8"),
409 }
410 } else {
411 pem, key := ctx.Config().DefaultAppCertificate(ctx)
412 mainCert = Certificate{pem, key}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700413 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700414 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700415 }
416
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700417 if !m.Platform() {
418 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900419 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
420 if strings.HasPrefix(certPath, systemCertPath) {
421 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
422 whitelist := ctx.Config().EnforceSystemCertificateWhitelist()
423
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700424 if enforceSystemCert && !inList(m.Name(), whitelist) {
Jeongik Chac9464142019-01-07 12:07:27 +0900425 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
426 }
427 }
428 }
429
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700430 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800431}
432
433func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700434 var apkDeps android.Paths
435
Jeongik Cha538c0d02019-07-11 15:54:27 +0900436 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
437 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
438
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800439 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800440 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800441
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700442 if ctx.ModuleName() == "framework-res" {
443 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700444 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900445 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700446 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
447 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800448 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700449 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700450 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700451 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700452 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700453
Jaewoong Jung0949f312019-09-11 10:25:18 -0700454 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700455 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
456 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
457 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700458
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800459 // Process all building blocks, from AAPT to certificates.
460 a.aaptBuildActions(ctx)
461
Colin Cross50ddcc42019-05-16 12:28:22 -0700462 if a.usesLibrary.enforceUsesLibraries() {
463 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
464 apkDeps = append(apkDeps, manifestCheckFile)
465 }
466
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800467 a.proguardBuildActions(ctx)
468
469 dexJarFile := a.dexBuildActions(ctx)
470
Peter Collingbournead84f972019-12-17 16:46:18 -0800471 jniLibs, certificateDeps := collectAppDeps(ctx, a.shouldEmbedJnis(ctx))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800472 jniJarFile := a.jniBuildActions(jniLibs, ctx)
473
474 if ctx.Failed() {
475 return
476 }
477
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700478 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
479 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800480
481 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800482 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Colin Cross50ddcc42019-05-16 12:28:22 -0700483 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800484 a.outputFile = packageFile
485
Colin Crosse560c4a2019-03-19 16:03:11 -0700486 for _, split := range a.aapt.splits {
487 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800488 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Colin Cross50ddcc42019-05-16 12:28:22 -0700489 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps)
Colin Crosse560c4a2019-03-19 16:03:11 -0700490 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
491 }
492
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800493 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700494 bundleFile := android.PathForModuleOut(ctx, "base.zip")
495 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
496 a.bundleFile = bundleFile
497
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800498 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900499 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
500 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
501 for _, extra := range a.extraOutputFiles {
502 ctx.InstallFile(a.installDir, extra.Base(), extra)
503 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800504 }
Colin Cross30e076a2015-04-13 13:58:27 -0700505}
506
Peter Collingbournead84f972019-12-17 16:46:18 -0800507func collectAppDeps(ctx android.ModuleContext, shouldCollectRecursiveNativeDeps bool) ([]jniLib, []Certificate) {
Colin Crossa4f08812018-10-02 22:03:40 -0700508 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900509 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800510 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700511
Peter Collingbournead84f972019-12-17 16:46:18 -0800512 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700513 otherName := ctx.OtherModuleName(module)
514 tag := ctx.OtherModuleDependencyTag(module)
515
Peter Collingbournead84f972019-12-17 16:46:18 -0800516 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700517 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800518 if dep.IsNdk() || dep.IsStubs() {
519 return false
520 }
521
Colin Crossa4f08812018-10-02 22:03:40 -0700522 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800523 path := lib.Path()
524 if seenModulePaths[path.String()] {
525 return false
526 }
527 seenModulePaths[path.String()] = true
528
Colin Crossa4f08812018-10-02 22:03:40 -0700529 if lib.Valid() {
530 jniLibs = append(jniLibs, jniLib{
531 name: ctx.OtherModuleName(module),
Peter Collingbournead84f972019-12-17 16:46:18 -0800532 path: path,
533 target: module.Target(),
Colin Crossa4f08812018-10-02 22:03:40 -0700534 })
535 } else {
536 ctx.ModuleErrorf("dependency %q missing output file", otherName)
537 }
538 } else {
539 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700540 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800541
542 return shouldCollectRecursiveNativeDeps
543 }
544
545 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700546 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900547 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700548 } else {
549 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
550 }
Colin Crossa4f08812018-10-02 22:03:40 -0700551 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800552
553 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700554 })
555
Colin Crossbd01e2a2018-10-04 15:21:03 -0700556 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700557}
558
Colin Cross0ea8ba82019-06-06 14:33:29 -0700559func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800560 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
561 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000562 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800563 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800564 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800565}
566
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900567// For OutputFileProducer interface
568func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
569 switch tag {
570 case ".aapt.srcjar":
571 return []android.Path{a.aaptSrcJar}, nil
572 }
573 return a.Library.OutputFiles(tag)
574}
575
Jiyong Parkf7487312019-10-17 12:54:30 +0900576func (a *AndroidApp) Privileged() bool {
577 return Bool(a.appProperties.Privileged)
578}
579
Colin Cross1b16b0e2019-02-12 14:41:32 -0800580// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700581func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700582 module := &AndroidApp{}
583
Sasha Smundak2057f822019-04-16 17:16:58 -0700584 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800585 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
586
Colin Crossae5caf52018-05-22 11:11:52 -0700587 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700588 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700589
Colin Cross36242852017-06-23 15:06:31 -0700590 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -0700591 &module.Module.properties,
592 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800593 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700594 &module.Module.protoProperties,
595 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800596 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700597 &module.overridableAppProperties,
598 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700599
Colin Crossa9d8bee2018-10-02 13:59:46 -0700600 module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
601 return class == android.Device && ctx.Config().DevicePrefer32BitApps()
602 })
603
Colin Crossa4f08812018-10-02 22:03:40 -0700604 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
605 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -0800606 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +0900607 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -0700608
Colin Cross36242852017-06-23 15:06:31 -0700609 return module
Colin Cross30e076a2015-04-13 13:58:27 -0700610}
Colin Crossae5caf52018-05-22 11:11:52 -0700611
612type appTestProperties struct {
613 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700614
615 // if specified, the instrumentation target package name in the manifest is overwritten by it.
616 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -0700617}
618
619type AndroidTest struct {
620 AndroidApp
621
622 appTestProperties appTestProperties
623
624 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -0700625
626 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -0700627 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -0700628}
629
Jaewoong Jung0949f312019-09-11 10:25:18 -0700630func (a *AndroidTest) InstallInTestcases() bool {
631 return true
632}
633
Colin Crossae5caf52018-05-22 11:11:52 -0700634func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700635 if a.appTestProperties.Instrumentation_target_package != nil {
636 a.additionalAaptFlags = append(a.additionalAaptFlags,
637 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
638 } else if a.appTestProperties.Instrumentation_for != nil {
639 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800640 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
641 if overridden {
642 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
643 }
644 }
Colin Crossae5caf52018-05-22 11:11:52 -0700645 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -0700646
Dan Shi6ffaaa82019-09-26 11:41:36 -0700647 a.testConfig = tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
648 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config)
Jaewoong Junge5cd4e12019-11-22 14:34:55 -0800649 if a.overridableAppProperties.Package_name != nil {
650 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
651 rule := android.NewRuleBuilder()
652 rule.Command().BuiltTool(ctx, "test_config_fixer").
Jaewoong Jungf192d552019-12-17 13:56:13 -0800653 FlagWithInput("--manifest ", a.manifestPath).
Jaewoong Junge5cd4e12019-11-22 14:34:55 -0800654 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name).
655 Input(a.testConfig).
656 Output(fixedConfig)
657 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
658 a.testConfig = fixedConfig
659 }
Colin Cross8a497952019-03-05 22:25:09 -0800660 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -0700661}
662
663func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -0700664 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700665}
666
667func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
668 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -0700669 if a.appTestProperties.Instrumentation_for != nil {
670 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
671 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
672 // use instrumentationForTag instead of libTag.
673 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
674 }
Colin Crossae5caf52018-05-22 11:11:52 -0700675}
676
Colin Cross1b16b0e2019-02-12 14:41:32 -0800677// android_test compiles test sources and Android resources into an Android application package `.apk` file and
678// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -0700679func AndroidTestFactory() android.Module {
680 module := &AndroidTest{}
681
Sasha Smundak2057f822019-04-16 17:16:58 -0700682 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -0700683
684 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700685 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -0800686 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -0700687 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -0800688 module.Module.dexpreopter.isTest = true
Colin Crossae5caf52018-05-22 11:11:52 -0700689
690 module.AddProperties(
691 &module.Module.properties,
692 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800693 &module.Module.dexpreoptProperties,
Colin Crossae5caf52018-05-22 11:11:52 -0700694 &module.Module.protoProperties,
695 &module.aaptProperties,
696 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -0700697 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800698 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700699 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -0700700 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -0700701
Colin Crossa4f08812018-10-02 22:03:40 -0700702 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
703 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700704 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -0700705 return module
706}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700707
Colin Cross252fc6f2018-10-04 15:22:03 -0700708type appTestHelperAppProperties struct {
709 // list of compatibility suites (for example "cts", "vts") that the module should be
710 // installed into.
711 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -0700712
713 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
714 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
715 // explicitly.
716 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -0700717}
718
719type AndroidTestHelperApp struct {
720 AndroidApp
721
722 appTestHelperAppProperties appTestHelperAppProperties
723}
724
Jaewoong Jung326a9412019-11-21 10:41:00 -0800725func (a *AndroidTestHelperApp) InstallInTestcases() bool {
726 return true
727}
728
Colin Cross1b16b0e2019-02-12 14:41:32 -0800729// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
730// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
731// test.
Colin Cross252fc6f2018-10-04 15:22:03 -0700732func AndroidTestHelperAppFactory() android.Module {
733 module := &AndroidTestHelperApp{}
734
Sasha Smundak2057f822019-04-16 17:16:58 -0700735 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -0700736
737 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -0800738 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -0700739 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -0800740 module.Module.dexpreopter.isTest = true
Colin Cross252fc6f2018-10-04 15:22:03 -0700741
742 module.AddProperties(
743 &module.Module.properties,
744 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800745 &module.Module.dexpreoptProperties,
Colin Cross252fc6f2018-10-04 15:22:03 -0700746 &module.Module.protoProperties,
747 &module.aaptProperties,
748 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800749 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700750 &module.overridableAppProperties,
751 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -0700752
753 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
754 android.InitDefaultableModule(module)
755 return module
756}
757
Colin Crossbd01e2a2018-10-04 15:21:03 -0700758type AndroidAppCertificate struct {
759 android.ModuleBase
760 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900761 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -0700762}
763
764type AndroidAppCertificateProperties struct {
765 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
766 Certificate *string
767}
768
Colin Cross1b16b0e2019-02-12 14:41:32 -0800769// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
770// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -0700771func AndroidAppCertificateFactory() android.Module {
772 module := &AndroidAppCertificate{}
773 module.AddProperties(&module.properties)
774 android.InitAndroidModule(module)
775 return module
776}
777
Colin Crossbd01e2a2018-10-04 15:21:03 -0700778func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
779 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900780 c.Certificate = Certificate{
Colin Crossbd01e2a2018-10-04 15:21:03 -0700781 android.PathForModuleSrc(ctx, cert+".x509.pem"),
782 android.PathForModuleSrc(ctx, cert+".pk8"),
783 }
784}
Jaewoong Jung525443a2019-02-28 15:35:54 -0800785
786type OverrideAndroidApp struct {
787 android.ModuleBase
788 android.OverrideModuleBase
789}
790
791func (i *OverrideAndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
792 // All the overrides happen in the base module.
793 // TODO(jungjw): Check the base module type.
794}
795
796// override_android_app is used to create an android_app module based on another android_app by overriding
797// some of its properties.
798func OverrideAndroidAppModuleFactory() android.Module {
799 m := &OverrideAndroidApp{}
800 m.AddProperties(&overridableAppProperties{})
801
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700802 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -0800803 android.InitOverrideModule(m)
804 return m
805}
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700806
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700807type OverrideAndroidTest struct {
808 android.ModuleBase
809 android.OverrideModuleBase
810}
811
812func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
813 // All the overrides happen in the base module.
814 // TODO(jungjw): Check the base module type.
815}
816
817// override_android_test is used to create an android_app module based on another android_test by overriding
818// some of its properties.
819func OverrideAndroidTestModuleFactory() android.Module {
820 m := &OverrideAndroidTest{}
821 m.AddProperties(&overridableAppProperties{})
822 m.AddProperties(&appTestProperties{})
823
824 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
825 android.InitOverrideModule(m)
826 return m
827}
828
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700829type AndroidAppImport struct {
830 android.ModuleBase
831 android.DefaultableModuleBase
832 prebuilt android.Prebuilt
833
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700834 properties AndroidAppImportProperties
835 dpiVariants interface{}
836 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700837
838 outputFile android.Path
839 certificate *Certificate
840
841 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -0700842
843 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -0700844
Colin Cross70dda7e2019-10-01 22:05:35 -0700845 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700846}
847
848type AndroidAppImportProperties struct {
849 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700850 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -0700851
Jaewoong Jung961d4fd2019-08-22 14:25:58 -0700852 // The name of a certificate in the default certificate directory or an android_app_certificate
853 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700854 Certificate *string
855
856 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
857 // be set for presigned modules.
858 Presigned *bool
859
Jaewoong Jung961d4fd2019-08-22 14:25:58 -0700860 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
861 // need to either specify a specific certificate or be presigned.
862 Default_dev_cert *bool
863
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700864 // Specifies that this app should be installed to the priv-app directory,
865 // where the system will grant it additional privileges not available to
866 // normal apps.
867 Privileged *bool
868
869 // Names of modules to be overridden. Listed modules can only be other binaries
870 // (in Make or Soong).
871 // This does not completely prevent installation of the overridden binaries, but if both
872 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
873 // from PRODUCT_PACKAGES.
874 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -0700875
876 // Optional name for the installed app. If unspecified, it is derived from the module name.
877 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700878}
879
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700880// Updates properties with variant-specific values.
881func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700882 config := ctx.Config()
883
884 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
885 // Try DPI variant matches in the reverse-priority order so that the highest priority match
886 // overwrites everything else.
887 // TODO(jungjw): Can we optimize this by making it priority order?
888 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700889 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -0700890 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700891 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700892 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -0700893 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700894
895 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
896 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
897 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -0700898}
899
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700900func MergePropertiesFromVariant(ctx android.BaseModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700901 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700902 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
903 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -0700904 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -0700905 }
906
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700907 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
908 if err != nil {
909 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
910 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
911 } else {
912 panic(err)
913 }
914 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -0700915}
916
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700917func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
918 cert := android.SrcIsModule(String(a.properties.Certificate))
919 if cert != "" {
920 ctx.AddDependency(ctx.Module(), certificateTag, cert)
921 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700922
Paul Duffin250e6192019-06-07 10:44:37 +0100923 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700924}
925
926func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
927 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
928 rule := android.NewRuleBuilder()
929 rule.Command().
930 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -0700931 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700932 FlagWithInput("-i ", inputPath).
933 FlagWithOutput("-o ", outputPath).
934 FlagWithArg("-0 ", "'lib/**/*.so'").
935 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
936 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
937}
938
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700939// Returns whether this module should have the dex file stored uncompressed in the APK.
940func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
941 if ctx.Config().UnbundledBuild() {
942 return false
943 }
944
945 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +0900946 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700947 return true
948 }
949
950 return shouldUncompressDex(ctx, &a.dexpreopter)
951}
952
Jaewoong Jungea1bdb02019-05-09 14:36:34 -0700953func (a *AndroidAppImport) uncompressDex(
954 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
955 rule := android.NewRuleBuilder()
956 rule.Command().
957 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -0700958 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -0700959 FlagWithInput("-i ", inputPath).
960 FlagWithOutput("-o ", outputPath).
961 FlagWithArg("-0 ", "'classes*.dex'").
962 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
963 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
964}
965
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700966func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -0700967 a.generateAndroidBuildActions(ctx)
968}
969
970func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -0700971 numCertPropsSet := 0
972 if String(a.properties.Certificate) != "" {
973 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700974 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -0700975 if Bool(a.properties.Presigned) {
976 numCertPropsSet++
977 }
978 if Bool(a.properties.Default_dev_cert) {
979 numCertPropsSet++
980 }
981 if numCertPropsSet != 1 {
982 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700983 }
984
Peter Collingbournead84f972019-12-17 16:46:18 -0800985 _, certificates := collectAppDeps(ctx, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700986
987 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700988 // TODO: LOCAL_PACKAGE_SPLITS
989
Jaewoong Jung3e18b192019-06-11 12:25:34 -0700990 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -0700991
992 if a.usesLibrary.enforceUsesLibraries() {
993 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
994 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700995
996 // TODO: Install or embed JNI libraries
997
998 // Uncompress JNI libraries in the apk
999 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1000 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1001
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001002 var installDir android.InstallPath
1003 if Bool(a.properties.Privileged) {
1004 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
1005 } else {
1006 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1007 }
1008
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001009 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
1010 a.dexpreopter.isInstallable = true
1011 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001012 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001013
1014 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1015 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1016 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1017 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1018
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001019 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001020 if a.dexpreopter.uncompressedDex {
1021 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1022 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1023 dexOutput = dexUncompressed
1024 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001025
1026 // Sign or align the package
1027 // TODO: Handle EXTERNAL
1028 if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001029 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1030 // Which makes processMainCert's behavior for the empty cert string WAI.
1031 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001032 if len(certificates) != 1 {
1033 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1034 }
1035 a.certificate = &certificates[0]
1036 signed := android.PathForModuleOut(ctx, "signed", ctx.ModuleName()+".apk")
1037 SignAppPackage(ctx, signed, dexOutput, certificates)
1038 a.outputFile = signed
1039 } else {
1040 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", ctx.ModuleName()+".apk")
1041 TransformZipAlign(ctx, alignedApk, dexOutput)
1042 a.outputFile = alignedApk
1043 }
1044
1045 // TODO: Optionally compress the output apk.
1046
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001047 a.installPath = ctx.InstallFile(installDir,
1048 proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk"), a.outputFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001049
1050 // TODO: androidmk converter jni libs
1051}
1052
1053func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1054 return &a.prebuilt
1055}
1056
1057func (a *AndroidAppImport) Name() string {
1058 return a.prebuilt.Name(a.ModuleBase.Name())
1059}
1060
Dario Frenicde2a032019-10-27 00:29:22 +01001061func (a *AndroidAppImport) OutputFile() android.Path {
1062 return a.outputFile
1063}
1064
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001065var dpiVariantGroupType reflect.Type
1066var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001067
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001068func initAndroidAppImportVariantGroupTypes() {
1069 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1070
1071 archNames := make([]string, len(android.ArchTypeList()))
1072 for i, archType := range android.ArchTypeList() {
1073 archNames[i] = archType.Name
1074 }
1075 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1076}
1077
1078// Populates all variant struct properties at creation time.
1079func (a *AndroidAppImport) populateAllVariantStructs() {
1080 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1081 a.AddProperties(a.dpiVariants)
1082
1083 a.archVariants = reflect.New(archVariantGroupType).Interface()
1084 a.AddProperties(a.archVariants)
1085}
1086
Jiyong Parkf7487312019-10-17 12:54:30 +09001087func (a *AndroidAppImport) Privileged() bool {
1088 return Bool(a.properties.Privileged)
1089}
1090
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001091func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1092 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1093
1094 variantFields := make([]reflect.StructField, len(variants))
1095 for i, variant := range variants {
1096 variantFields[i] = reflect.StructField{
1097 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001098 Type: props,
1099 }
1100 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001101
1102 variantGroupStruct := reflect.StructOf(variantFields)
1103 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001104 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001105 Name: variantGroupName,
1106 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001107 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001108 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001109}
1110
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001111// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001112// DPI-specific apk source files can be specified using dpi_variants. Example:
1113//
1114// android_app_import {
1115// name: "example_import",
1116// apk: "prebuilts/example.apk",
1117// dpi_variants: {
1118// mdpi: {
1119// apk: "prebuilts/example_mdpi.apk",
1120// },
1121// xhdpi: {
1122// apk: "prebuilts/example_xhdpi.apk",
1123// },
1124// },
1125// certificate: "PRESIGNED",
1126// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001127func AndroidAppImportFactory() android.Module {
1128 module := &AndroidAppImport{}
1129 module.AddProperties(&module.properties)
1130 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001131 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001132 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001133 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001134 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001135 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001136
1137 InitJavaModule(module, android.DeviceSupported)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001138 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001139
1140 return module
1141}
Colin Cross50ddcc42019-05-16 12:28:22 -07001142
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001143type AndroidTestImport struct {
1144 AndroidAppImport
1145
1146 testProperties testProperties
1147
1148 data android.Paths
1149}
1150
1151func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1152 a.generateAndroidBuildActions(ctx)
1153
1154 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1155}
1156
1157// android_test_import imports a prebuilt test apk with additional processing specified in the
1158// module. DPI or arch variant configurations can be made as with android_app_import.
1159func AndroidTestImportFactory() android.Module {
1160 module := &AndroidTestImport{}
1161 module.AddProperties(&module.properties)
1162 module.AddProperties(&module.dexpreoptProperties)
1163 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1164 module.AddProperties(&module.testProperties)
1165 module.populateAllVariantStructs()
1166 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1167 module.processVariants(ctx)
1168 })
1169
1170 InitJavaModule(module, android.DeviceSupported)
1171 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1172
1173 return module
1174}
1175
Colin Cross50ddcc42019-05-16 12:28:22 -07001176type UsesLibraryProperties struct {
1177 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1178 Uses_libs []string
1179
1180 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1181 // required=false.
1182 Optional_uses_libs []string
1183
1184 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1185 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1186 Enforce_uses_libs *bool
1187}
1188
1189// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1190// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1191// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1192// with knowledge of their shared libraries.
1193type usesLibrary struct {
1194 usesLibraryProperties UsesLibraryProperties
1195}
1196
Paul Duffin250e6192019-06-07 10:44:37 +01001197func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001198 if !ctx.Config().UnbundledBuild() {
1199 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1200 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001201 // Only add these extra dependencies if the module depends on framework libs. This avoids
1202 // creating a cyclic dependency:
1203 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1204 if hasFrameworkLibs {
Colin Cross3245b2c2019-06-07 13:18:09 -07001205 // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs
1206 // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each
1207 // library to dexpreopt.
1208 ctx.AddVariationDependencies(nil, usesLibTag,
1209 "org.apache.http.legacy",
1210 "android.hidl.base-V1.0-java",
1211 "android.hidl.manager-V1.0-java")
1212 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001213 }
1214}
1215
1216// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1217// build.
1218func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1219 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1220 return optionalUsesLibs
1221}
1222
1223// usesLibraryPaths returns a map of module names of shared library dependencies to the paths to their dex jars.
1224func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) map[string]android.Path {
1225 usesLibPaths := make(map[string]android.Path)
1226
1227 if !ctx.Config().UnbundledBuild() {
1228 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
1229 if lib, ok := m.(Dependency); ok {
1230 if dexJar := lib.DexJar(); dexJar != nil {
1231 usesLibPaths[ctx.OtherModuleName(m)] = dexJar
1232 } else {
1233 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must produce a dex jar, does it have installable: true?",
1234 ctx.OtherModuleName(m))
1235 }
1236 } else if ctx.Config().AllowMissingDependencies() {
1237 ctx.AddMissingDependencies([]string{ctx.OtherModuleName(m)})
1238 } else {
1239 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library",
1240 ctx.OtherModuleName(m))
1241 }
1242 })
1243 }
1244
1245 return usesLibPaths
1246}
1247
1248// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1249// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1250// unconditionally in the future.
1251func (u *usesLibrary) enforceUsesLibraries() bool {
1252 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1253 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1254 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1255}
1256
1257// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1258// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1259func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1260 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1261
1262 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001263 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001264 Flag("--enforce-uses-libraries").
1265 Input(manifest).
1266 FlagWithOutput("-o ", outputFile)
1267
1268 for _, lib := range u.usesLibraryProperties.Uses_libs {
1269 cmd.FlagWithArg("--uses-library ", lib)
1270 }
1271
1272 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1273 cmd.FlagWithArg("--optional-uses-library ", lib)
1274 }
1275
1276 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1277
1278 return outputFile
1279}
1280
1281// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1282// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1283func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1284 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1285
1286 rule := android.NewRuleBuilder()
1287 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1288 rule.Command().
1289 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1290 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1291 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1292 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1293 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1294
1295 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1296
1297 return outputFile
1298}