blob: 6aa8cd6f624387b218b2e84a769b932e714d2bab [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"
Sasha Smundaka7856c02020-04-23 09:49:59 -070023 "strconv"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070024 "strings"
Colin Cross30e076a2015-04-13 13:58:27 -070025
Colin Cross50ddcc42019-05-16 12:28:22 -070026 "github.com/google/blueprint"
27 "github.com/google/blueprint/proptools"
28
Colin Cross635c3b02016-05-18 15:37:25 -070029 "android/soong/android"
Colin Crossa4f08812018-10-02 22:03:40 -070030 "android/soong/cc"
Colin Cross303e21f2018-08-07 16:49:25 -070031 "android/soong/tradefed"
Colin Cross30e076a2015-04-13 13:58:27 -070032)
33
Jaewoong Jung3e18b192019-06-11 12:25:34 -070034var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"}
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070035
Colin Cross3bc7ffa2017-11-22 16:19:37 -080036func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000037 RegisterAppBuildComponents(android.InitRegistrationContext)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -070038
39 initAndroidAppImportVariantGroupTypes()
Colin Cross3bc7ffa2017-11-22 16:19:37 -080040}
41
Paul Duffinf9b1da02019-12-18 19:51:55 +000042func RegisterAppBuildComponents(ctx android.RegistrationContext) {
43 ctx.RegisterModuleType("android_app", AndroidAppFactory)
44 ctx.RegisterModuleType("android_test", AndroidTestFactory)
45 ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
46 ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
47 ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
48 ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
Roshan Pius4df2bc72020-04-27 09:42:27 -070049 ctx.RegisterModuleType("override_runtime_resource_overlay", OverrideRuntimeResourceOverlayModuleFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000050 ctx.RegisterModuleType("android_app_import", AndroidAppImportFactory)
51 ctx.RegisterModuleType("android_test_import", AndroidTestImportFactory)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -080052 ctx.RegisterModuleType("runtime_resource_overlay", RuntimeResourceOverlayFactory)
Sasha Smundaka7856c02020-04-23 09:49:59 -070053 ctx.RegisterModuleType("android_app_set", AndroidApkSetFactory)
54}
55
56type AndroidAppSetProperties struct {
57 // APK Set path
58 Set *string
59
60 // Specifies that this app should be installed to the priv-app directory,
61 // where the system will grant it additional privileges not available to
62 // normal apps.
63 Privileged *bool
64
65 // APKs in this set use prerelease SDK version
66 Prerelease *bool
67
68 // Names of modules to be overridden. Listed modules can only be other apps
69 // (in Make or Soong).
70 Overrides []string
71}
72
73type AndroidAppSet struct {
74 android.ModuleBase
75 android.DefaultableModuleBase
76 prebuilt android.Prebuilt
77
78 properties AndroidAppSetProperties
79 packedOutput android.WritablePath
80 masterFile string
81}
82
83func (as *AndroidAppSet) Name() string {
84 return as.prebuilt.Name(as.ModuleBase.Name())
85}
86
87func (as *AndroidAppSet) IsInstallable() bool {
88 return true
89}
90
91func (as *AndroidAppSet) Prebuilt() *android.Prebuilt {
92 return &as.prebuilt
93}
94
95func (as *AndroidAppSet) Privileged() bool {
96 return Bool(as.properties.Privileged)
97}
98
Jaewoong Jungfa00c062020-05-14 14:15:24 -070099var TargetCpuAbi = map[string]string{
Sasha Smundaka7856c02020-04-23 09:49:59 -0700100 "arm": "ARMEABI_V7A",
101 "arm64": "ARM64_V8A",
102 "x86": "X86",
103 "x86_64": "X86_64",
104}
105
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700106func SupportedAbis(ctx android.ModuleContext) []string {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700107 abiName := func(archVar string, deviceArch string) string {
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700108 if abi, found := TargetCpuAbi[deviceArch]; found {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700109 return abi
110 }
111 ctx.ModuleErrorf("Invalid %s: %s", archVar, deviceArch)
112 return "BAD_ABI"
113 }
114
115 result := []string{abiName("TARGET_ARCH", ctx.DeviceConfig().DeviceArch())}
116 if s := ctx.DeviceConfig().DeviceSecondaryArch(); s != "" {
117 result = append(result, abiName("TARGET_2ND_ARCH", s))
118 }
119 return result
120}
121
122func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) {
123 as.packedOutput = android.PathForModuleOut(ctx, "extracted.zip")
124 // We are assuming here that the master file in the APK
125 // set has `.apk` suffix. If it doesn't the build will fail.
126 // APK sets containing APEX files are handled elsewhere.
127 as.masterFile = ctx.ModuleName() + ".apk"
128 screenDensities := "all"
129 if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 {
130 screenDensities = strings.ToUpper(strings.Join(dpis, ","))
131 }
132 // TODO(asmundak): handle locales.
133 // TODO(asmundak): do we support device features
134 ctx.Build(pctx,
135 android.BuildParams{
136 Rule: extractMatchingApks,
137 Description: "Extract APKs from APK set",
138 Output: as.packedOutput,
139 Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)},
140 Args: map[string]string{
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700141 "abis": strings.Join(SupportedAbis(ctx), ","),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700142 "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)),
143 "screen-densities": screenDensities,
144 "sdk-version": ctx.Config().PlatformSdkVersion(),
145 "stem": ctx.ModuleName(),
146 },
147 })
148 // TODO(asmundak): add this (it's wrong now, will cause copying extracted.zip)
149 /*
150 var installDir android.InstallPath
151 if Bool(as.properties.Privileged) {
152 installDir = android.PathForModuleInstall(ctx, "priv-app", as.BaseModuleName())
153 } else if ctx.InstallInTestcases() {
154 installDir = android.PathForModuleInstall(ctx, as.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
155 } else {
156 installDir = android.PathForModuleInstall(ctx, "app", as.BaseModuleName())
157 }
158 ctx.InstallFile(installDir, as.masterFile", as.packedOutput)
159 */
160}
161
162// android_app_set extracts a set of APKs based on the target device
163// configuration and installs this set as "split APKs".
164// The set will always contain `base-master.apk` and every APK built
165// to the target device. All density-specific APK will be included, too,
166// unless PRODUCT_APPT_PREBUILT_DPI is defined (should contain comma-sepearated
167// list of density names (LDPI, MDPI, HDPI, etc.)
168func AndroidApkSetFactory() android.Module {
169 module := &AndroidAppSet{}
170 module.AddProperties(&module.properties)
171 InitJavaModule(module, android.DeviceSupported)
172 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
173 return module
Paul Duffinf9b1da02019-12-18 19:51:55 +0000174}
175
Colin Cross30e076a2015-04-13 13:58:27 -0700176// AndroidManifest.xml merging
177// package splits
178
Colin Crossfabb6082018-02-20 17:22:23 -0800179type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700180 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -0700181 Additional_certificates []string
182
183 // If set, create package-export.apk, which other packages can
184 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -0800185 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700186
Colin Cross16056062017-12-13 22:46:28 -0800187 // Specifies that this app should be installed to the priv-app directory,
188 // where the system will grant it additional privileges not available to
189 // normal apps.
190 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700191
192 // list of resource labels to generate individual resource packages
193 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -0400194
195 // Names of modules to be overridden. Listed modules can only be other binaries
196 // (in Make or Soong).
197 // This does not completely prevent installation of the overridden binaries, but if both
198 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
199 // from PRODUCT_PACKAGES.
200 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -0700201
202 // list of native libraries that will be provided in or alongside the resulting jar
203 Jni_libs []string `android:"arch_variant"`
204
Colin Cross7204cf02020-05-06 17:51:39 -0700205 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -0800206 // sdk_version.
207 Jni_uses_platform_apis *bool
208
Colin Cross7204cf02020-05-06 17:51:39 -0700209 // if true, use JNI libraries that link against SDK APIs even if this module does not set
210 // sdk_version.
211 Jni_uses_sdk_apis *bool
212
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700213 // STL library to use for JNI libraries.
214 Stl *string `android:"arch_variant"`
215
Colin Crosse4246ab2019-02-05 21:55:21 -0800216 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
217 // 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 +0900218 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
219 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
220 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -0800221 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -0800222
223 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
224 // they are used from inside the APK at runtime.
225 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700226
227 // Forces native libraries to always be packaged into the APK,
228 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
229 // True for android_test* modules.
230 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700231
232 // If set, find and merge all NOTICE files that this module and its dependencies have and store
233 // it in the APK as an asset.
234 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700235
236 // cc.Coverage related properties
237 PreventInstall bool `blueprint:"mutated"`
238 HideFromMake bool `blueprint:"mutated"`
239 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100240
241 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100242 // additional rules to make sure an app can safely be updated. Default is false.
243 // Prefer using other specific properties if build behaviour must be changed; avoid using this
244 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100245 Updatable *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700246}
247
Jaewoong Jung525443a2019-02-28 15:35:54 -0800248// android_app properties that can be overridden by override_android_app
249type overridableAppProperties struct {
250 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
251 // or an android_app_certificate module name in the form ":module".
252 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700253
Liz Kammere2b27f42020-05-07 13:24:05 -0700254 // Name of the signing certificate lineage file.
255 Lineage *string
256
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700257 // the package name of this app. The package name in the manifest file is used if one was not given.
258 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800259
260 // the logging parent of this app.
261 Logging_parent *string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800262}
263
Roshan Pius4df2bc72020-04-27 09:42:27 -0700264// runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay
265type OverridableRuntimeResourceOverlayProperties struct {
266 // the package name of this app. The package name in the manifest file is used if one was not given.
267 Package_name *string
268
269 // the target package name of this overlay app. The target package name in the manifest file is used if one was not given.
270 Target_package_name *string
271}
272
Colin Cross30e076a2015-04-13 13:58:27 -0700273type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700274 Library
275 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800276 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700277
Colin Cross50ddcc42019-05-16 12:28:22 -0700278 usesLibrary usesLibrary
279
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900280 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700281
Colin Crossfabb6082018-02-20 17:22:23 -0800282 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700283
Jaewoong Jung525443a2019-02-28 15:35:54 -0800284 overridableAppProperties overridableAppProperties
285
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700286 installJniLibs []jniLib
287 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700288
289 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800290
291 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
292 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800293
Colin Cross70dda7e2019-10-01 22:05:35 -0700294 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700295
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700296 onDeviceDir string
297
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800298 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700299
300 noticeOutputs android.NoticeOutputs
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900301
302 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100303
304 android.ApexBundleDepsInfo
Colin Crosse1731a52017-12-14 11:22:55 -0800305}
306
Martin Stjernholm6d415272020-01-31 17:10:36 +0000307func (a *AndroidApp) IsInstallable() bool {
308 return Bool(a.properties.Installable)
309}
310
Colin Cross89c31582018-04-30 15:55:11 -0700311func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
312 return nil
313}
314
Colin Cross66f78822018-05-02 12:58:28 -0700315func (a *AndroidApp) ExportedStaticPackages() android.Paths {
316 return nil
317}
318
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900319func (a *AndroidApp) OutputFile() android.Path {
320 return a.outputFile
321}
322
Colin Cross503c1d02020-01-28 14:00:53 -0800323func (a *AndroidApp) Certificate() Certificate {
324 return a.certificate
325}
326
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700327func (a *AndroidApp) JniCoverageOutputs() android.Paths {
328 return a.jniCoverageOutputs
329}
330
Colin Crossa97c5d32018-03-28 14:58:31 -0700331var _ AndroidLibraryDependency = (*AndroidApp)(nil)
332
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900333type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800334 Pem, Key android.Path
335 presigned bool
336}
337
338var presignedCertificate = Certificate{presigned: true}
339
340func (c Certificate) AndroidMkString() string {
341 if c.presigned {
342 return "PRESIGNED"
343 } else {
344 return c.Pem.String()
345 }
Colin Cross30e076a2015-04-13 13:58:27 -0700346}
347
Colin Cross46c9b8b2017-06-22 16:51:17 -0700348func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
349 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700350
Jiyong Park6a927c42020-01-21 02:03:43 +0900351 if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700352 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
353 }
354
Paul Duffin250e6192019-06-07 10:44:37 +0100355 sdkDep := decodeSdkDep(ctx, sdkContext(a))
356 if sdkDep.hasFrameworkLibs() {
357 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700358 }
Colin Crossa4f08812018-10-02 22:03:40 -0700359
Colin Cross3c007702020-05-08 11:20:24 -0700360 usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform
361
362 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
363 ctx.PropertyErrorf("jni_uses_sdk_apis",
364 "can only be set for modules that do not set sdk_version")
365 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
366 ctx.PropertyErrorf("jni_uses_platform_apis",
367 "can only be set for modules that set sdk_version")
368 }
369
Peter Collingbournead84f972019-12-17 16:46:18 -0800370 tag := &jniDependencyTag{}
Colin Crossa4f08812018-10-02 22:03:40 -0700371 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700372 variation := append(jniTarget.Variations(),
373 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000374
375 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
376 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700377 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
378 // have stable APIs through the VNDK.
379 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
380 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700381 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000382 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
383 }
Colin Crossa4f08812018-10-02 22:03:40 -0700384 ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
385 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700386
Paul Duffin250e6192019-06-07 10:44:37 +0100387 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700388}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700389
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700390func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800391 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700392 if cert != "" {
393 ctx.AddDependency(ctx.Module(), certificateTag, cert)
394 }
395
396 for _, cert := range a.appProperties.Additional_certificates {
397 cert = android.SrcIsModule(cert)
398 if cert != "" {
399 ctx.AddDependency(ctx.Module(), certificateTag, cert)
400 } else {
401 ctx.PropertyErrorf("additional_certificates",
402 `must be names of android_app_certificate modules in the form ":module"`)
403 }
404 }
Colin Cross30e076a2015-04-13 13:58:27 -0700405}
406
Jeongik Cha538c0d02019-07-11 15:54:27 +0900407func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
408 a.generateAndroidBuildActions(ctx)
409}
410
Colin Cross46c9b8b2017-06-22 16:51:17 -0700411func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100412 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700413 a.generateAndroidBuildActions(ctx)
414}
415
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100416func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100417 if a.Updatable() {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100418 if !a.sdkVersion().stable() {
419 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion())
420 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100421 if String(a.deviceProperties.Min_sdk_version) == "" {
422 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
423 }
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900424 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
425 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
426 } else {
427 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
428 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100429 }
430
431 a.checkPlatformAPI(ctx)
432 a.checkSdkVersions(ctx)
433}
434
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900435// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
436// This check is enforced for "updatable" APKs (including APK-in-APEX).
437// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
438// because, sdk_version is overridden by min_sdk_version (if set as smaller)
439// and linkType is checked with dependencies so we can be sure that the whole dependency tree
440// will meet the requirements.
441func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
442 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
443 ctx.VisitDirectDeps(func(m android.Module) {
444 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
445 return
446 }
447 dep, _ := m.(*cc.Module)
448 jniSdkVersion, err := android.ApiStrToNum(ctx, dep.SdkVersion())
449 if err != nil || int(minSdkVersion) < jniSdkVersion {
450 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
451 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
452 return
453 }
454
455 })
456}
457
Sasha Smundak6ad77252019-05-01 13:16:22 -0700458// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800459// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700460func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900461 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800462 if err != nil {
463 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
464 }
465
Jiyong Park52cd06f2019-11-11 10:14:32 +0900466 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
467 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800468}
469
Colin Cross43f08db2018-11-12 10:13:39 -0800470// Returns whether this module should have the dex file stored uncompressed in the APK.
471func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800472 if Bool(a.appProperties.Use_embedded_dex) {
473 return true
474 }
475
Colin Cross53a87f52019-06-25 13:35:30 -0700476 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
477 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900478 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000479 return true
480 }
481
Colin Cross53a87f52019-06-25 13:35:30 -0700482 if ctx.Config().UnbundledBuild() {
483 return false
484 }
485
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700486 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700487}
488
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700489func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
490 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900491 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700492}
493
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900494func (a *AndroidApp) OverriddenManifestPackageName() string {
495 return a.overriddenManifestPackageName
496}
497
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800498func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000499 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
500
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700501 // Ask manifest_fixer to add or update the application element indicating this app has no code.
502 a.aapt.hasNoCode = !a.hasCode(ctx)
503
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800504 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800505
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800506 // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided.
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800507 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700508 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800509 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700510 }
511
Dan Willemsen72be5902018-10-24 20:24:57 -0700512 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
513 // Product AAPT config
514 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800515 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700516 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700517
Dan Willemsen72be5902018-10-24 20:24:57 -0700518 // Product AAPT preferred config
519 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800520 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700521 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700522 }
523
Jiyong Park7f67f482019-01-05 12:57:48 +0900524 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700525 if overridden || a.overridableAppProperties.Package_name != nil {
526 // The product override variable has a priority over the package_name property.
527 if !overridden {
528 manifestPackageName = *a.overridableAppProperties.Package_name
529 }
Liz Kammer1d5983b2020-05-19 19:15:37 +0000530 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900531 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900532 }
533
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800534 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
535
Colin Crosse560c4a2019-03-19 16:03:11 -0700536 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700537 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800538 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800539 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700540
Colin Cross46c9b8b2017-06-22 16:51:17 -0700541 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700542 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800543}
Colin Cross30e076a2015-04-13 13:58:27 -0700544
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800545func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700546 var staticLibProguardFlagFiles android.Paths
547 ctx.VisitDirectDeps(func(m android.Module) {
548 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
549 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
550 }
551 })
552
553 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
554
555 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
556 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800557}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800558
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800559func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800560
561 var installDir string
562 if ctx.ModuleName() == "framework-res" {
563 // framework-res.apk is installed as system/framework/framework-res.apk
564 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900565 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800566 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800567 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800568 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800569 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800570 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
David Srbeckye033cba2020-05-20 22:20:28 +0100571 if a.deviceProperties.Uncompress_dex == nil {
572 // If the value was not force-set by the user, use reasonable default based on the module.
573 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
574 }
575 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700576 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
577 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
578 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
579 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
580 a.dexpreopter.manifestFile = a.mergedManifestFile
581
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800582 if ctx.ModuleName() != "framework-res" {
583 a.Module.compile(ctx, a.aaptSrcJar)
584 }
Colin Cross30e076a2015-04-13 13:58:27 -0700585
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800586 return a.maybeStrippedDexJarFile
587}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800588
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800589func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700590 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700591 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700592 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700593 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700594 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700595 for _, jni := range jniLibs {
596 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700597 // Only collect coverage for the first target arch if this is a multilib target.
598 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
599 // data file path collisions since the current coverage file path format doesn't contain
600 // arch-related strings. This is fine for now though; the code coverage team doesn't use
601 // multi-arch targets such as test_suite_* for coverage collections yet.
602 //
603 // Work with the team to come up with a new format that handles multilib modules properly
604 // and change this.
605 if len(ctx.Config().Targets[android.Android]) == 1 ||
606 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
607 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
608 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700609 }
610 }
Colin Crossa4f08812018-10-02 22:03:40 -0700611 } else {
612 a.installJniLibs = jniLibs
613 }
614 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800615 return jniJarFile
616}
Colin Crossa4f08812018-10-02 22:03:40 -0700617
Jaewoong Jung0949f312019-09-11 10:25:18 -0700618func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700619 // Collect NOTICE files from all dependencies.
620 seenModules := make(map[android.Module]bool)
621 noticePathSet := make(map[android.Path]bool)
622
623 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
624 // Have we already seen this?
625 if _, ok := seenModules[child]; ok {
626 return false
627 }
628 seenModules[child] = true
629
630 // Skip host modules.
631 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
632 return false
633 }
634
Bob Badoura75b0572020-02-18 20:21:55 -0800635 paths := child.(android.Module).NoticeFiles()
636 if len(paths) > 0 {
637 for _, path := range paths {
638 noticePathSet[path] = true
639 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700640 }
641 return true
642 })
643
644 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800645 if len(a.NoticeFiles()) > 0 {
646 for _, path := range a.NoticeFiles() {
647 noticePathSet[path] = true
648 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700649 }
650
651 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700652 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700653 }
654 var noticePaths []android.Path
655 for path := range noticePathSet {
656 noticePaths = append(noticePaths, path)
657 }
658 sort.Slice(noticePaths, func(i, j int) bool {
659 return noticePaths[i].String() < noticePaths[j].String()
660 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700661
Jaewoong Jung0949f312019-09-11 10:25:18 -0700662 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700663}
664
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700665// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
666// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
667func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
668 if android.SrcIsModule(certPropValue) == "" {
669 var mainCert Certificate
670 if certPropValue != "" {
671 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
672 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800673 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
674 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700675 }
676 } else {
677 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800678 mainCert = Certificate{
679 Pem: pem,
680 Key: key,
681 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700682 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700683 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700684 }
685
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700686 if !m.Platform() {
687 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900688 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
689 if strings.HasPrefix(certPath, systemCertPath) {
690 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
691 whitelist := ctx.Config().EnforceSystemCertificateWhitelist()
692
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700693 if enforceSystemCert && !inList(m.Name(), whitelist) {
Jeongik Chac9464142019-01-07 12:07:27 +0900694 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
695 }
696 }
697 }
698
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700699 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800700}
701
Jooyung Han39ee1192020-03-23 20:21:11 +0900702func (a *AndroidApp) InstallApkName() string {
703 return a.installApkName
704}
705
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800706func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700707 var apkDeps android.Paths
708
Jeongik Cha538c0d02019-07-11 15:54:27 +0900709 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
710 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
711
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800712 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800713 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800714
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700715 if ctx.ModuleName() == "framework-res" {
716 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700717 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900718 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700719 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
720 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800721 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700722 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700723 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700724 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700725 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700726
Jaewoong Jung0949f312019-09-11 10:25:18 -0700727 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700728 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
729 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
730 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700731
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800732 // Process all building blocks, from AAPT to certificates.
733 a.aaptBuildActions(ctx)
734
Colin Cross50ddcc42019-05-16 12:28:22 -0700735 if a.usesLibrary.enforceUsesLibraries() {
736 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
737 apkDeps = append(apkDeps, manifestCheckFile)
738 }
739
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800740 a.proguardBuildActions(ctx)
741
742 dexJarFile := a.dexBuildActions(ctx)
743
Colin Crossc2d24052020-05-13 11:05:02 -0700744 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800745 jniJarFile := a.jniBuildActions(jniLibs, ctx)
746
747 if ctx.Failed() {
748 return
749 }
750
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700751 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
752 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800753
754 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800755 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700756 var lineageFile android.Path
757 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
758 lineageFile = android.PathForModuleSrc(ctx, lineage)
759 }
760 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800761 a.outputFile = packageFile
762
Colin Crosse560c4a2019-03-19 16:03:11 -0700763 for _, split := range a.aapt.splits {
764 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800765 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700766 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700767 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
768 }
769
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800770 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700771 bundleFile := android.PathForModuleOut(ctx, "base.zip")
772 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
773 a.bundleFile = bundleFile
774
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800775 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900776 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
777 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
778 for _, extra := range a.extraOutputFiles {
779 ctx.InstallFile(a.installDir, extra.Base(), extra)
780 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800781 }
Artur Satayev1111b842020-04-27 19:05:28 +0100782
783 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700784}
785
Colin Crossc2d24052020-05-13 11:05:02 -0700786type appDepsInterface interface {
787 sdkVersion() sdkSpec
788 minSdkVersion() sdkSpec
789 RequiresStableAPIs(ctx android.BaseModuleContext) bool
790}
791
792func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
793 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800794 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700795
Colin Crossa4f08812018-10-02 22:03:40 -0700796 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900797 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800798 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700799
Colin Crossc2d24052020-05-13 11:05:02 -0700800 if checkNativeSdkVersion {
801 checkNativeSdkVersion = app.sdkVersion().specified() &&
802 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
803 }
804
Peter Collingbournead84f972019-12-17 16:46:18 -0800805 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700806 otherName := ctx.OtherModuleName(module)
807 tag := ctx.OtherModuleDependencyTag(module)
808
Peter Collingbournead84f972019-12-17 16:46:18 -0800809 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700810 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800811 if dep.IsNdk() || dep.IsStubs() {
812 return false
813 }
814
Colin Crossa4f08812018-10-02 22:03:40 -0700815 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800816 path := lib.Path()
817 if seenModulePaths[path.String()] {
818 return false
819 }
820 seenModulePaths[path.String()] = true
821
Colin Crossc2d24052020-05-13 11:05:02 -0700822 if checkNativeSdkVersion && dep.SdkVersion() == "" {
823 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
824 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800825 }
826
Colin Crossa4f08812018-10-02 22:03:40 -0700827 if lib.Valid() {
828 jniLibs = append(jniLibs, jniLib{
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700829 name: ctx.OtherModuleName(module),
830 path: path,
831 target: module.Target(),
832 coverageFile: dep.CoverageOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700833 })
834 } else {
835 ctx.ModuleErrorf("dependency %q missing output file", otherName)
836 }
837 } else {
838 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700839 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800840
841 return shouldCollectRecursiveNativeDeps
842 }
843
844 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700845 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900846 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700847 } else {
848 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
849 }
Colin Crossa4f08812018-10-02 22:03:40 -0700850 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800851
852 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700853 })
854
Colin Crossbd01e2a2018-10-04 15:21:03 -0700855 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700856}
857
Artur Satayev1111b842020-04-27 19:05:28 +0100858func (a *AndroidApp) walkPayloadDeps(ctx android.ModuleContext,
859 do func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool)) {
860
861 ctx.WalkDeps(func(child, parent android.Module) bool {
862 isExternal := !a.DepIsInSameApex(ctx, child)
863 if am, ok := child.(android.ApexModule); ok {
864 do(ctx, parent, am, isExternal)
865 }
866 return !isExternal
867 })
868}
869
870func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
871 if ctx.Host() {
872 return
873 }
874
875 depsInfo := android.DepNameToDepInfoMap{}
876 a.walkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) {
877 depName := to.Name()
878 if info, exist := depsInfo[depName]; exist {
879 info.From = append(info.From, from.Name())
880 info.IsExternal = info.IsExternal && externalDep
881 depsInfo[depName] = info
882 } else {
883 toMinSdkVersion := "(no version)"
884 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
885 if v := m.MinSdkVersion(); v != "" {
886 toMinSdkVersion = v
887 }
888 }
889 depsInfo[depName] = android.ApexModuleDepInfo{
890 To: depName,
891 From: []string{from.Name()},
892 IsExternal: externalDep,
893 MinSdkVersion: toMinSdkVersion,
894 }
895 }
896 })
897
898 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
899}
900
Artur Satayev849f8442020-04-28 14:57:42 +0100901func (a *AndroidApp) Updatable() bool {
902 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
903}
904
Colin Cross0ea8ba82019-06-06 14:33:29 -0700905func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800906 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
907 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000908 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800909 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800910 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800911}
912
Jiyong Park0f80c182020-01-31 02:49:53 +0900913func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
914 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
915 return true
916 }
917 return a.Library.DepIsInSameApex(ctx, dep)
918}
919
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900920// For OutputFileProducer interface
921func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
922 switch tag {
923 case ".aapt.srcjar":
924 return []android.Path{a.aaptSrcJar}, nil
925 }
926 return a.Library.OutputFiles(tag)
927}
928
Jiyong Parkf7487312019-10-17 12:54:30 +0900929func (a *AndroidApp) Privileged() bool {
930 return Bool(a.appProperties.Privileged)
931}
932
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700933func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
934 return ctx.Device() && (ctx.DeviceConfig().NativeCoverageEnabled() || ctx.DeviceConfig().ClangCoverageEnabled())
935}
936
937func (a *AndroidApp) PreventInstall() {
938 a.appProperties.PreventInstall = true
939}
940
941func (a *AndroidApp) HideFromMake() {
942 a.appProperties.HideFromMake = true
943}
944
945func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
946 a.appProperties.IsCoverageVariant = coverage
947}
948
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400949func (a *AndroidApp) EnableCoverageIfNeeded() {}
950
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700951var _ cc.Coverage = (*AndroidApp)(nil)
952
Colin Cross1b16b0e2019-02-12 14:41:32 -0800953// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700954func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700955 module := &AndroidApp{}
956
Sasha Smundak2057f822019-04-16 17:16:58 -0700957 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800958 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
959
Colin Crossae5caf52018-05-22 11:11:52 -0700960 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700961 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700962
Colin Cross36242852017-06-23 15:06:31 -0700963 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -0700964 &module.Module.properties,
965 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -0800966 &module.Module.dexpreoptProperties,
Colin Crossa97c5d32018-03-28 14:58:31 -0700967 &module.Module.protoProperties,
968 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800969 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700970 &module.overridableAppProperties,
971 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700972
Colin Crossa9d8bee2018-10-02 13:59:46 -0700973 module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
974 return class == android.Device && ctx.Config().DevicePrefer32BitApps()
975 })
976
Colin Crossa4f08812018-10-02 22:03:40 -0700977 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
978 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -0800979 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +0900980 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -0700981
Colin Cross36242852017-06-23 15:06:31 -0700982 return module
Colin Cross30e076a2015-04-13 13:58:27 -0700983}
Colin Crossae5caf52018-05-22 11:11:52 -0700984
985type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -0700986 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -0700987 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -0700988
989 // if specified, the instrumentation target package name in the manifest is overwritten by it.
990 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -0700991}
992
993type AndroidTest struct {
994 AndroidApp
995
996 appTestProperties appTestProperties
997
998 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -0700999
1000 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001001 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001002}
1003
Jaewoong Jung0949f312019-09-11 10:25:18 -07001004func (a *AndroidTest) InstallInTestcases() bool {
1005 return true
1006}
1007
Colin Crossae5caf52018-05-22 11:11:52 -07001008func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001009 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001010 if a.appTestProperties.Instrumentation_target_package != nil {
1011 a.additionalAaptFlags = append(a.additionalAaptFlags,
1012 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1013 } else if a.appTestProperties.Instrumentation_for != nil {
1014 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001015 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1016 if overridden {
1017 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1018 }
1019 }
Colin Crossae5caf52018-05-22 11:11:52 -07001020 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001021
easoncylee5bcff5d2020-04-30 14:57:06 +08001022 for _, module := range a.testProperties.Test_mainline_modules {
1023 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1024 }
1025
Jaewoong Jung39982342020-01-14 10:27:18 -08001026 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001027 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001028 a.testConfig = a.FixTestConfig(ctx, testConfig)
Colin Cross8a497952019-03-05 22:25:09 -08001029 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001030}
1031
Jaewoong Jung39982342020-01-14 10:27:18 -08001032func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1033 if testConfig == nil {
1034 return nil
1035 }
1036
1037 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
1038 rule := android.NewRuleBuilder()
1039 command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig)
1040 fixNeeded := false
1041
1042 if ctx.ModuleName() != a.installApkName {
1043 fixNeeded = true
1044 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1045 }
1046
1047 if a.overridableAppProperties.Package_name != nil {
1048 fixNeeded = true
1049 command.FlagWithInput("--manifest ", a.manifestPath).
1050 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1051 }
1052
1053 if fixNeeded {
1054 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
1055 return fixedConfig
1056 }
1057 return testConfig
1058}
1059
Colin Cross303e21f2018-08-07 16:49:25 -07001060func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001061 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001062}
1063
1064func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1065 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001066 if a.appTestProperties.Instrumentation_for != nil {
1067 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1068 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1069 // use instrumentationForTag instead of libTag.
1070 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1071 }
Colin Crossae5caf52018-05-22 11:11:52 -07001072}
1073
Colin Cross1b16b0e2019-02-12 14:41:32 -08001074// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1075// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001076func AndroidTestFactory() android.Module {
1077 module := &AndroidTest{}
1078
Sasha Smundak2057f822019-04-16 17:16:58 -07001079 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -07001080
1081 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001082 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001083 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001084 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001085 module.Module.dexpreopter.isTest = true
Colin Crossae5caf52018-05-22 11:11:52 -07001086
1087 module.AddProperties(
1088 &module.Module.properties,
1089 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001090 &module.Module.dexpreoptProperties,
Colin Crossae5caf52018-05-22 11:11:52 -07001091 &module.Module.protoProperties,
1092 &module.aaptProperties,
1093 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001094 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001095 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001096 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001097 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001098
Colin Crossa4f08812018-10-02 22:03:40 -07001099 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1100 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001101 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001102 return module
1103}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001104
Colin Cross252fc6f2018-10-04 15:22:03 -07001105type appTestHelperAppProperties struct {
1106 // list of compatibility suites (for example "cts", "vts") that the module should be
1107 // installed into.
1108 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001109
1110 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1111 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1112 // explicitly.
1113 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001114}
1115
1116type AndroidTestHelperApp struct {
1117 AndroidApp
1118
1119 appTestHelperAppProperties appTestHelperAppProperties
1120}
1121
Jaewoong Jung326a9412019-11-21 10:41:00 -08001122func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1123 return true
1124}
1125
Colin Cross1b16b0e2019-02-12 14:41:32 -08001126// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1127// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1128// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001129func AndroidTestHelperAppFactory() android.Module {
1130 module := &AndroidTestHelperApp{}
1131
Sasha Smundak2057f822019-04-16 17:16:58 -07001132 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001133
1134 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001135 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001136 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001137 module.Module.dexpreopter.isTest = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001138
1139 module.AddProperties(
1140 &module.Module.properties,
1141 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001142 &module.Module.dexpreoptProperties,
Colin Cross252fc6f2018-10-04 15:22:03 -07001143 &module.Module.protoProperties,
1144 &module.aaptProperties,
1145 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001146 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001147 &module.overridableAppProperties,
1148 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001149
1150 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1151 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001152 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001153 return module
1154}
1155
Colin Crossbd01e2a2018-10-04 15:21:03 -07001156type AndroidAppCertificate struct {
1157 android.ModuleBase
1158 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001159 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001160}
1161
1162type AndroidAppCertificateProperties struct {
1163 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1164 Certificate *string
1165}
1166
Colin Cross1b16b0e2019-02-12 14:41:32 -08001167// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1168// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001169func AndroidAppCertificateFactory() android.Module {
1170 module := &AndroidAppCertificate{}
1171 module.AddProperties(&module.properties)
1172 android.InitAndroidModule(module)
1173 return module
1174}
1175
Colin Crossbd01e2a2018-10-04 15:21:03 -07001176func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1177 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001178 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001179 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1180 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001181 }
1182}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001183
1184type OverrideAndroidApp struct {
1185 android.ModuleBase
1186 android.OverrideModuleBase
1187}
1188
1189func (i *OverrideAndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1190 // All the overrides happen in the base module.
1191 // TODO(jungjw): Check the base module type.
1192}
1193
1194// override_android_app is used to create an android_app module based on another android_app by overriding
1195// some of its properties.
1196func OverrideAndroidAppModuleFactory() android.Module {
1197 m := &OverrideAndroidApp{}
1198 m.AddProperties(&overridableAppProperties{})
1199
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001200 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001201 android.InitOverrideModule(m)
1202 return m
1203}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001204
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001205type OverrideAndroidTest struct {
1206 android.ModuleBase
1207 android.OverrideModuleBase
1208}
1209
1210func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1211 // All the overrides happen in the base module.
1212 // TODO(jungjw): Check the base module type.
1213}
1214
1215// override_android_test is used to create an android_app module based on another android_test by overriding
1216// some of its properties.
1217func OverrideAndroidTestModuleFactory() android.Module {
1218 m := &OverrideAndroidTest{}
1219 m.AddProperties(&overridableAppProperties{})
1220 m.AddProperties(&appTestProperties{})
1221
1222 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1223 android.InitOverrideModule(m)
1224 return m
1225}
1226
Roshan Pius4df2bc72020-04-27 09:42:27 -07001227type OverrideRuntimeResourceOverlay struct {
1228 android.ModuleBase
1229 android.OverrideModuleBase
1230}
1231
1232func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1233 // All the overrides happen in the base module.
1234 // TODO(jungjw): Check the base module type.
1235}
1236
1237// override_runtime_resource_overlay is used to create a module based on another
1238// runtime_resource_overlay module by overriding some of its properties.
1239func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1240 m := &OverrideRuntimeResourceOverlay{}
1241 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1242
1243 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1244 android.InitOverrideModule(m)
1245 return m
1246}
1247
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001248type AndroidAppImport struct {
1249 android.ModuleBase
1250 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001251 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001252 prebuilt android.Prebuilt
1253
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001254 properties AndroidAppImportProperties
1255 dpiVariants interface{}
1256 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001257
1258 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001259 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001260
1261 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001262
1263 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001264
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001265 preprocessed bool
1266
Colin Cross70dda7e2019-10-01 22:05:35 -07001267 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001268}
1269
1270type AndroidAppImportProperties struct {
1271 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001272 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001273
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001274 // The name of a certificate in the default certificate directory or an android_app_certificate
1275 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001276 Certificate *string
1277
1278 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1279 // be set for presigned modules.
1280 Presigned *bool
1281
Liz Kammer24978992020-05-13 15:49:21 -07001282 // Name of the signing certificate lineage file.
1283 Lineage *string
1284
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001285 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1286 // need to either specify a specific certificate or be presigned.
1287 Default_dev_cert *bool
1288
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001289 // Specifies that this app should be installed to the priv-app directory,
1290 // where the system will grant it additional privileges not available to
1291 // normal apps.
1292 Privileged *bool
1293
1294 // Names of modules to be overridden. Listed modules can only be other binaries
1295 // (in Make or Soong).
1296 // This does not completely prevent installation of the overridden binaries, but if both
1297 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1298 // from PRODUCT_PACKAGES.
1299 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001300
1301 // Optional name for the installed app. If unspecified, it is derived from the module name.
1302 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001303}
1304
Martin Stjernholm6d415272020-01-31 17:10:36 +00001305func (a *AndroidAppImport) IsInstallable() bool {
1306 return true
1307}
1308
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001309// Updates properties with variant-specific values.
1310func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001311 config := ctx.Config()
1312
1313 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1314 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1315 // overwrites everything else.
1316 // TODO(jungjw): Can we optimize this by making it priority order?
1317 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001318 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001319 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001320 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001321 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001322 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001323
1324 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1325 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1326 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001327}
1328
Colin Cross1184b642019-12-30 18:43:07 -08001329func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001330 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001331 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1332 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001333 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001334 }
1335
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001336 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1337 if err != nil {
1338 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1339 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1340 } else {
1341 panic(err)
1342 }
1343 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001344}
1345
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001346func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1347 cert := android.SrcIsModule(String(a.properties.Certificate))
1348 if cert != "" {
1349 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1350 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001351
Paul Duffin250e6192019-06-07 10:44:37 +01001352 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001353}
1354
1355func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1356 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001357 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1358 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001359 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001360 ctx.Build(pctx, android.BuildParams{
1361 Rule: android.Cp,
1362 Output: outputPath,
1363 Input: inputPath,
1364 })
1365 return
1366 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001367 rule := android.NewRuleBuilder()
1368 rule.Command().
1369 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001370 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001371 FlagWithInput("-i ", inputPath).
1372 FlagWithOutput("-o ", outputPath).
1373 FlagWithArg("-0 ", "'lib/**/*.so'").
1374 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1375 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1376}
1377
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001378// Returns whether this module should have the dex file stored uncompressed in the APK.
1379func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001380 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001381 return false
1382 }
1383
1384 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001385 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001386 return true
1387 }
1388
1389 return shouldUncompressDex(ctx, &a.dexpreopter)
1390}
1391
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001392func (a *AndroidAppImport) uncompressDex(
1393 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1394 rule := android.NewRuleBuilder()
1395 rule.Command().
1396 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001397 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001398 FlagWithInput("-i ", inputPath).
1399 FlagWithOutput("-o ", outputPath).
1400 FlagWithArg("-0 ", "'classes*.dex'").
1401 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1402 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1403}
1404
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001405func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001406 a.generateAndroidBuildActions(ctx)
1407}
1408
Jooyung Han39ee1192020-03-23 20:21:11 +09001409func (a *AndroidAppImport) InstallApkName() string {
1410 return a.BaseModuleName()
1411}
1412
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001413func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001414 numCertPropsSet := 0
1415 if String(a.properties.Certificate) != "" {
1416 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001417 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001418 if Bool(a.properties.Presigned) {
1419 numCertPropsSet++
1420 }
1421 if Bool(a.properties.Default_dev_cert) {
1422 numCertPropsSet++
1423 }
1424 if numCertPropsSet != 1 {
1425 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001426 }
1427
Colin Crossc2d24052020-05-13 11:05:02 -07001428 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001429
1430 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001431 // TODO: LOCAL_PACKAGE_SPLITS
1432
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001433 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001434
1435 if a.usesLibrary.enforceUsesLibraries() {
1436 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1437 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001438
1439 // TODO: Install or embed JNI libraries
1440
1441 // Uncompress JNI libraries in the apk
1442 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1443 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1444
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001445 var installDir android.InstallPath
1446 if Bool(a.properties.Privileged) {
1447 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001448 } else if ctx.InstallInTestcases() {
1449 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001450 } else {
1451 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1452 }
1453
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001454 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001455 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001456 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001457
1458 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1459 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1460 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1461 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1462
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001463 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001464 if a.dexpreopter.uncompressedDex {
1465 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1466 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1467 dexOutput = dexUncompressed
1468 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001469
Jooyung Han39ee1192020-03-23 20:21:11 +09001470 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1471
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001472 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001473
1474 // Sign or align the package if package has not been preprocessed
1475 if a.preprocessed {
1476 a.outputFile = srcApk
1477 a.certificate = presignedCertificate
1478 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001479 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1480 // Which makes processMainCert's behavior for the empty cert string WAI.
1481 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001482 if len(certificates) != 1 {
1483 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1484 }
Colin Cross503c1d02020-01-28 14:00:53 -08001485 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001486 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer24978992020-05-13 15:49:21 -07001487 var lineageFile android.Path
1488 if lineage := String(a.properties.Lineage); lineage != "" {
1489 lineageFile = android.PathForModuleSrc(ctx, lineage)
1490 }
1491 SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001492 a.outputFile = signed
1493 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001494 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001495 TransformZipAlign(ctx, alignedApk, dexOutput)
1496 a.outputFile = alignedApk
Colin Cross503c1d02020-01-28 14:00:53 -08001497 a.certificate = presignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001498 }
1499
1500 // TODO: Optionally compress the output apk.
1501
Jiyong Park592a6a42020-04-21 22:34:28 +09001502 if a.IsForPlatform() {
1503 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1504 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001505
1506 // TODO: androidmk converter jni libs
1507}
1508
1509func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1510 return &a.prebuilt
1511}
1512
1513func (a *AndroidAppImport) Name() string {
1514 return a.prebuilt.Name(a.ModuleBase.Name())
1515}
1516
Dario Frenicde2a032019-10-27 00:29:22 +01001517func (a *AndroidAppImport) OutputFile() android.Path {
1518 return a.outputFile
1519}
1520
Jiyong Park618922e2020-01-08 13:35:43 +09001521func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1522 return nil
1523}
1524
Colin Cross503c1d02020-01-28 14:00:53 -08001525func (a *AndroidAppImport) Certificate() Certificate {
1526 return a.certificate
1527}
1528
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001529var dpiVariantGroupType reflect.Type
1530var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001531
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001532func initAndroidAppImportVariantGroupTypes() {
1533 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1534
1535 archNames := make([]string, len(android.ArchTypeList()))
1536 for i, archType := range android.ArchTypeList() {
1537 archNames[i] = archType.Name
1538 }
1539 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1540}
1541
1542// Populates all variant struct properties at creation time.
1543func (a *AndroidAppImport) populateAllVariantStructs() {
1544 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1545 a.AddProperties(a.dpiVariants)
1546
1547 a.archVariants = reflect.New(archVariantGroupType).Interface()
1548 a.AddProperties(a.archVariants)
1549}
1550
Jiyong Parkf7487312019-10-17 12:54:30 +09001551func (a *AndroidAppImport) Privileged() bool {
1552 return Bool(a.properties.Privileged)
1553}
1554
Jiyong Park592a6a42020-04-21 22:34:28 +09001555func (a *AndroidAppImport) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1556 // android_app_import might have extra dependencies via uses_libs property.
1557 // Don't track the dependency as we don't automatically add those libraries
1558 // to the classpath. It should be explicitly added to java_libs property of APEX
1559 return false
1560}
1561
Colin Crossc2d24052020-05-13 11:05:02 -07001562func (a *AndroidAppImport) sdkVersion() sdkSpec {
1563 return sdkSpecFrom("")
1564}
1565
1566func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1567 return sdkSpecFrom("")
1568}
1569
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001570func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1571 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1572
1573 variantFields := make([]reflect.StructField, len(variants))
1574 for i, variant := range variants {
1575 variantFields[i] = reflect.StructField{
1576 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001577 Type: props,
1578 }
1579 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001580
1581 variantGroupStruct := reflect.StructOf(variantFields)
1582 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001583 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001584 Name: variantGroupName,
1585 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001586 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001587 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001588}
1589
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001590// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001591// DPI-specific apk source files can be specified using dpi_variants. Example:
1592//
1593// android_app_import {
1594// name: "example_import",
1595// apk: "prebuilts/example.apk",
1596// dpi_variants: {
1597// mdpi: {
1598// apk: "prebuilts/example_mdpi.apk",
1599// },
1600// xhdpi: {
1601// apk: "prebuilts/example_xhdpi.apk",
1602// },
1603// },
1604// certificate: "PRESIGNED",
1605// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001606func AndroidAppImportFactory() android.Module {
1607 module := &AndroidAppImport{}
1608 module.AddProperties(&module.properties)
1609 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001610 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001611 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001612 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001613 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001614 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001615
Jiyong Park592a6a42020-04-21 22:34:28 +09001616 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001617 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1618 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001619 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001620
1621 return module
1622}
Colin Cross50ddcc42019-05-16 12:28:22 -07001623
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001624type androidTestImportProperties struct {
1625 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1626 Preprocessed *bool
1627}
1628
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001629type AndroidTestImport struct {
1630 AndroidAppImport
1631
1632 testProperties testProperties
1633
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001634 testImportProperties androidTestImportProperties
1635
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001636 data android.Paths
1637}
1638
1639func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001640 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1641
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001642 a.generateAndroidBuildActions(ctx)
1643
1644 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1645}
1646
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001647func (a *AndroidTestImport) InstallInTestcases() bool {
1648 return true
1649}
1650
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001651// android_test_import imports a prebuilt test apk with additional processing specified in the
1652// module. DPI or arch variant configurations can be made as with android_app_import.
1653func AndroidTestImportFactory() android.Module {
1654 module := &AndroidTestImport{}
1655 module.AddProperties(&module.properties)
1656 module.AddProperties(&module.dexpreoptProperties)
1657 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1658 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001659 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001660 module.populateAllVariantStructs()
1661 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1662 module.processVariants(ctx)
1663 })
1664
Colin Crossc80828d2020-05-06 22:29:10 -07001665 module.dexpreopter.isTest = true
1666
Jiyong Park592a6a42020-04-21 22:34:28 +09001667 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001668 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1669 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001670 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1671
1672 return module
1673}
1674
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001675type RuntimeResourceOverlay struct {
1676 android.ModuleBase
1677 android.DefaultableModuleBase
Roshan Pius4df2bc72020-04-27 09:42:27 -07001678 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001679 aapt
1680
Roshan Pius4df2bc72020-04-27 09:42:27 -07001681 properties RuntimeResourceOverlayProperties
1682 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001683
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001684 certificate Certificate
1685
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001686 outputFile android.Path
1687 installDir android.InstallPath
1688}
1689
1690type RuntimeResourceOverlayProperties struct {
1691 // the name of a certificate in the default certificate directory or an android_app_certificate
1692 // module name in the form ":module".
1693 Certificate *string
1694
Liz Kammer966b2f02020-05-19 16:15:25 -07001695 // Name of the signing certificate lineage file.
1696 Lineage *string
1697
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001698 // optional theme name. If specified, the overlay package will be applied
1699 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1700 Theme *string
1701
1702 // if not blank, set to the version of the sdk to compile against.
1703 // Defaults to compiling against the current platform.
1704 Sdk_version *string
1705
1706 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1707 // Defaults to sdk_version if not set.
1708 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001709
1710 // list of android_library modules whose resources are extracted and linked against statically
1711 Static_libs []string
1712
1713 // list of android_app modules whose resources are extracted and linked against
1714 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001715
1716 // Names of modules to be overridden. Listed modules can only be other overlays
1717 // (in Make or Soong).
1718 // This does not completely prevent installation of the overridden overlays, but if both
1719 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1720 // from PRODUCT_PACKAGES.
1721 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001722}
1723
Jiyong Park69aeba92020-04-24 21:16:36 +09001724// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1725// a RuntimeResourceOverlay module.
1726type RuntimeResourceOverlayModule interface {
1727 android.Module
1728 OutputFile() android.Path
1729 Certificate() Certificate
1730 Theme() string
1731}
1732
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001733func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1734 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1735 if sdkDep.hasFrameworkLibs() {
1736 r.aapt.deps(ctx, sdkDep)
1737 }
1738
1739 cert := android.SrcIsModule(String(r.properties.Certificate))
1740 if cert != "" {
1741 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1742 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001743
1744 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1745 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001746}
1747
1748func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1749 // Compile and link resources
1750 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001751 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Pius4df2bc72020-04-27 09:42:27 -07001752 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1753 // Allow the override of "package name" and "overlay target package name"
1754 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1755 if overridden || r.overridableProperties.Package_name != nil {
1756 // The product override variable has a priority over the package_name property.
1757 if !overridden {
1758 manifestPackageName = *r.overridableProperties.Package_name
1759 }
1760 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1761 }
1762 if r.overridableProperties.Target_package_name != nil {
1763 aaptLinkFlags = append(aaptLinkFlags,
1764 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1765 }
1766 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001767
1768 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001769 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001770 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1771 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer966b2f02020-05-19 16:15:25 -07001772 var lineageFile android.Path
1773 if lineage := String(r.properties.Lineage); lineage != "" {
1774 lineageFile = android.PathForModuleSrc(ctx, lineage)
1775 }
1776 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001777 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001778
1779 r.outputFile = signed
1780 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1781 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1782}
1783
Jiyong Park6a927c42020-01-21 02:03:43 +09001784func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1785 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001786}
1787
1788func (r *RuntimeResourceOverlay) systemModules() string {
1789 return ""
1790}
1791
Jiyong Park6a927c42020-01-21 02:03:43 +09001792func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001793 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001794 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001795 }
1796 return r.sdkVersion()
1797}
1798
Jiyong Park6a927c42020-01-21 02:03:43 +09001799func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001800 return r.sdkVersion()
1801}
1802
Jiyong Park69aeba92020-04-24 21:16:36 +09001803func (r *RuntimeResourceOverlay) Certificate() Certificate {
1804 return r.certificate
1805}
1806
1807func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1808 return r.outputFile
1809}
1810
1811func (r *RuntimeResourceOverlay) Theme() string {
1812 return String(r.properties.Theme)
1813}
1814
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001815// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1816// system resources at run time.
1817func RuntimeResourceOverlayFactory() android.Module {
1818 module := &RuntimeResourceOverlay{}
1819 module.AddProperties(
1820 &module.properties,
Roshan Pius4df2bc72020-04-27 09:42:27 -07001821 &module.aaptProperties,
1822 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001823
Roshan Pius4df2bc72020-04-27 09:42:27 -07001824 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1825 android.InitDefaultableModule(module)
1826 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001827 return module
1828}
1829
Colin Cross50ddcc42019-05-16 12:28:22 -07001830type UsesLibraryProperties struct {
1831 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1832 Uses_libs []string
1833
1834 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1835 // required=false.
1836 Optional_uses_libs []string
1837
1838 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1839 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1840 Enforce_uses_libs *bool
1841}
1842
1843// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1844// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1845// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1846// with knowledge of their shared libraries.
1847type usesLibrary struct {
1848 usesLibraryProperties UsesLibraryProperties
1849}
1850
Paul Duffin250e6192019-06-07 10:44:37 +01001851func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001852 if !ctx.Config().UnbundledBuild() {
1853 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1854 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001855 // Only add these extra dependencies if the module depends on framework libs. This avoids
1856 // creating a cyclic dependency:
1857 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1858 if hasFrameworkLibs {
Colin Cross3245b2c2019-06-07 13:18:09 -07001859 // dexpreopt/dexpreopt.go needs the paths to the dex jars of these libraries in case construct_context.sh needs
1860 // to pass them to dex2oat. Add them as a dependency so we can determine the path to the dex jar of each
1861 // library to dexpreopt.
1862 ctx.AddVariationDependencies(nil, usesLibTag,
1863 "org.apache.http.legacy",
1864 "android.hidl.base-V1.0-java",
1865 "android.hidl.manager-V1.0-java")
1866 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001867 }
1868}
1869
1870// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1871// build.
1872func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1873 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1874 return optionalUsesLibs
1875}
1876
1877// usesLibraryPaths returns a map of module names of shared library dependencies to the paths to their dex jars.
1878func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) map[string]android.Path {
1879 usesLibPaths := make(map[string]android.Path)
1880
1881 if !ctx.Config().UnbundledBuild() {
1882 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
1883 if lib, ok := m.(Dependency); ok {
1884 if dexJar := lib.DexJar(); dexJar != nil {
1885 usesLibPaths[ctx.OtherModuleName(m)] = dexJar
1886 } else {
1887 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must produce a dex jar, does it have installable: true?",
1888 ctx.OtherModuleName(m))
1889 }
1890 } else if ctx.Config().AllowMissingDependencies() {
1891 ctx.AddMissingDependencies([]string{ctx.OtherModuleName(m)})
1892 } else {
1893 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library",
1894 ctx.OtherModuleName(m))
1895 }
1896 })
1897 }
1898
1899 return usesLibPaths
1900}
1901
1902// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1903// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1904// unconditionally in the future.
1905func (u *usesLibrary) enforceUsesLibraries() bool {
1906 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1907 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1908 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1909}
1910
1911// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1912// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1913func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1914 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1915
1916 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001917 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001918 Flag("--enforce-uses-libraries").
1919 Input(manifest).
1920 FlagWithOutput("-o ", outputFile)
1921
1922 for _, lib := range u.usesLibraryProperties.Uses_libs {
1923 cmd.FlagWithArg("--uses-library ", lib)
1924 }
1925
1926 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1927 cmd.FlagWithArg("--optional-uses-library ", lib)
1928 }
1929
1930 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1931
1932 return outputFile
1933}
1934
1935// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1936// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1937func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1938 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1939
1940 rule := android.NewRuleBuilder()
1941 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1942 rule.Command().
1943 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1944 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1945 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1946 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1947 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1948
1949 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1950
1951 return outputFile
1952}