blob: a012815de3fe32a47daffc019dc22d3640bc4c57 [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"
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +010031 "android/soong/dexpreopt"
Colin Cross303e21f2018-08-07 16:49:25 -070032 "android/soong/tradefed"
Colin Cross30e076a2015-04-13 13:58:27 -070033)
34
Jaewoong Jung3e18b192019-06-11 12:25:34 -070035var supportedDpis = []string{"ldpi", "mdpi", "hdpi", "xhdpi", "xxhdpi", "xxxhdpi"}
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070036
Colin Cross3bc7ffa2017-11-22 16:19:37 -080037func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000038 RegisterAppBuildComponents(android.InitRegistrationContext)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -070039
40 initAndroidAppImportVariantGroupTypes()
Colin Cross3bc7ffa2017-11-22 16:19:37 -080041}
42
Paul Duffinf9b1da02019-12-18 19:51:55 +000043func RegisterAppBuildComponents(ctx android.RegistrationContext) {
44 ctx.RegisterModuleType("android_app", AndroidAppFactory)
45 ctx.RegisterModuleType("android_test", AndroidTestFactory)
46 ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
47 ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
48 ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
49 ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
Roshan Pius4df2bc72020-04-27 09:42:27 -070050 ctx.RegisterModuleType("override_runtime_resource_overlay", OverrideRuntimeResourceOverlayModuleFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000051 ctx.RegisterModuleType("android_app_import", AndroidAppImportFactory)
52 ctx.RegisterModuleType("android_test_import", AndroidTestImportFactory)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -080053 ctx.RegisterModuleType("runtime_resource_overlay", RuntimeResourceOverlayFactory)
Sasha Smundaka7856c02020-04-23 09:49:59 -070054 ctx.RegisterModuleType("android_app_set", AndroidApkSetFactory)
55}
56
57type AndroidAppSetProperties struct {
58 // APK Set path
59 Set *string
60
61 // Specifies that this app should be installed to the priv-app directory,
62 // where the system will grant it additional privileges not available to
63 // normal apps.
64 Privileged *bool
65
66 // APKs in this set use prerelease SDK version
67 Prerelease *bool
68
69 // Names of modules to be overridden. Listed modules can only be other apps
70 // (in Make or Soong).
71 Overrides []string
72}
73
74type AndroidAppSet struct {
75 android.ModuleBase
76 android.DefaultableModuleBase
77 prebuilt android.Prebuilt
78
79 properties AndroidAppSetProperties
80 packedOutput android.WritablePath
81 masterFile string
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -070082 apkcertsFile android.ModuleOutPath
Sasha Smundaka7856c02020-04-23 09:49:59 -070083}
84
85func (as *AndroidAppSet) Name() string {
86 return as.prebuilt.Name(as.ModuleBase.Name())
87}
88
89func (as *AndroidAppSet) IsInstallable() bool {
90 return true
91}
92
93func (as *AndroidAppSet) Prebuilt() *android.Prebuilt {
94 return &as.prebuilt
95}
96
97func (as *AndroidAppSet) Privileged() bool {
98 return Bool(as.properties.Privileged)
99}
100
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700101func (as *AndroidAppSet) OutputFile() android.Path {
102 return as.packedOutput
103}
104
105func (as *AndroidAppSet) MasterFile() string {
106 return as.masterFile
107}
108
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700109var TargetCpuAbi = map[string]string{
Sasha Smundaka7856c02020-04-23 09:49:59 -0700110 "arm": "ARMEABI_V7A",
111 "arm64": "ARM64_V8A",
112 "x86": "X86",
113 "x86_64": "X86_64",
114}
115
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700116func SupportedAbis(ctx android.ModuleContext) []string {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700117 abiName := func(archVar string, deviceArch string) string {
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700118 if abi, found := TargetCpuAbi[deviceArch]; found {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700119 return abi
120 }
121 ctx.ModuleErrorf("Invalid %s: %s", archVar, deviceArch)
122 return "BAD_ABI"
123 }
124
125 result := []string{abiName("TARGET_ARCH", ctx.DeviceConfig().DeviceArch())}
126 if s := ctx.DeviceConfig().DeviceSecondaryArch(); s != "" {
127 result = append(result, abiName("TARGET_2ND_ARCH", s))
128 }
129 return result
130}
131
132func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700133 as.packedOutput = android.PathForModuleOut(ctx, ctx.ModuleName()+".zip")
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700134 as.apkcertsFile = android.PathForModuleOut(ctx, "apkcerts.txt")
Sasha Smundaka7856c02020-04-23 09:49:59 -0700135 // We are assuming here that the master file in the APK
136 // set has `.apk` suffix. If it doesn't the build will fail.
137 // APK sets containing APEX files are handled elsewhere.
Sasha Smundak57f0ee12020-06-15 18:25:27 -0700138 as.masterFile = as.BaseModuleName() + ".apk"
Sasha Smundaka7856c02020-04-23 09:49:59 -0700139 screenDensities := "all"
140 if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 {
141 screenDensities = strings.ToUpper(strings.Join(dpis, ","))
142 }
143 // TODO(asmundak): handle locales.
144 // TODO(asmundak): do we support device features
145 ctx.Build(pctx,
146 android.BuildParams{
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700147 Rule: extractMatchingApks,
148 Description: "Extract APKs from APK set",
149 Output: as.packedOutput,
150 ImplicitOutput: as.apkcertsFile,
151 Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)},
Sasha Smundaka7856c02020-04-23 09:49:59 -0700152 Args: map[string]string{
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700153 "abis": strings.Join(SupportedAbis(ctx), ","),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700154 "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)),
155 "screen-densities": screenDensities,
156 "sdk-version": ctx.Config().PlatformSdkVersion(),
Sasha Smundake88b4362020-06-22 16:53:33 -0700157 "stem": as.BaseModuleName(),
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700158 "apkcerts": as.apkcertsFile.String(),
159 "partition": as.PartitionTag(ctx.DeviceConfig()),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700160 },
161 })
Sasha Smundaka7856c02020-04-23 09:49:59 -0700162}
163
164// android_app_set extracts a set of APKs based on the target device
165// configuration and installs this set as "split APKs".
Sasha Smundak613cbb12020-06-05 10:27:23 -0700166// The extracted set always contains 'master' APK whose name is
167// _module_name_.apk and every split APK matching target device.
168// The extraction of the density-specific splits depends on
169// PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should
170// be a list density names: LDPI, MDPI, HDPI, etc.), only listed
171// splits will be extracted. Otherwise all density-specific splits
172// will be extracted.
Sasha Smundaka7856c02020-04-23 09:49:59 -0700173func AndroidApkSetFactory() android.Module {
174 module := &AndroidAppSet{}
175 module.AddProperties(&module.properties)
176 InitJavaModule(module, android.DeviceSupported)
177 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
178 return module
Paul Duffinf9b1da02019-12-18 19:51:55 +0000179}
180
Colin Cross30e076a2015-04-13 13:58:27 -0700181// AndroidManifest.xml merging
182// package splits
183
Colin Crossfabb6082018-02-20 17:22:23 -0800184type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700185 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -0700186 Additional_certificates []string
187
188 // If set, create package-export.apk, which other packages can
189 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -0800190 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700191
Colin Cross16056062017-12-13 22:46:28 -0800192 // Specifies that this app should be installed to the priv-app directory,
193 // where the system will grant it additional privileges not available to
194 // normal apps.
195 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700196
197 // list of resource labels to generate individual resource packages
198 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -0400199
200 // Names of modules to be overridden. Listed modules can only be other binaries
201 // (in Make or Soong).
202 // This does not completely prevent installation of the overridden binaries, but if both
203 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
204 // from PRODUCT_PACKAGES.
205 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -0700206
207 // list of native libraries that will be provided in or alongside the resulting jar
208 Jni_libs []string `android:"arch_variant"`
209
Colin Cross7204cf02020-05-06 17:51:39 -0700210 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -0800211 // sdk_version.
212 Jni_uses_platform_apis *bool
213
Colin Cross7204cf02020-05-06 17:51:39 -0700214 // if true, use JNI libraries that link against SDK APIs even if this module does not set
215 // sdk_version.
216 Jni_uses_sdk_apis *bool
217
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700218 // STL library to use for JNI libraries.
219 Stl *string `android:"arch_variant"`
220
Colin Crosse4246ab2019-02-05 21:55:21 -0800221 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
222 // 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 +0900223 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
224 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
225 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -0800226 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -0800227
228 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
229 // they are used from inside the APK at runtime.
230 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700231
232 // Forces native libraries to always be packaged into the APK,
233 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
234 // True for android_test* modules.
235 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700236
237 // If set, find and merge all NOTICE files that this module and its dependencies have and store
238 // it in the APK as an asset.
239 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700240
241 // cc.Coverage related properties
242 PreventInstall bool `blueprint:"mutated"`
243 HideFromMake bool `blueprint:"mutated"`
244 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100245
246 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100247 // additional rules to make sure an app can safely be updated. Default is false.
248 // Prefer using other specific properties if build behaviour must be changed; avoid using this
249 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100250 Updatable *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700251}
252
Jaewoong Jung525443a2019-02-28 15:35:54 -0800253// android_app properties that can be overridden by override_android_app
254type overridableAppProperties struct {
255 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
256 // or an android_app_certificate module name in the form ":module".
257 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700258
Liz Kammere2b27f42020-05-07 13:24:05 -0700259 // Name of the signing certificate lineage file.
260 Lineage *string
261
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700262 // the package name of this app. The package name in the manifest file is used if one was not given.
263 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800264
265 // the logging parent of this app.
266 Logging_parent *string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800267}
268
Roshan Pius4df2bc72020-04-27 09:42:27 -0700269// runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay
270type OverridableRuntimeResourceOverlayProperties struct {
271 // the package name of this app. The package name in the manifest file is used if one was not given.
272 Package_name *string
273
274 // the target package name of this overlay app. The target package name in the manifest file is used if one was not given.
275 Target_package_name *string
276}
277
Colin Cross30e076a2015-04-13 13:58:27 -0700278type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700279 Library
280 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800281 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700282
Colin Cross50ddcc42019-05-16 12:28:22 -0700283 usesLibrary usesLibrary
284
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900285 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700286
Colin Crossfabb6082018-02-20 17:22:23 -0800287 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700288
Jaewoong Jung525443a2019-02-28 15:35:54 -0800289 overridableAppProperties overridableAppProperties
290
Colin Cross403cc152020-07-06 14:15:24 -0700291 jniLibs []jniLib
292 installPathForJNISymbols android.Path
293 embeddedJniLibs bool
294 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700295
296 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800297
298 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
299 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800300
Colin Cross70dda7e2019-10-01 22:05:35 -0700301 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700302
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700303 onDeviceDir string
304
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800305 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700306
307 noticeOutputs android.NoticeOutputs
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900308
309 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100310
311 android.ApexBundleDepsInfo
Colin Crosse1731a52017-12-14 11:22:55 -0800312}
313
Martin Stjernholm6d415272020-01-31 17:10:36 +0000314func (a *AndroidApp) IsInstallable() bool {
315 return Bool(a.properties.Installable)
316}
317
Colin Cross89c31582018-04-30 15:55:11 -0700318func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
319 return nil
320}
321
Colin Cross66f78822018-05-02 12:58:28 -0700322func (a *AndroidApp) ExportedStaticPackages() android.Paths {
323 return nil
324}
325
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900326func (a *AndroidApp) OutputFile() android.Path {
327 return a.outputFile
328}
329
Colin Cross503c1d02020-01-28 14:00:53 -0800330func (a *AndroidApp) Certificate() Certificate {
331 return a.certificate
332}
333
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700334func (a *AndroidApp) JniCoverageOutputs() android.Paths {
335 return a.jniCoverageOutputs
336}
337
Colin Crossa97c5d32018-03-28 14:58:31 -0700338var _ AndroidLibraryDependency = (*AndroidApp)(nil)
339
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900340type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800341 Pem, Key android.Path
342 presigned bool
343}
344
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700345var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800346
347func (c Certificate) AndroidMkString() string {
348 if c.presigned {
349 return "PRESIGNED"
350 } else {
351 return c.Pem.String()
352 }
Colin Cross30e076a2015-04-13 13:58:27 -0700353}
354
Colin Cross46c9b8b2017-06-22 16:51:17 -0700355func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
356 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700357
Jiyong Park6a927c42020-01-21 02:03:43 +0900358 if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700359 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
360 }
361
Paul Duffin250e6192019-06-07 10:44:37 +0100362 sdkDep := decodeSdkDep(ctx, sdkContext(a))
363 if sdkDep.hasFrameworkLibs() {
364 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700365 }
Colin Crossa4f08812018-10-02 22:03:40 -0700366
Colin Cross3c007702020-05-08 11:20:24 -0700367 usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform
368
369 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
370 ctx.PropertyErrorf("jni_uses_sdk_apis",
371 "can only be set for modules that do not set sdk_version")
372 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
373 ctx.PropertyErrorf("jni_uses_platform_apis",
374 "can only be set for modules that set sdk_version")
375 }
376
Peter Collingbournead84f972019-12-17 16:46:18 -0800377 tag := &jniDependencyTag{}
Colin Crossa4f08812018-10-02 22:03:40 -0700378 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700379 variation := append(jniTarget.Variations(),
380 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000381
382 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
383 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700384 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
385 // have stable APIs through the VNDK.
386 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
387 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700388 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000389 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
390 }
Colin Crossa4f08812018-10-02 22:03:40 -0700391 ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
392 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700393
Paul Duffin250e6192019-06-07 10:44:37 +0100394 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700395}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700396
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700397func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800398 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700399 if cert != "" {
400 ctx.AddDependency(ctx.Module(), certificateTag, cert)
401 }
402
403 for _, cert := range a.appProperties.Additional_certificates {
404 cert = android.SrcIsModule(cert)
405 if cert != "" {
406 ctx.AddDependency(ctx.Module(), certificateTag, cert)
407 } else {
408 ctx.PropertyErrorf("additional_certificates",
409 `must be names of android_app_certificate modules in the form ":module"`)
410 }
411 }
Colin Cross30e076a2015-04-13 13:58:27 -0700412}
413
Jeongik Cha538c0d02019-07-11 15:54:27 +0900414func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
415 a.generateAndroidBuildActions(ctx)
416}
417
Colin Cross46c9b8b2017-06-22 16:51:17 -0700418func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100419 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700420 a.generateAndroidBuildActions(ctx)
421}
422
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100423func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100424 if a.Updatable() {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100425 if !a.sdkVersion().stable() {
426 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion())
427 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100428 if String(a.deviceProperties.Min_sdk_version) == "" {
429 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
430 }
Jooyung Han749dc692020-04-15 11:03:39 +0900431
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900432 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
433 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +0900434 android.CheckMinSdkVersion(a, ctx, int(minSdkVersion))
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900435 } else {
436 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
437 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100438 }
439
440 a.checkPlatformAPI(ctx)
441 a.checkSdkVersions(ctx)
442}
443
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900444// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
445// This check is enforced for "updatable" APKs (including APK-in-APEX).
446// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
447// because, sdk_version is overridden by min_sdk_version (if set as smaller)
448// and linkType is checked with dependencies so we can be sure that the whole dependency tree
449// will meet the requirements.
450func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
451 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
452 ctx.VisitDirectDeps(func(m android.Module) {
453 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
454 return
455 }
456 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900457 // The domain of cc.sdk_version is "current" and <number>
458 // We can rely on sdkSpec to convert it to <number> so that "current" is handled
459 // properly regardless of sdk finalization.
460 jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx)
461 if err != nil || minSdkVersion < jniSdkVersion {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900462 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
463 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
464 return
465 }
466
467 })
468}
469
Sasha Smundak6ad77252019-05-01 13:16:22 -0700470// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800471// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700472func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900473 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800474 if err != nil {
475 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
476 }
477
Jiyong Park52cd06f2019-11-11 10:14:32 +0900478 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
479 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800480}
481
Colin Cross43f08db2018-11-12 10:13:39 -0800482// Returns whether this module should have the dex file stored uncompressed in the APK.
483func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800484 if Bool(a.appProperties.Use_embedded_dex) {
485 return true
486 }
487
Colin Cross53a87f52019-06-25 13:35:30 -0700488 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
489 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900490 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000491 return true
492 }
493
Colin Cross53a87f52019-06-25 13:35:30 -0700494 if ctx.Config().UnbundledBuild() {
495 return false
496 }
497
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700498 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700499}
500
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700501func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
502 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900503 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700504}
505
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900506func (a *AndroidApp) OverriddenManifestPackageName() string {
507 return a.overriddenManifestPackageName
508}
509
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800510func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000511 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
512
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700513 // Ask manifest_fixer to add or update the application element indicating this app has no code.
514 a.aapt.hasNoCode = !a.hasCode(ctx)
515
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800516 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800517
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800518 // 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 -0800519 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700520 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800521 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700522 }
523
Dan Willemsen72be5902018-10-24 20:24:57 -0700524 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
525 // Product AAPT config
526 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800527 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700528 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700529
Dan Willemsen72be5902018-10-24 20:24:57 -0700530 // Product AAPT preferred config
531 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800532 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700533 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700534 }
535
Jiyong Park7f67f482019-01-05 12:57:48 +0900536 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700537 if overridden || a.overridableAppProperties.Package_name != nil {
538 // The product override variable has a priority over the package_name property.
539 if !overridden {
540 manifestPackageName = *a.overridableAppProperties.Package_name
541 }
Liz Kammer1d5983b2020-05-19 19:15:37 +0000542 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900543 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900544 }
545
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800546 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
547
Colin Crosse560c4a2019-03-19 16:03:11 -0700548 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700549 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800550 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800551 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700552
Colin Cross46c9b8b2017-06-22 16:51:17 -0700553 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700554 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800555}
Colin Cross30e076a2015-04-13 13:58:27 -0700556
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800557func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700558 var staticLibProguardFlagFiles android.Paths
559 ctx.VisitDirectDeps(func(m android.Module) {
560 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
561 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
562 }
563 })
564
565 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
566
567 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
568 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800569}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800570
Colin Cross403cc152020-07-06 14:15:24 -0700571func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
Colin Cross43f08db2018-11-12 10:13:39 -0800572 var installDir string
573 if ctx.ModuleName() == "framework-res" {
574 // framework-res.apk is installed as system/framework/framework-res.apk
575 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900576 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800577 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800578 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800579 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800580 }
Colin Cross403cc152020-07-06 14:15:24 -0700581
582 return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
583}
584
585func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
586 a.dexpreopter.installPath = a.installPath(ctx)
David Srbeckye033cba2020-05-20 22:20:28 +0100587 if a.deviceProperties.Uncompress_dex == nil {
588 // If the value was not force-set by the user, use reasonable default based on the module.
589 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
590 }
591 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700592 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
593 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
594 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
595 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
596 a.dexpreopter.manifestFile = a.mergedManifestFile
597
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800598 if ctx.ModuleName() != "framework-res" {
599 a.Module.compile(ctx, a.aaptSrcJar)
600 }
Colin Cross30e076a2015-04-13 13:58:27 -0700601
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800602 return a.maybeStrippedDexJarFile
603}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800604
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800605func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700606 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700607 if len(jniLibs) > 0 {
Colin Cross403cc152020-07-06 14:15:24 -0700608 a.jniLibs = jniLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700609 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700610 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Colin Cross403cc152020-07-06 14:15:24 -0700611 a.installPathForJNISymbols = a.installPath(ctx).ToMakePath()
Sasha Smundak6ad77252019-05-01 13:16:22 -0700612 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700613 for _, jni := range jniLibs {
614 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700615 // Only collect coverage for the first target arch if this is a multilib target.
616 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
617 // data file path collisions since the current coverage file path format doesn't contain
618 // arch-related strings. This is fine for now though; the code coverage team doesn't use
619 // multi-arch targets such as test_suite_* for coverage collections yet.
620 //
621 // Work with the team to come up with a new format that handles multilib modules properly
622 // and change this.
623 if len(ctx.Config().Targets[android.Android]) == 1 ||
624 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
625 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
626 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700627 }
628 }
Colin Cross403cc152020-07-06 14:15:24 -0700629 a.embeddedJniLibs = true
Colin Crossa4f08812018-10-02 22:03:40 -0700630 }
631 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800632 return jniJarFile
633}
Colin Crossa4f08812018-10-02 22:03:40 -0700634
Colin Cross403cc152020-07-06 14:15:24 -0700635func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
636 var jniSymbols android.RuleBuilderInstalls
637 for _, jniLib := range a.jniLibs {
638 if jniLib.unstrippedFile != nil {
639 jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
640 From: jniLib.unstrippedFile,
641 To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
642 })
643 }
644 }
645 return jniSymbols
646}
647
Jaewoong Jung0949f312019-09-11 10:25:18 -0700648func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700649 // Collect NOTICE files from all dependencies.
650 seenModules := make(map[android.Module]bool)
651 noticePathSet := make(map[android.Path]bool)
652
653 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
654 // Have we already seen this?
655 if _, ok := seenModules[child]; ok {
656 return false
657 }
658 seenModules[child] = true
659
660 // Skip host modules.
661 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
662 return false
663 }
664
Bob Badoura75b0572020-02-18 20:21:55 -0800665 paths := child.(android.Module).NoticeFiles()
666 if len(paths) > 0 {
667 for _, path := range paths {
668 noticePathSet[path] = true
669 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700670 }
671 return true
672 })
673
674 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800675 if len(a.NoticeFiles()) > 0 {
676 for _, path := range a.NoticeFiles() {
677 noticePathSet[path] = true
678 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700679 }
680
681 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700682 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700683 }
684 var noticePaths []android.Path
685 for path := range noticePathSet {
686 noticePaths = append(noticePaths, path)
687 }
688 sort.Slice(noticePaths, func(i, j int) bool {
689 return noticePaths[i].String() < noticePaths[j].String()
690 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700691
Jaewoong Jung0949f312019-09-11 10:25:18 -0700692 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700693}
694
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700695// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
696// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
697func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
698 if android.SrcIsModule(certPropValue) == "" {
699 var mainCert Certificate
700 if certPropValue != "" {
701 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
702 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800703 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
704 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700705 }
706 } else {
707 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800708 mainCert = Certificate{
709 Pem: pem,
710 Key: key,
711 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700712 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700713 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700714 }
715
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700716 if !m.Platform() {
717 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900718 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
719 if strings.HasPrefix(certPath, systemCertPath) {
720 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
Colin Cross440e0d02020-06-11 11:32:11 -0700721 allowed := ctx.Config().EnforceSystemCertificateAllowList()
Jeongik Chac9464142019-01-07 12:07:27 +0900722
Colin Cross440e0d02020-06-11 11:32:11 -0700723 if enforceSystemCert && !inList(m.Name(), allowed) {
Jeongik Chac9464142019-01-07 12:07:27 +0900724 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
725 }
726 }
727 }
728
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700729 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800730}
731
Jooyung Han39ee1192020-03-23 20:21:11 +0900732func (a *AndroidApp) InstallApkName() string {
733 return a.installApkName
734}
735
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800736func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700737 var apkDeps android.Paths
738
Jeongik Cha538c0d02019-07-11 15:54:27 +0900739 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
740 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
741
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800742 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800743 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800744
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700745 if ctx.ModuleName() == "framework-res" {
746 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700747 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900748 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700749 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
750 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800751 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700752 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700753 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700754 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700755 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700756
Jaewoong Jung0949f312019-09-11 10:25:18 -0700757 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700758 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
759 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
760 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700761
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800762 // Process all building blocks, from AAPT to certificates.
763 a.aaptBuildActions(ctx)
764
Colin Cross50ddcc42019-05-16 12:28:22 -0700765 if a.usesLibrary.enforceUsesLibraries() {
766 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
767 apkDeps = append(apkDeps, manifestCheckFile)
768 }
769
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800770 a.proguardBuildActions(ctx)
771
Colin Cross014489c2020-06-02 20:09:13 -0700772 a.linter.mergedManifest = a.aapt.mergedManifestFile
773 a.linter.manifest = a.aapt.manifestPath
774 a.linter.resources = a.aapt.resourceFiles
775
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800776 dexJarFile := a.dexBuildActions(ctx)
777
Colin Crossc2d24052020-05-13 11:05:02 -0700778 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800779 jniJarFile := a.jniBuildActions(jniLibs, ctx)
780
781 if ctx.Failed() {
782 return
783 }
784
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700785 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
786 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800787
788 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800789 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700790 var lineageFile android.Path
791 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
792 lineageFile = android.PathForModuleSrc(ctx, lineage)
793 }
794 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800795 a.outputFile = packageFile
796
Colin Crosse560c4a2019-03-19 16:03:11 -0700797 for _, split := range a.aapt.splits {
798 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800799 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700800 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700801 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
802 }
803
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800804 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700805 bundleFile := android.PathForModuleOut(ctx, "base.zip")
806 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
807 a.bundleFile = bundleFile
808
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800809 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900810 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
811 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
812 for _, extra := range a.extraOutputFiles {
813 ctx.InstallFile(a.installDir, extra.Base(), extra)
814 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800815 }
Artur Satayev1111b842020-04-27 19:05:28 +0100816
817 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700818}
819
Colin Crossc2d24052020-05-13 11:05:02 -0700820type appDepsInterface interface {
821 sdkVersion() sdkSpec
822 minSdkVersion() sdkSpec
823 RequiresStableAPIs(ctx android.BaseModuleContext) bool
824}
825
826func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
827 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800828 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700829
Colin Crossa4f08812018-10-02 22:03:40 -0700830 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900831 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800832 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700833
Colin Crossc2d24052020-05-13 11:05:02 -0700834 if checkNativeSdkVersion {
835 checkNativeSdkVersion = app.sdkVersion().specified() &&
836 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
837 }
838
Peter Collingbournead84f972019-12-17 16:46:18 -0800839 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700840 otherName := ctx.OtherModuleName(module)
841 tag := ctx.OtherModuleDependencyTag(module)
842
Peter Collingbournead84f972019-12-17 16:46:18 -0800843 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700844 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800845 if dep.IsNdk() || dep.IsStubs() {
846 return false
847 }
848
Colin Crossa4f08812018-10-02 22:03:40 -0700849 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800850 path := lib.Path()
851 if seenModulePaths[path.String()] {
852 return false
853 }
854 seenModulePaths[path.String()] = true
855
Colin Crossc2d24052020-05-13 11:05:02 -0700856 if checkNativeSdkVersion && dep.SdkVersion() == "" {
857 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
858 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800859 }
860
Colin Crossa4f08812018-10-02 22:03:40 -0700861 if lib.Valid() {
862 jniLibs = append(jniLibs, jniLib{
Colin Cross403cc152020-07-06 14:15:24 -0700863 name: ctx.OtherModuleName(module),
864 path: path,
865 target: module.Target(),
866 coverageFile: dep.CoverageOutputFile(),
867 unstrippedFile: dep.UnstrippedOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700868 })
869 } else {
870 ctx.ModuleErrorf("dependency %q missing output file", otherName)
871 }
872 } else {
873 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700874 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800875
876 return shouldCollectRecursiveNativeDeps
877 }
878
879 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700880 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900881 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700882 } else {
883 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
884 }
Colin Crossa4f08812018-10-02 22:03:40 -0700885 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800886
887 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700888 })
889
Colin Crossbd01e2a2018-10-04 15:21:03 -0700890 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700891}
892
Jooyung Han749dc692020-04-15 11:03:39 +0900893func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +0100894 ctx.WalkDeps(func(child, parent android.Module) bool {
895 isExternal := !a.DepIsInSameApex(ctx, child)
896 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +0900897 if !do(ctx, parent, am, isExternal) {
898 return false
899 }
Artur Satayev1111b842020-04-27 19:05:28 +0100900 }
901 return !isExternal
902 })
903}
904
905func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
906 if ctx.Host() {
907 return
908 }
909
910 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +0900911 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +0100912 depName := to.Name()
913 if info, exist := depsInfo[depName]; exist {
914 info.From = append(info.From, from.Name())
915 info.IsExternal = info.IsExternal && externalDep
916 depsInfo[depName] = info
917 } else {
918 toMinSdkVersion := "(no version)"
919 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
920 if v := m.MinSdkVersion(); v != "" {
921 toMinSdkVersion = v
922 }
923 }
924 depsInfo[depName] = android.ApexModuleDepInfo{
925 To: depName,
926 From: []string{from.Name()},
927 IsExternal: externalDep,
928 MinSdkVersion: toMinSdkVersion,
929 }
930 }
Jooyung Han749dc692020-04-15 11:03:39 +0900931 return true
Artur Satayev1111b842020-04-27 19:05:28 +0100932 })
933
934 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
935}
936
Artur Satayev849f8442020-04-28 14:57:42 +0100937func (a *AndroidApp) Updatable() bool {
938 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
939}
940
Colin Cross0ea8ba82019-06-06 14:33:29 -0700941func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800942 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
943 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000944 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800945 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800946 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800947}
948
Jiyong Park0f80c182020-01-31 02:49:53 +0900949func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
950 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
951 return true
952 }
953 return a.Library.DepIsInSameApex(ctx, dep)
954}
955
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900956// For OutputFileProducer interface
957func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
958 switch tag {
959 case ".aapt.srcjar":
960 return []android.Path{a.aaptSrcJar}, nil
961 }
962 return a.Library.OutputFiles(tag)
963}
964
Jiyong Parkf7487312019-10-17 12:54:30 +0900965func (a *AndroidApp) Privileged() bool {
966 return Bool(a.appProperties.Privileged)
967}
968
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700969func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -0700970 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700971}
972
973func (a *AndroidApp) PreventInstall() {
974 a.appProperties.PreventInstall = true
975}
976
977func (a *AndroidApp) HideFromMake() {
978 a.appProperties.HideFromMake = true
979}
980
981func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
982 a.appProperties.IsCoverageVariant = coverage
983}
984
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400985func (a *AndroidApp) EnableCoverageIfNeeded() {}
986
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700987var _ cc.Coverage = (*AndroidApp)(nil)
988
Colin Cross1b16b0e2019-02-12 14:41:32 -0800989// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700990func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700991 module := &AndroidApp{}
992
Sasha Smundak2057f822019-04-16 17:16:58 -0700993 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800994 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
995
Colin Crossae5caf52018-05-22 11:11:52 -0700996 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700997 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700998
Colin Crossce6734e2020-06-15 16:09:53 -0700999 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -07001000 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -07001001 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001002 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001003 &module.overridableAppProperties,
1004 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001005
Colin Crossa4f08812018-10-02 22:03:40 -07001006 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1007 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001008 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001009 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001010
Colin Cross36242852017-06-23 15:06:31 -07001011 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001012}
Colin Crossae5caf52018-05-22 11:11:52 -07001013
1014type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001015 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001016 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001017
1018 // if specified, the instrumentation target package name in the manifest is overwritten by it.
1019 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -07001020}
1021
1022type AndroidTest struct {
1023 AndroidApp
1024
1025 appTestProperties appTestProperties
1026
1027 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001028
1029 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001030 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001031}
1032
Jaewoong Jung0949f312019-09-11 10:25:18 -07001033func (a *AndroidTest) InstallInTestcases() bool {
1034 return true
1035}
1036
Colin Crossae5caf52018-05-22 11:11:52 -07001037func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001038 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001039 if a.appTestProperties.Instrumentation_target_package != nil {
1040 a.additionalAaptFlags = append(a.additionalAaptFlags,
1041 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1042 } else if a.appTestProperties.Instrumentation_for != nil {
1043 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001044 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1045 if overridden {
1046 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1047 }
1048 }
Colin Crossae5caf52018-05-22 11:11:52 -07001049 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001050
easoncylee5bcff5d2020-04-30 14:57:06 +08001051 for _, module := range a.testProperties.Test_mainline_modules {
1052 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1053 }
1054
Jaewoong Jung39982342020-01-14 10:27:18 -08001055 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001056 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001057 a.testConfig = a.FixTestConfig(ctx, testConfig)
Colin Cross8a497952019-03-05 22:25:09 -08001058 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001059}
1060
Jaewoong Jung39982342020-01-14 10:27:18 -08001061func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1062 if testConfig == nil {
1063 return nil
1064 }
1065
1066 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
1067 rule := android.NewRuleBuilder()
1068 command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig)
1069 fixNeeded := false
1070
1071 if ctx.ModuleName() != a.installApkName {
1072 fixNeeded = true
1073 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1074 }
1075
1076 if a.overridableAppProperties.Package_name != nil {
1077 fixNeeded = true
1078 command.FlagWithInput("--manifest ", a.manifestPath).
1079 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1080 }
1081
1082 if fixNeeded {
1083 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
1084 return fixedConfig
1085 }
1086 return testConfig
1087}
1088
Colin Cross303e21f2018-08-07 16:49:25 -07001089func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001090 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001091}
1092
1093func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1094 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001095 if a.appTestProperties.Instrumentation_for != nil {
1096 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1097 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1098 // use instrumentationForTag instead of libTag.
1099 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1100 }
Colin Crossae5caf52018-05-22 11:11:52 -07001101}
1102
Colin Cross1b16b0e2019-02-12 14:41:32 -08001103// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1104// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001105func AndroidTestFactory() android.Module {
1106 module := &AndroidTest{}
1107
Sasha Smundak2057f822019-04-16 17:16:58 -07001108 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -07001109
1110 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001111 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001112 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001113 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001114 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001115 module.Module.linter.test = true
Colin Crossae5caf52018-05-22 11:11:52 -07001116
Colin Crossce6734e2020-06-15 16:09:53 -07001117 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001118 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001119 &module.aaptProperties,
1120 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001121 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001122 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001123 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001124 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001125
Colin Crossa4f08812018-10-02 22:03:40 -07001126 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1127 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001128 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001129 return module
1130}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001131
Colin Cross252fc6f2018-10-04 15:22:03 -07001132type appTestHelperAppProperties struct {
1133 // list of compatibility suites (for example "cts", "vts") that the module should be
1134 // installed into.
1135 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001136
1137 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1138 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1139 // explicitly.
1140 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001141}
1142
1143type AndroidTestHelperApp struct {
1144 AndroidApp
1145
1146 appTestHelperAppProperties appTestHelperAppProperties
1147}
1148
Jaewoong Jung326a9412019-11-21 10:41:00 -08001149func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1150 return true
1151}
1152
Colin Cross1b16b0e2019-02-12 14:41:32 -08001153// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1154// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1155// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001156func AndroidTestHelperAppFactory() android.Module {
1157 module := &AndroidTestHelperApp{}
1158
Sasha Smundak2057f822019-04-16 17:16:58 -07001159 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001160
1161 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001162 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001163 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001164 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001165 module.Module.linter.test = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001166
Colin Crossce6734e2020-06-15 16:09:53 -07001167 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001168 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001169 &module.aaptProperties,
1170 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001171 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001172 &module.overridableAppProperties,
1173 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001174
1175 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1176 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001177 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001178 return module
1179}
1180
Colin Crossbd01e2a2018-10-04 15:21:03 -07001181type AndroidAppCertificate struct {
1182 android.ModuleBase
1183 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001184 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001185}
1186
1187type AndroidAppCertificateProperties struct {
1188 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1189 Certificate *string
1190}
1191
Colin Cross1b16b0e2019-02-12 14:41:32 -08001192// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1193// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001194func AndroidAppCertificateFactory() android.Module {
1195 module := &AndroidAppCertificate{}
1196 module.AddProperties(&module.properties)
1197 android.InitAndroidModule(module)
1198 return module
1199}
1200
Colin Crossbd01e2a2018-10-04 15:21:03 -07001201func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1202 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001203 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001204 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1205 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001206 }
1207}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001208
1209type OverrideAndroidApp struct {
1210 android.ModuleBase
1211 android.OverrideModuleBase
1212}
1213
Sasha Smundak613cbb12020-06-05 10:27:23 -07001214func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001215 // All the overrides happen in the base module.
1216 // TODO(jungjw): Check the base module type.
1217}
1218
1219// override_android_app is used to create an android_app module based on another android_app by overriding
1220// some of its properties.
1221func OverrideAndroidAppModuleFactory() android.Module {
1222 m := &OverrideAndroidApp{}
1223 m.AddProperties(&overridableAppProperties{})
1224
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001225 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001226 android.InitOverrideModule(m)
1227 return m
1228}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001229
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001230type OverrideAndroidTest struct {
1231 android.ModuleBase
1232 android.OverrideModuleBase
1233}
1234
Sasha Smundak613cbb12020-06-05 10:27:23 -07001235func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001236 // All the overrides happen in the base module.
1237 // TODO(jungjw): Check the base module type.
1238}
1239
1240// override_android_test is used to create an android_app module based on another android_test by overriding
1241// some of its properties.
1242func OverrideAndroidTestModuleFactory() android.Module {
1243 m := &OverrideAndroidTest{}
1244 m.AddProperties(&overridableAppProperties{})
1245 m.AddProperties(&appTestProperties{})
1246
1247 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1248 android.InitOverrideModule(m)
1249 return m
1250}
1251
Roshan Pius4df2bc72020-04-27 09:42:27 -07001252type OverrideRuntimeResourceOverlay struct {
1253 android.ModuleBase
1254 android.OverrideModuleBase
1255}
1256
Sasha Smundak613cbb12020-06-05 10:27:23 -07001257func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) {
Roshan Pius4df2bc72020-04-27 09:42:27 -07001258 // All the overrides happen in the base module.
1259 // TODO(jungjw): Check the base module type.
1260}
1261
1262// override_runtime_resource_overlay is used to create a module based on another
1263// runtime_resource_overlay module by overriding some of its properties.
1264func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1265 m := &OverrideRuntimeResourceOverlay{}
1266 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1267
1268 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1269 android.InitOverrideModule(m)
1270 return m
1271}
1272
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001273type AndroidAppImport struct {
1274 android.ModuleBase
1275 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001276 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001277 prebuilt android.Prebuilt
1278
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001279 properties AndroidAppImportProperties
1280 dpiVariants interface{}
1281 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001282
1283 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001284 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001285
1286 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001287
1288 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001289
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001290 preprocessed bool
1291
Colin Cross70dda7e2019-10-01 22:05:35 -07001292 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001293}
1294
1295type AndroidAppImportProperties struct {
1296 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001297 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001298
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001299 // The name of a certificate in the default certificate directory or an android_app_certificate
1300 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001301 Certificate *string
1302
1303 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1304 // be set for presigned modules.
1305 Presigned *bool
1306
Liz Kammer24978992020-05-13 15:49:21 -07001307 // Name of the signing certificate lineage file.
1308 Lineage *string
1309
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001310 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1311 // need to either specify a specific certificate or be presigned.
1312 Default_dev_cert *bool
1313
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001314 // Specifies that this app should be installed to the priv-app directory,
1315 // where the system will grant it additional privileges not available to
1316 // normal apps.
1317 Privileged *bool
1318
1319 // Names of modules to be overridden. Listed modules can only be other binaries
1320 // (in Make or Soong).
1321 // This does not completely prevent installation of the overridden binaries, but if both
1322 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1323 // from PRODUCT_PACKAGES.
1324 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001325
1326 // Optional name for the installed app. If unspecified, it is derived from the module name.
1327 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001328}
1329
Martin Stjernholm6d415272020-01-31 17:10:36 +00001330func (a *AndroidAppImport) IsInstallable() bool {
1331 return true
1332}
1333
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001334// Updates properties with variant-specific values.
1335func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001336 config := ctx.Config()
1337
1338 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1339 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1340 // overwrites everything else.
1341 // TODO(jungjw): Can we optimize this by making it priority order?
1342 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001343 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001344 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001345 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001346 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001347 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001348
1349 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1350 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1351 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001352}
1353
Colin Cross1184b642019-12-30 18:43:07 -08001354func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001355 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001356 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1357 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001358 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001359 }
1360
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001361 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1362 if err != nil {
1363 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1364 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1365 } else {
1366 panic(err)
1367 }
1368 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001369}
1370
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001371func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1372 cert := android.SrcIsModule(String(a.properties.Certificate))
1373 if cert != "" {
1374 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1375 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001376
Paul Duffin250e6192019-06-07 10:44:37 +01001377 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001378}
1379
1380func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1381 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001382 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1383 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001384 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001385 ctx.Build(pctx, android.BuildParams{
1386 Rule: android.Cp,
1387 Output: outputPath,
1388 Input: inputPath,
1389 })
1390 return
1391 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001392 rule := android.NewRuleBuilder()
1393 rule.Command().
1394 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001395 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001396 FlagWithInput("-i ", inputPath).
1397 FlagWithOutput("-o ", outputPath).
1398 FlagWithArg("-0 ", "'lib/**/*.so'").
1399 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1400 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1401}
1402
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001403// Returns whether this module should have the dex file stored uncompressed in the APK.
1404func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001405 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001406 return false
1407 }
1408
1409 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001410 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001411 return true
1412 }
1413
1414 return shouldUncompressDex(ctx, &a.dexpreopter)
1415}
1416
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001417func (a *AndroidAppImport) uncompressDex(
1418 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1419 rule := android.NewRuleBuilder()
1420 rule.Command().
1421 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001422 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001423 FlagWithInput("-i ", inputPath).
1424 FlagWithOutput("-o ", outputPath).
1425 FlagWithArg("-0 ", "'classes*.dex'").
1426 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1427 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1428}
1429
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001430func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001431 a.generateAndroidBuildActions(ctx)
1432}
1433
Jooyung Han39ee1192020-03-23 20:21:11 +09001434func (a *AndroidAppImport) InstallApkName() string {
1435 return a.BaseModuleName()
1436}
1437
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001438func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001439 numCertPropsSet := 0
1440 if String(a.properties.Certificate) != "" {
1441 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001442 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001443 if Bool(a.properties.Presigned) {
1444 numCertPropsSet++
1445 }
1446 if Bool(a.properties.Default_dev_cert) {
1447 numCertPropsSet++
1448 }
1449 if numCertPropsSet != 1 {
1450 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001451 }
1452
Colin Crossc2d24052020-05-13 11:05:02 -07001453 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001454
1455 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001456 // TODO: LOCAL_PACKAGE_SPLITS
1457
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001458 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001459
1460 if a.usesLibrary.enforceUsesLibraries() {
1461 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1462 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001463
1464 // TODO: Install or embed JNI libraries
1465
1466 // Uncompress JNI libraries in the apk
1467 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1468 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1469
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001470 var installDir android.InstallPath
1471 if Bool(a.properties.Privileged) {
1472 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001473 } else if ctx.InstallInTestcases() {
1474 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001475 } else {
1476 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1477 }
1478
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001479 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001480 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001481 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001482
1483 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1484 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1485 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1486 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1487
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001488 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001489 if a.dexpreopter.uncompressedDex {
1490 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1491 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1492 dexOutput = dexUncompressed
1493 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001494
Jooyung Han39ee1192020-03-23 20:21:11 +09001495 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1496
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001497 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001498
1499 // Sign or align the package if package has not been preprocessed
1500 if a.preprocessed {
1501 a.outputFile = srcApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001502 a.certificate = PresignedCertificate
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001503 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001504 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1505 // Which makes processMainCert's behavior for the empty cert string WAI.
1506 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001507 if len(certificates) != 1 {
1508 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1509 }
Colin Cross503c1d02020-01-28 14:00:53 -08001510 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001511 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer24978992020-05-13 15:49:21 -07001512 var lineageFile android.Path
1513 if lineage := String(a.properties.Lineage); lineage != "" {
1514 lineageFile = android.PathForModuleSrc(ctx, lineage)
1515 }
1516 SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001517 a.outputFile = signed
1518 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001519 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001520 TransformZipAlign(ctx, alignedApk, dexOutput)
1521 a.outputFile = alignedApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001522 a.certificate = PresignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001523 }
1524
1525 // TODO: Optionally compress the output apk.
1526
Jiyong Park592a6a42020-04-21 22:34:28 +09001527 if a.IsForPlatform() {
1528 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1529 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001530
1531 // TODO: androidmk converter jni libs
1532}
1533
1534func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1535 return &a.prebuilt
1536}
1537
1538func (a *AndroidAppImport) Name() string {
1539 return a.prebuilt.Name(a.ModuleBase.Name())
1540}
1541
Dario Frenicde2a032019-10-27 00:29:22 +01001542func (a *AndroidAppImport) OutputFile() android.Path {
1543 return a.outputFile
1544}
1545
Jiyong Park618922e2020-01-08 13:35:43 +09001546func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1547 return nil
1548}
1549
Colin Cross503c1d02020-01-28 14:00:53 -08001550func (a *AndroidAppImport) Certificate() Certificate {
1551 return a.certificate
1552}
1553
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001554var dpiVariantGroupType reflect.Type
1555var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001556
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001557func initAndroidAppImportVariantGroupTypes() {
1558 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1559
1560 archNames := make([]string, len(android.ArchTypeList()))
1561 for i, archType := range android.ArchTypeList() {
1562 archNames[i] = archType.Name
1563 }
1564 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1565}
1566
1567// Populates all variant struct properties at creation time.
1568func (a *AndroidAppImport) populateAllVariantStructs() {
1569 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1570 a.AddProperties(a.dpiVariants)
1571
1572 a.archVariants = reflect.New(archVariantGroupType).Interface()
1573 a.AddProperties(a.archVariants)
1574}
1575
Jiyong Parkf7487312019-10-17 12:54:30 +09001576func (a *AndroidAppImport) Privileged() bool {
1577 return Bool(a.properties.Privileged)
1578}
1579
Sasha Smundak613cbb12020-06-05 10:27:23 -07001580func (a *AndroidAppImport) DepIsInSameApex(_ android.BaseModuleContext, _ android.Module) bool {
Jiyong Park592a6a42020-04-21 22:34:28 +09001581 // android_app_import might have extra dependencies via uses_libs property.
1582 // Don't track the dependency as we don't automatically add those libraries
1583 // to the classpath. It should be explicitly added to java_libs property of APEX
1584 return false
1585}
1586
Colin Crossc2d24052020-05-13 11:05:02 -07001587func (a *AndroidAppImport) sdkVersion() sdkSpec {
1588 return sdkSpecFrom("")
1589}
1590
1591func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1592 return sdkSpecFrom("")
1593}
1594
Jooyung Han749dc692020-04-15 11:03:39 +09001595func (j *AndroidAppImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion int) error {
1596 // Do not check for prebuilts against the min_sdk_version of enclosing APEX
1597 return nil
1598}
1599
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001600func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1601 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1602
1603 variantFields := make([]reflect.StructField, len(variants))
1604 for i, variant := range variants {
1605 variantFields[i] = reflect.StructField{
1606 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001607 Type: props,
1608 }
1609 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001610
1611 variantGroupStruct := reflect.StructOf(variantFields)
1612 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001613 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001614 Name: variantGroupName,
1615 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001616 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001617 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001618}
1619
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001620// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001621// DPI-specific apk source files can be specified using dpi_variants. Example:
1622//
1623// android_app_import {
1624// name: "example_import",
1625// apk: "prebuilts/example.apk",
1626// dpi_variants: {
1627// mdpi: {
1628// apk: "prebuilts/example_mdpi.apk",
1629// },
1630// xhdpi: {
1631// apk: "prebuilts/example_xhdpi.apk",
1632// },
1633// },
1634// certificate: "PRESIGNED",
1635// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001636func AndroidAppImportFactory() android.Module {
1637 module := &AndroidAppImport{}
1638 module.AddProperties(&module.properties)
1639 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001640 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001641 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001642 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001643 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001644 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001645
Jiyong Park592a6a42020-04-21 22:34:28 +09001646 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001647 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1648 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001649 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001650
1651 return module
1652}
Colin Cross50ddcc42019-05-16 12:28:22 -07001653
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001654type androidTestImportProperties struct {
1655 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1656 Preprocessed *bool
1657}
1658
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001659type AndroidTestImport struct {
1660 AndroidAppImport
1661
1662 testProperties testProperties
1663
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001664 testImportProperties androidTestImportProperties
1665
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001666 data android.Paths
1667}
1668
1669func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001670 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1671
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001672 a.generateAndroidBuildActions(ctx)
1673
1674 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1675}
1676
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001677func (a *AndroidTestImport) InstallInTestcases() bool {
1678 return true
1679}
1680
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001681// android_test_import imports a prebuilt test apk with additional processing specified in the
1682// module. DPI or arch variant configurations can be made as with android_app_import.
1683func AndroidTestImportFactory() android.Module {
1684 module := &AndroidTestImport{}
1685 module.AddProperties(&module.properties)
1686 module.AddProperties(&module.dexpreoptProperties)
1687 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1688 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001689 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001690 module.populateAllVariantStructs()
1691 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1692 module.processVariants(ctx)
1693 })
1694
Colin Crossc80828d2020-05-06 22:29:10 -07001695 module.dexpreopter.isTest = true
1696
Jiyong Park592a6a42020-04-21 22:34:28 +09001697 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001698 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1699 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001700 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1701
1702 return module
1703}
1704
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001705type RuntimeResourceOverlay struct {
1706 android.ModuleBase
1707 android.DefaultableModuleBase
Roshan Pius4df2bc72020-04-27 09:42:27 -07001708 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001709 aapt
1710
Roshan Pius4df2bc72020-04-27 09:42:27 -07001711 properties RuntimeResourceOverlayProperties
1712 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001713
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001714 certificate Certificate
1715
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001716 outputFile android.Path
1717 installDir android.InstallPath
1718}
1719
1720type RuntimeResourceOverlayProperties struct {
1721 // the name of a certificate in the default certificate directory or an android_app_certificate
1722 // module name in the form ":module".
1723 Certificate *string
1724
Liz Kammer966b2f02020-05-19 16:15:25 -07001725 // Name of the signing certificate lineage file.
1726 Lineage *string
1727
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001728 // optional theme name. If specified, the overlay package will be applied
1729 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1730 Theme *string
1731
1732 // if not blank, set to the version of the sdk to compile against.
1733 // Defaults to compiling against the current platform.
1734 Sdk_version *string
1735
1736 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1737 // Defaults to sdk_version if not set.
1738 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001739
1740 // list of android_library modules whose resources are extracted and linked against statically
1741 Static_libs []string
1742
1743 // list of android_app modules whose resources are extracted and linked against
1744 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001745
1746 // Names of modules to be overridden. Listed modules can only be other overlays
1747 // (in Make or Soong).
1748 // This does not completely prevent installation of the overridden overlays, but if both
1749 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1750 // from PRODUCT_PACKAGES.
1751 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001752}
1753
Jiyong Park69aeba92020-04-24 21:16:36 +09001754// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1755// a RuntimeResourceOverlay module.
1756type RuntimeResourceOverlayModule interface {
1757 android.Module
1758 OutputFile() android.Path
1759 Certificate() Certificate
1760 Theme() string
1761}
1762
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001763func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1764 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1765 if sdkDep.hasFrameworkLibs() {
1766 r.aapt.deps(ctx, sdkDep)
1767 }
1768
1769 cert := android.SrcIsModule(String(r.properties.Certificate))
1770 if cert != "" {
1771 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1772 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001773
1774 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1775 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001776}
1777
1778func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1779 // Compile and link resources
1780 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001781 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Pius4df2bc72020-04-27 09:42:27 -07001782 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1783 // Allow the override of "package name" and "overlay target package name"
1784 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1785 if overridden || r.overridableProperties.Package_name != nil {
1786 // The product override variable has a priority over the package_name property.
1787 if !overridden {
1788 manifestPackageName = *r.overridableProperties.Package_name
1789 }
1790 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1791 }
1792 if r.overridableProperties.Target_package_name != nil {
1793 aaptLinkFlags = append(aaptLinkFlags,
1794 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1795 }
1796 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001797
1798 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001799 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001800 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1801 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer966b2f02020-05-19 16:15:25 -07001802 var lineageFile android.Path
1803 if lineage := String(r.properties.Lineage); lineage != "" {
1804 lineageFile = android.PathForModuleSrc(ctx, lineage)
1805 }
1806 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001807 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001808
1809 r.outputFile = signed
1810 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1811 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1812}
1813
Jiyong Park6a927c42020-01-21 02:03:43 +09001814func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1815 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001816}
1817
1818func (r *RuntimeResourceOverlay) systemModules() string {
1819 return ""
1820}
1821
Jiyong Park6a927c42020-01-21 02:03:43 +09001822func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001823 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001824 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001825 }
1826 return r.sdkVersion()
1827}
1828
Jiyong Park6a927c42020-01-21 02:03:43 +09001829func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001830 return r.sdkVersion()
1831}
1832
Jiyong Park69aeba92020-04-24 21:16:36 +09001833func (r *RuntimeResourceOverlay) Certificate() Certificate {
1834 return r.certificate
1835}
1836
1837func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1838 return r.outputFile
1839}
1840
1841func (r *RuntimeResourceOverlay) Theme() string {
1842 return String(r.properties.Theme)
1843}
1844
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001845// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1846// system resources at run time.
1847func RuntimeResourceOverlayFactory() android.Module {
1848 module := &RuntimeResourceOverlay{}
1849 module.AddProperties(
1850 &module.properties,
Roshan Pius4df2bc72020-04-27 09:42:27 -07001851 &module.aaptProperties,
1852 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001853
Roshan Pius4df2bc72020-04-27 09:42:27 -07001854 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1855 android.InitDefaultableModule(module)
1856 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001857 return module
1858}
1859
Colin Cross50ddcc42019-05-16 12:28:22 -07001860type UsesLibraryProperties struct {
1861 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1862 Uses_libs []string
1863
1864 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1865 // required=false.
1866 Optional_uses_libs []string
1867
1868 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1869 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1870 Enforce_uses_libs *bool
1871}
1872
1873// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1874// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1875// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1876// with knowledge of their shared libraries.
1877type usesLibrary struct {
1878 usesLibraryProperties UsesLibraryProperties
1879}
1880
Paul Duffin250e6192019-06-07 10:44:37 +01001881func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001882 if !ctx.Config().UnbundledBuild() {
1883 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1884 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001885 // Only add these extra dependencies if the module depends on framework libs. This avoids
1886 // creating a cyclic dependency:
1887 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1888 if hasFrameworkLibs {
Ulya Trafimovich5f364b62020-06-30 12:39:01 +01001889 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1890 // class loader context for dex2oat. Add them as a dependency with a special tag.
Colin Cross3245b2c2019-06-07 13:18:09 -07001891 ctx.AddVariationDependencies(nil, usesLibTag,
1892 "org.apache.http.legacy",
1893 "android.hidl.base-V1.0-java",
1894 "android.hidl.manager-V1.0-java")
Ulya Trafimovichc9af5382020-05-29 15:35:06 +01001895 ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001896 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001897 }
1898}
1899
1900// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1901// build.
1902func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1903 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1904 return optionalUsesLibs
1905}
1906
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001907// usesLibraryPaths returns a map of module names of shared library dependencies to the paths
1908// to their dex jars on host and on device.
1909func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths {
1910 usesLibPaths := make(dexpreopt.LibraryPaths)
Colin Cross50ddcc42019-05-16 12:28:22 -07001911
1912 if !ctx.Config().UnbundledBuild() {
1913 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001914 dep := ctx.OtherModuleName(m)
Colin Cross50ddcc42019-05-16 12:28:22 -07001915 if lib, ok := m.(Dependency); ok {
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001916 buildPath := lib.DexJarBuildPath()
1917 if buildPath == nil {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001918 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+
1919 " produce a dex jar, does it have installable: true?", dep)
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001920 return
Colin Cross50ddcc42019-05-16 12:28:22 -07001921 }
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001922
1923 var devicePath string
1924 installPath := lib.DexJarInstallPath()
1925 if installPath == nil {
1926 devicePath = filepath.Join("/system/framework", dep+".jar")
1927 } else {
1928 devicePath = android.InstallPathToOnDevicePath(ctx, installPath.(android.InstallPath))
1929 }
1930
1931 usesLibPaths[dep] = &dexpreopt.LibraryPath{buildPath, devicePath}
Colin Cross50ddcc42019-05-16 12:28:22 -07001932 } else if ctx.Config().AllowMissingDependencies() {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001933 ctx.AddMissingDependencies([]string{dep})
Colin Cross50ddcc42019-05-16 12:28:22 -07001934 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001935 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+
1936 "a java library", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001937 }
1938 })
1939 }
1940
1941 return usesLibPaths
1942}
1943
1944// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1945// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1946// unconditionally in the future.
1947func (u *usesLibrary) enforceUsesLibraries() bool {
1948 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1949 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1950 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1951}
1952
1953// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1954// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1955func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1956 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1957
1958 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001959 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001960 Flag("--enforce-uses-libraries").
1961 Input(manifest).
1962 FlagWithOutput("-o ", outputFile)
1963
1964 for _, lib := range u.usesLibraryProperties.Uses_libs {
1965 cmd.FlagWithArg("--uses-library ", lib)
1966 }
1967
1968 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1969 cmd.FlagWithArg("--optional-uses-library ", lib)
1970 }
1971
1972 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1973
1974 return outputFile
1975}
1976
1977// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1978// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1979func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1980 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1981
1982 rule := android.NewRuleBuilder()
1983 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1984 rule.Command().
1985 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1986 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1987 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1988 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1989 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1990
1991 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1992
1993 return outputFile
1994}