blob: 4071c0a7f864092accb2dee6b6d26c16a437f678 [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
Colin Cross4fb652d2020-07-09 19:05:35 -0700109func (as *AndroidAppSet) APKCertsFile() android.Path {
110 return as.apkcertsFile
111}
112
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700113var TargetCpuAbi = map[string]string{
Sasha Smundaka7856c02020-04-23 09:49:59 -0700114 "arm": "ARMEABI_V7A",
115 "arm64": "ARM64_V8A",
116 "x86": "X86",
117 "x86_64": "X86_64",
118}
119
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700120func SupportedAbis(ctx android.ModuleContext) []string {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700121 abiName := func(archVar string, deviceArch string) string {
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700122 if abi, found := TargetCpuAbi[deviceArch]; found {
Sasha Smundaka7856c02020-04-23 09:49:59 -0700123 return abi
124 }
125 ctx.ModuleErrorf("Invalid %s: %s", archVar, deviceArch)
126 return "BAD_ABI"
127 }
128
129 result := []string{abiName("TARGET_ARCH", ctx.DeviceConfig().DeviceArch())}
130 if s := ctx.DeviceConfig().DeviceSecondaryArch(); s != "" {
131 result = append(result, abiName("TARGET_2ND_ARCH", s))
132 }
133 return result
134}
135
136func (as *AndroidAppSet) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700137 as.packedOutput = android.PathForModuleOut(ctx, ctx.ModuleName()+".zip")
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700138 as.apkcertsFile = android.PathForModuleOut(ctx, "apkcerts.txt")
Sasha Smundaka7856c02020-04-23 09:49:59 -0700139 // We are assuming here that the master file in the APK
140 // set has `.apk` suffix. If it doesn't the build will fail.
141 // APK sets containing APEX files are handled elsewhere.
Sasha Smundak57f0ee12020-06-15 18:25:27 -0700142 as.masterFile = as.BaseModuleName() + ".apk"
Sasha Smundaka7856c02020-04-23 09:49:59 -0700143 screenDensities := "all"
144 if dpis := ctx.Config().ProductAAPTPrebuiltDPI(); len(dpis) > 0 {
145 screenDensities = strings.ToUpper(strings.Join(dpis, ","))
146 }
147 // TODO(asmundak): handle locales.
148 // TODO(asmundak): do we support device features
149 ctx.Build(pctx,
150 android.BuildParams{
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700151 Rule: extractMatchingApks,
152 Description: "Extract APKs from APK set",
153 Output: as.packedOutput,
154 ImplicitOutput: as.apkcertsFile,
155 Inputs: android.Paths{as.prebuilt.SingleSourcePath(ctx)},
Sasha Smundaka7856c02020-04-23 09:49:59 -0700156 Args: map[string]string{
Jaewoong Jungfa00c062020-05-14 14:15:24 -0700157 "abis": strings.Join(SupportedAbis(ctx), ","),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700158 "allow-prereleased": strconv.FormatBool(proptools.Bool(as.properties.Prerelease)),
159 "screen-densities": screenDensities,
160 "sdk-version": ctx.Config().PlatformSdkVersion(),
Sasha Smundake88b4362020-06-22 16:53:33 -0700161 "stem": as.BaseModuleName(),
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700162 "apkcerts": as.apkcertsFile.String(),
163 "partition": as.PartitionTag(ctx.DeviceConfig()),
Sasha Smundaka7856c02020-04-23 09:49:59 -0700164 },
165 })
Sasha Smundaka7856c02020-04-23 09:49:59 -0700166}
167
168// android_app_set extracts a set of APKs based on the target device
169// configuration and installs this set as "split APKs".
Sasha Smundak613cbb12020-06-05 10:27:23 -0700170// The extracted set always contains 'master' APK whose name is
171// _module_name_.apk and every split APK matching target device.
172// The extraction of the density-specific splits depends on
173// PRODUCT_AAPT_PREBUILT_DPI variable. If present (its value should
174// be a list density names: LDPI, MDPI, HDPI, etc.), only listed
175// splits will be extracted. Otherwise all density-specific splits
176// will be extracted.
Sasha Smundaka7856c02020-04-23 09:49:59 -0700177func AndroidApkSetFactory() android.Module {
178 module := &AndroidAppSet{}
179 module.AddProperties(&module.properties)
180 InitJavaModule(module, android.DeviceSupported)
181 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Set")
182 return module
Paul Duffinf9b1da02019-12-18 19:51:55 +0000183}
184
Colin Cross30e076a2015-04-13 13:58:27 -0700185// AndroidManifest.xml merging
186// package splits
187
Colin Crossfabb6082018-02-20 17:22:23 -0800188type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700189 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -0700190 Additional_certificates []string
191
192 // If set, create package-export.apk, which other packages can
193 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -0800194 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700195
Colin Cross16056062017-12-13 22:46:28 -0800196 // Specifies that this app should be installed to the priv-app directory,
197 // where the system will grant it additional privileges not available to
198 // normal apps.
199 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -0700200
201 // list of resource labels to generate individual resource packages
202 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -0400203
204 // Names of modules to be overridden. Listed modules can only be other binaries
205 // (in Make or Soong).
206 // This does not completely prevent installation of the overridden binaries, but if both
207 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
208 // from PRODUCT_PACKAGES.
209 Overrides []string
Colin Crossa4f08812018-10-02 22:03:40 -0700210
211 // list of native libraries that will be provided in or alongside the resulting jar
212 Jni_libs []string `android:"arch_variant"`
213
Colin Cross7204cf02020-05-06 17:51:39 -0700214 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -0800215 // sdk_version.
216 Jni_uses_platform_apis *bool
217
Colin Cross7204cf02020-05-06 17:51:39 -0700218 // if true, use JNI libraries that link against SDK APIs even if this module does not set
219 // sdk_version.
220 Jni_uses_sdk_apis *bool
221
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700222 // STL library to use for JNI libraries.
223 Stl *string `android:"arch_variant"`
224
Colin Crosse4246ab2019-02-05 21:55:21 -0800225 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
226 // 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 +0900227 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
228 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
229 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -0800230 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -0800231
232 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
233 // they are used from inside the APK at runtime.
234 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700235
236 // Forces native libraries to always be packaged into the APK,
237 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
238 // True for android_test* modules.
239 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700240
241 // If set, find and merge all NOTICE files that this module and its dependencies have and store
242 // it in the APK as an asset.
243 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700244
245 // cc.Coverage related properties
246 PreventInstall bool `blueprint:"mutated"`
247 HideFromMake bool `blueprint:"mutated"`
248 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100249
250 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100251 // additional rules to make sure an app can safely be updated. Default is false.
252 // Prefer using other specific properties if build behaviour must be changed; avoid using this
253 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100254 Updatable *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700255}
256
Jaewoong Jung525443a2019-02-28 15:35:54 -0800257// android_app properties that can be overridden by override_android_app
258type overridableAppProperties struct {
259 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
260 // or an android_app_certificate module name in the form ":module".
261 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700262
Liz Kammere2b27f42020-05-07 13:24:05 -0700263 // Name of the signing certificate lineage file.
264 Lineage *string
265
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700266 // the package name of this app. The package name in the manifest file is used if one was not given.
267 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800268
269 // the logging parent of this app.
270 Logging_parent *string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800271}
272
Roshan Pius4df2bc72020-04-27 09:42:27 -0700273// runtime_resource_overlay properties that can be overridden by override_runtime_resource_overlay
274type OverridableRuntimeResourceOverlayProperties struct {
275 // the package name of this app. The package name in the manifest file is used if one was not given.
276 Package_name *string
277
278 // the target package name of this overlay app. The target package name in the manifest file is used if one was not given.
279 Target_package_name *string
280}
281
Colin Cross30e076a2015-04-13 13:58:27 -0700282type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700283 Library
284 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800285 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700286
Colin Cross50ddcc42019-05-16 12:28:22 -0700287 usesLibrary usesLibrary
288
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900289 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700290
Colin Crossfabb6082018-02-20 17:22:23 -0800291 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700292
Jaewoong Jung525443a2019-02-28 15:35:54 -0800293 overridableAppProperties overridableAppProperties
294
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700295 installJniLibs []jniLib
296 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700297
298 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800299
300 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
301 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800302
Colin Cross70dda7e2019-10-01 22:05:35 -0700303 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700304
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700305 onDeviceDir string
306
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800307 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700308
309 noticeOutputs android.NoticeOutputs
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900310
311 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100312
313 android.ApexBundleDepsInfo
Colin Crosse1731a52017-12-14 11:22:55 -0800314}
315
Martin Stjernholm6d415272020-01-31 17:10:36 +0000316func (a *AndroidApp) IsInstallable() bool {
317 return Bool(a.properties.Installable)
318}
319
Colin Cross89c31582018-04-30 15:55:11 -0700320func (a *AndroidApp) ExportedProguardFlagFiles() android.Paths {
321 return nil
322}
323
Colin Cross66f78822018-05-02 12:58:28 -0700324func (a *AndroidApp) ExportedStaticPackages() android.Paths {
325 return nil
326}
327
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900328func (a *AndroidApp) OutputFile() android.Path {
329 return a.outputFile
330}
331
Colin Cross503c1d02020-01-28 14:00:53 -0800332func (a *AndroidApp) Certificate() Certificate {
333 return a.certificate
334}
335
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700336func (a *AndroidApp) JniCoverageOutputs() android.Paths {
337 return a.jniCoverageOutputs
338}
339
Colin Crossa97c5d32018-03-28 14:58:31 -0700340var _ AndroidLibraryDependency = (*AndroidApp)(nil)
341
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900342type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800343 Pem, Key android.Path
344 presigned bool
345}
346
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700347var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800348
349func (c Certificate) AndroidMkString() string {
350 if c.presigned {
351 return "PRESIGNED"
352 } else {
353 return c.Pem.String()
354 }
Colin Cross30e076a2015-04-13 13:58:27 -0700355}
356
Colin Cross46c9b8b2017-06-22 16:51:17 -0700357func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
358 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700359
Jiyong Park6a927c42020-01-21 02:03:43 +0900360 if String(a.appProperties.Stl) == "c++_shared" && !a.sdkVersion().specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700361 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
362 }
363
Paul Duffin250e6192019-06-07 10:44:37 +0100364 sdkDep := decodeSdkDep(ctx, sdkContext(a))
365 if sdkDep.hasFrameworkLibs() {
366 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700367 }
Colin Crossa4f08812018-10-02 22:03:40 -0700368
Colin Cross3c007702020-05-08 11:20:24 -0700369 usesSDK := a.sdkVersion().specified() && a.sdkVersion().kind != sdkCorePlatform
370
371 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
372 ctx.PropertyErrorf("jni_uses_sdk_apis",
373 "can only be set for modules that do not set sdk_version")
374 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
375 ctx.PropertyErrorf("jni_uses_platform_apis",
376 "can only be set for modules that set sdk_version")
377 }
378
Peter Collingbournead84f972019-12-17 16:46:18 -0800379 tag := &jniDependencyTag{}
Colin Crossa4f08812018-10-02 22:03:40 -0700380 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700381 variation := append(jniTarget.Variations(),
382 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000383
384 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
385 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700386 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
387 // have stable APIs through the VNDK.
388 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
389 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700390 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000391 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
392 }
Colin Crossa4f08812018-10-02 22:03:40 -0700393 ctx.AddFarVariationDependencies(variation, tag, a.appProperties.Jni_libs...)
394 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700395
Paul Duffin250e6192019-06-07 10:44:37 +0100396 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700397}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700398
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700399func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800400 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700401 if cert != "" {
402 ctx.AddDependency(ctx.Module(), certificateTag, cert)
403 }
404
405 for _, cert := range a.appProperties.Additional_certificates {
406 cert = android.SrcIsModule(cert)
407 if cert != "" {
408 ctx.AddDependency(ctx.Module(), certificateTag, cert)
409 } else {
410 ctx.PropertyErrorf("additional_certificates",
411 `must be names of android_app_certificate modules in the form ":module"`)
412 }
413 }
Colin Cross30e076a2015-04-13 13:58:27 -0700414}
415
Jeongik Cha538c0d02019-07-11 15:54:27 +0900416func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
417 a.generateAndroidBuildActions(ctx)
418}
419
Colin Cross46c9b8b2017-06-22 16:51:17 -0700420func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100421 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700422 a.generateAndroidBuildActions(ctx)
423}
424
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100425func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100426 if a.Updatable() {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100427 if !a.sdkVersion().stable() {
428 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.sdkVersion())
429 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100430 if String(a.deviceProperties.Min_sdk_version) == "" {
431 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
432 }
Jooyung Han749dc692020-04-15 11:03:39 +0900433
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900434 if minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx); err == nil {
435 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +0900436 android.CheckMinSdkVersion(a, ctx, int(minSdkVersion))
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900437 } else {
438 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
439 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100440 }
441
442 a.checkPlatformAPI(ctx)
443 a.checkSdkVersions(ctx)
444}
445
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900446// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
447// This check is enforced for "updatable" APKs (including APK-in-APEX).
448// b/155209650: until min_sdk_version is properly supported, use sdk_version instead.
449// because, sdk_version is overridden by min_sdk_version (if set as smaller)
450// and linkType is checked with dependencies so we can be sure that the whole dependency tree
451// will meet the requirements.
452func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion sdkVersion) {
453 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
454 ctx.VisitDirectDeps(func(m android.Module) {
455 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
456 return
457 }
458 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900459 // The domain of cc.sdk_version is "current" and <number>
460 // We can rely on sdkSpec to convert it to <number> so that "current" is handled
461 // properly regardless of sdk finalization.
462 jniSdkVersion, err := sdkSpecFrom(dep.SdkVersion()).effectiveVersion(ctx)
463 if err != nil || minSdkVersion < jniSdkVersion {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900464 ctx.OtherModuleErrorf(dep, "sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
465 dep.SdkVersion(), minSdkVersion, ctx.ModuleName())
466 return
467 }
468
469 })
470}
471
Sasha Smundak6ad77252019-05-01 13:16:22 -0700472// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800473// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700474func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park6a927c42020-01-21 02:03:43 +0900475 minSdkVersion, err := a.minSdkVersion().effectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800476 if err != nil {
477 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.minSdkVersion(), err)
478 }
479
Jiyong Park52cd06f2019-11-11 10:14:32 +0900480 return (minSdkVersion >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
481 !a.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800482}
483
Colin Cross43f08db2018-11-12 10:13:39 -0800484// Returns whether this module should have the dex file stored uncompressed in the APK.
485func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800486 if Bool(a.appProperties.Use_embedded_dex) {
487 return true
488 }
489
Colin Cross53a87f52019-06-25 13:35:30 -0700490 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
491 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900492 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000493 return true
494 }
495
Colin Cross53a87f52019-06-25 13:35:30 -0700496 if ctx.Config().UnbundledBuild() {
497 return false
498 }
499
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700500 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700501}
502
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700503func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
504 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Jiyong Park52cd06f2019-11-11 10:14:32 +0900505 !a.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700506}
507
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900508func (a *AndroidApp) OverriddenManifestPackageName() string {
509 return a.overriddenManifestPackageName
510}
511
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800512func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
David Brazdild25060a2019-02-18 18:24:16 +0000513 a.aapt.usesNonSdkApis = Bool(a.Module.deviceProperties.Platform_apis)
514
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700515 // Ask manifest_fixer to add or update the application element indicating this app has no code.
516 a.aapt.hasNoCode = !a.hasCode(ctx)
517
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800518 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800519
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800520 // 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 -0800521 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700522 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800523 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700524 }
525
Dan Willemsen72be5902018-10-24 20:24:57 -0700526 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
527 // Product AAPT config
528 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800529 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700530 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700531
Dan Willemsen72be5902018-10-24 20:24:57 -0700532 // Product AAPT preferred config
533 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800534 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700535 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700536 }
537
Jiyong Park7f67f482019-01-05 12:57:48 +0900538 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700539 if overridden || a.overridableAppProperties.Package_name != nil {
540 // The product override variable has a priority over the package_name property.
541 if !overridden {
542 manifestPackageName = *a.overridableAppProperties.Package_name
543 }
Liz Kammer1d5983b2020-05-19 19:15:37 +0000544 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900545 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900546 }
547
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800548 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
549
Colin Crosse560c4a2019-03-19 16:03:11 -0700550 a.aapt.splitNames = a.appProperties.Package_splits
Colin Cross50ddcc42019-05-16 12:28:22 -0700551 a.aapt.sdkLibraries = a.exportedSdkLibs
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800552 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800553 a.aapt.buildActions(ctx, sdkContext(a), aaptLinkFlags...)
Colin Cross30e076a2015-04-13 13:58:27 -0700554
Colin Cross46c9b8b2017-06-22 16:51:17 -0700555 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700556 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800557}
Colin Cross30e076a2015-04-13 13:58:27 -0700558
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800559func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700560 var staticLibProguardFlagFiles android.Paths
561 ctx.VisitDirectDeps(func(m android.Module) {
562 if lib, ok := m.(AndroidLibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
563 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
564 }
565 })
566
567 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
568
569 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
570 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800571}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800572
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800573func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross43f08db2018-11-12 10:13:39 -0800574
575 var installDir string
576 if ctx.ModuleName() == "framework-res" {
577 // framework-res.apk is installed as system/framework/framework-res.apk
578 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900579 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800580 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800581 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800582 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800583 }
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800584 a.dexpreopter.installPath = android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
David Srbeckye033cba2020-05-20 22:20:28 +0100585 if a.deviceProperties.Uncompress_dex == nil {
586 // If the value was not force-set by the user, use reasonable default based on the module.
587 a.deviceProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
588 }
589 a.dexpreopter.uncompressedDex = *a.deviceProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700590 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
591 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
592 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
593 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
594 a.dexpreopter.manifestFile = a.mergedManifestFile
595
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800596 if ctx.ModuleName() != "framework-res" {
597 a.Module.compile(ctx, a.aaptSrcJar)
598 }
Colin Cross30e076a2015-04-13 13:58:27 -0700599
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800600 return a.maybeStrippedDexJarFile
601}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800602
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800603func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700604 var jniJarFile android.WritablePath
Colin Crossa4f08812018-10-02 22:03:40 -0700605 if len(jniLibs) > 0 {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700606 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700607 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Sasha Smundak6ad77252019-05-01 13:16:22 -0700608 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700609 for _, jni := range jniLibs {
610 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700611 // Only collect coverage for the first target arch if this is a multilib target.
612 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
613 // data file path collisions since the current coverage file path format doesn't contain
614 // arch-related strings. This is fine for now though; the code coverage team doesn't use
615 // multi-arch targets such as test_suite_* for coverage collections yet.
616 //
617 // Work with the team to come up with a new format that handles multilib modules properly
618 // and change this.
619 if len(ctx.Config().Targets[android.Android]) == 1 ||
620 ctx.Config().Targets[android.Android][0].Arch.ArchType == jni.target.Arch.ArchType {
621 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
622 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700623 }
624 }
Colin Crossa4f08812018-10-02 22:03:40 -0700625 } else {
626 a.installJniLibs = jniLibs
627 }
628 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800629 return jniJarFile
630}
Colin Crossa4f08812018-10-02 22:03:40 -0700631
Jaewoong Jung0949f312019-09-11 10:25:18 -0700632func (a *AndroidApp) noticeBuildActions(ctx android.ModuleContext) {
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700633 // Collect NOTICE files from all dependencies.
634 seenModules := make(map[android.Module]bool)
635 noticePathSet := make(map[android.Path]bool)
636
637 ctx.WalkDeps(func(child android.Module, parent android.Module) bool {
638 // Have we already seen this?
639 if _, ok := seenModules[child]; ok {
640 return false
641 }
642 seenModules[child] = true
643
644 // Skip host modules.
645 if child.Target().Os.Class == android.Host || child.Target().Os.Class == android.HostCross {
646 return false
647 }
648
Bob Badoura75b0572020-02-18 20:21:55 -0800649 paths := child.(android.Module).NoticeFiles()
650 if len(paths) > 0 {
651 for _, path := range paths {
652 noticePathSet[path] = true
653 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700654 }
655 return true
656 })
657
658 // If the app has one, add it too.
Bob Badoura75b0572020-02-18 20:21:55 -0800659 if len(a.NoticeFiles()) > 0 {
660 for _, path := range a.NoticeFiles() {
661 noticePathSet[path] = true
662 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700663 }
664
665 if len(noticePathSet) == 0 {
Jaewoong Jung98772792019-07-01 17:15:13 -0700666 return
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700667 }
668 var noticePaths []android.Path
669 for path := range noticePathSet {
670 noticePaths = append(noticePaths, path)
671 }
672 sort.Slice(noticePaths, func(i, j int) bool {
673 return noticePaths[i].String() < noticePaths[j].String()
674 })
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700675
Jaewoong Jung0949f312019-09-11 10:25:18 -0700676 a.noticeOutputs = android.BuildNoticeOutput(ctx, a.installDir, a.installApkName+".apk", noticePaths)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700677}
678
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700679// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
680// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
681func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate, ctx android.ModuleContext) []Certificate {
682 if android.SrcIsModule(certPropValue) == "" {
683 var mainCert Certificate
684 if certPropValue != "" {
685 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
686 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800687 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
688 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700689 }
690 } else {
691 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800692 mainCert = Certificate{
693 Pem: pem,
694 Key: key,
695 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700696 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700697 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700698 }
699
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700700 if !m.Platform() {
701 certPath := certificates[0].Pem.String()
Jeongik Chac9464142019-01-07 12:07:27 +0900702 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
703 if strings.HasPrefix(certPath, systemCertPath) {
704 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
Colin Cross440e0d02020-06-11 11:32:11 -0700705 allowed := ctx.Config().EnforceSystemCertificateAllowList()
Jeongik Chac9464142019-01-07 12:07:27 +0900706
Colin Cross440e0d02020-06-11 11:32:11 -0700707 if enforceSystemCert && !inList(m.Name(), allowed) {
Jeongik Chac9464142019-01-07 12:07:27 +0900708 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
709 }
710 }
711 }
712
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700713 return certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800714}
715
Jooyung Han39ee1192020-03-23 20:21:11 +0900716func (a *AndroidApp) InstallApkName() string {
717 return a.installApkName
718}
719
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800720func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700721 var apkDeps android.Paths
722
Jeongik Cha538c0d02019-07-11 15:54:27 +0900723 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
724 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
725
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800726 // Check if the install APK name needs to be overridden.
Jaewoong Jung525443a2019-02-28 15:35:54 -0800727 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(a.Name())
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800728
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700729 if ctx.ModuleName() == "framework-res" {
730 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700731 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900732 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700733 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
734 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800735 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700736 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700737 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700738 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700739 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700740
Jaewoong Jung0949f312019-09-11 10:25:18 -0700741 a.noticeBuildActions(ctx)
Jaewoong Jung98772792019-07-01 17:15:13 -0700742 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
743 a.aapt.noticeFile = a.noticeOutputs.HtmlGzOutput
744 }
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700745
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800746 // Process all building blocks, from AAPT to certificates.
747 a.aaptBuildActions(ctx)
748
Colin Cross50ddcc42019-05-16 12:28:22 -0700749 if a.usesLibrary.enforceUsesLibraries() {
750 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
751 apkDeps = append(apkDeps, manifestCheckFile)
752 }
753
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800754 a.proguardBuildActions(ctx)
755
Colin Cross014489c2020-06-02 20:09:13 -0700756 a.linter.mergedManifest = a.aapt.mergedManifestFile
757 a.linter.manifest = a.aapt.manifestPath
758 a.linter.resources = a.aapt.resourceFiles
759
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800760 dexJarFile := a.dexBuildActions(ctx)
761
Colin Crossc2d24052020-05-13 11:05:02 -0700762 jniLibs, certificateDeps := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800763 jniJarFile := a.jniBuildActions(jniLibs, ctx)
764
765 if ctx.Failed() {
766 return
767 }
768
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700769 certificates := processMainCert(a.ModuleBase, a.getCertString(ctx), certificateDeps, ctx)
770 a.certificate = certificates[0]
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800771
772 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800773 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700774 var lineageFile android.Path
775 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
776 lineageFile = android.PathForModuleSrc(ctx, lineage)
777 }
778 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, lineageFile)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800779 a.outputFile = packageFile
780
Colin Crosse560c4a2019-03-19 16:03:11 -0700781 for _, split := range a.aapt.splits {
782 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800783 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Liz Kammere2b27f42020-05-07 13:24:05 -0700784 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, lineageFile)
Colin Crosse560c4a2019-03-19 16:03:11 -0700785 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
786 }
787
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800788 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700789 bundleFile := android.PathForModuleOut(ctx, "base.zip")
790 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
791 a.bundleFile = bundleFile
792
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800793 // Install the app package.
Jiyong Park8ba50f92019-11-13 15:01:01 +0900794 if (Bool(a.Module.properties.Installable) || ctx.Host()) && a.IsForPlatform() {
795 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile)
796 for _, extra := range a.extraOutputFiles {
797 ctx.InstallFile(a.installDir, extra.Base(), extra)
798 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800799 }
Artur Satayev1111b842020-04-27 19:05:28 +0100800
801 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700802}
803
Colin Crossc2d24052020-05-13 11:05:02 -0700804type appDepsInterface interface {
805 sdkVersion() sdkSpec
806 minSdkVersion() sdkSpec
807 RequiresStableAPIs(ctx android.BaseModuleContext) bool
808}
809
810func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
811 shouldCollectRecursiveNativeDeps bool,
Colin Cross094cde42020-02-15 10:38:00 -0800812 checkNativeSdkVersion bool) ([]jniLib, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700813
Colin Crossa4f08812018-10-02 22:03:40 -0700814 var jniLibs []jniLib
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900815 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800816 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700817
Colin Crossc2d24052020-05-13 11:05:02 -0700818 if checkNativeSdkVersion {
819 checkNativeSdkVersion = app.sdkVersion().specified() &&
820 app.sdkVersion().kind != sdkCorePlatform && !app.RequiresStableAPIs(ctx)
821 }
822
Peter Collingbournead84f972019-12-17 16:46:18 -0800823 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700824 otherName := ctx.OtherModuleName(module)
825 tag := ctx.OtherModuleDependencyTag(module)
826
Peter Collingbournead84f972019-12-17 16:46:18 -0800827 if IsJniDepTag(tag) || tag == cc.SharedDepTag {
Colin Crossa4f08812018-10-02 22:03:40 -0700828 if dep, ok := module.(*cc.Module); ok {
Peter Collingbournead84f972019-12-17 16:46:18 -0800829 if dep.IsNdk() || dep.IsStubs() {
830 return false
831 }
832
Colin Crossa4f08812018-10-02 22:03:40 -0700833 lib := dep.OutputFile()
Peter Collingbournead84f972019-12-17 16:46:18 -0800834 path := lib.Path()
835 if seenModulePaths[path.String()] {
836 return false
837 }
838 seenModulePaths[path.String()] = true
839
Colin Crossc2d24052020-05-13 11:05:02 -0700840 if checkNativeSdkVersion && dep.SdkVersion() == "" {
841 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
842 otherName)
Colin Cross094cde42020-02-15 10:38:00 -0800843 }
844
Colin Crossa4f08812018-10-02 22:03:40 -0700845 if lib.Valid() {
846 jniLibs = append(jniLibs, jniLib{
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700847 name: ctx.OtherModuleName(module),
848 path: path,
849 target: module.Target(),
850 coverageFile: dep.CoverageOutputFile(),
Colin Crossa4f08812018-10-02 22:03:40 -0700851 })
852 } else {
853 ctx.ModuleErrorf("dependency %q missing output file", otherName)
854 }
855 } else {
856 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700857 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800858
859 return shouldCollectRecursiveNativeDeps
860 }
861
862 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700863 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900864 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700865 } else {
866 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
867 }
Colin Crossa4f08812018-10-02 22:03:40 -0700868 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800869
870 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700871 })
872
Colin Crossbd01e2a2018-10-04 15:21:03 -0700873 return jniLibs, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700874}
875
Jooyung Han749dc692020-04-15 11:03:39 +0900876func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +0100877 ctx.WalkDeps(func(child, parent android.Module) bool {
878 isExternal := !a.DepIsInSameApex(ctx, child)
879 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +0900880 if !do(ctx, parent, am, isExternal) {
881 return false
882 }
Artur Satayev1111b842020-04-27 19:05:28 +0100883 }
884 return !isExternal
885 })
886}
887
888func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
889 if ctx.Host() {
890 return
891 }
892
893 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +0900894 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +0100895 depName := to.Name()
896 if info, exist := depsInfo[depName]; exist {
897 info.From = append(info.From, from.Name())
898 info.IsExternal = info.IsExternal && externalDep
899 depsInfo[depName] = info
900 } else {
901 toMinSdkVersion := "(no version)"
902 if m, ok := to.(interface{ MinSdkVersion() string }); ok {
903 if v := m.MinSdkVersion(); v != "" {
904 toMinSdkVersion = v
905 }
906 }
907 depsInfo[depName] = android.ApexModuleDepInfo{
908 To: depName,
909 From: []string{from.Name()},
910 IsExternal: externalDep,
911 MinSdkVersion: toMinSdkVersion,
912 }
913 }
Jooyung Han749dc692020-04-15 11:03:39 +0900914 return true
Artur Satayev1111b842020-04-27 19:05:28 +0100915 })
916
917 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(), depsInfo)
918}
919
Artur Satayev849f8442020-04-28 14:57:42 +0100920func (a *AndroidApp) Updatable() bool {
921 return Bool(a.appProperties.Updatable) || a.ApexModuleBase.Updatable()
922}
923
Colin Cross0ea8ba82019-06-06 14:33:29 -0700924func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800925 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
926 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000927 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800928 }
Jaewoong Jung525443a2019-02-28 15:35:54 -0800929 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800930}
931
Jiyong Park0f80c182020-01-31 02:49:53 +0900932func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
933 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
934 return true
935 }
936 return a.Library.DepIsInSameApex(ctx, dep)
937}
938
Jiyong Parkb7c639e2019-08-19 14:56:02 +0900939// For OutputFileProducer interface
940func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
941 switch tag {
942 case ".aapt.srcjar":
943 return []android.Path{a.aaptSrcJar}, nil
944 }
945 return a.Library.OutputFiles(tag)
946}
947
Jiyong Parkf7487312019-10-17 12:54:30 +0900948func (a *AndroidApp) Privileged() bool {
949 return Bool(a.appProperties.Privileged)
950}
951
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700952func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -0700953 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700954}
955
956func (a *AndroidApp) PreventInstall() {
957 a.appProperties.PreventInstall = true
958}
959
960func (a *AndroidApp) HideFromMake() {
961 a.appProperties.HideFromMake = true
962}
963
964func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
965 a.appProperties.IsCoverageVariant = coverage
966}
967
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -0400968func (a *AndroidApp) EnableCoverageIfNeeded() {}
969
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700970var _ cc.Coverage = (*AndroidApp)(nil)
971
Colin Cross1b16b0e2019-02-12 14:41:32 -0800972// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -0700973func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -0700974 module := &AndroidApp{}
975
Sasha Smundak2057f822019-04-16 17:16:58 -0700976 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross66dbc0b2017-12-28 12:23:20 -0800977 module.Module.deviceProperties.Optimize.Shrink = proptools.BoolPtr(true)
978
Colin Crossae5caf52018-05-22 11:11:52 -0700979 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -0700980 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -0700981
Colin Crossce6734e2020-06-15 16:09:53 -0700982 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -0700983 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -0700984 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -0800985 &module.appProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -0700986 &module.overridableAppProperties,
987 &module.usesLibrary.usesLibraryProperties)
Colin Cross36242852017-06-23 15:06:31 -0700988
Colin Crossa4f08812018-10-02 22:03:40 -0700989 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
990 android.InitDefaultableModule(module)
Jaewoong Jung525443a2019-02-28 15:35:54 -0800991 android.InitOverridableModule(module, &module.appProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +0900992 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -0700993
Colin Cross36242852017-06-23 15:06:31 -0700994 return module
Colin Cross30e076a2015-04-13 13:58:27 -0700995}
Colin Crossae5caf52018-05-22 11:11:52 -0700996
997type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -0700998 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -0700999 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001000
1001 // if specified, the instrumentation target package name in the manifest is overwritten by it.
1002 Instrumentation_target_package *string
Colin Crossae5caf52018-05-22 11:11:52 -07001003}
1004
1005type AndroidTest struct {
1006 AndroidApp
1007
1008 appTestProperties appTestProperties
1009
1010 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001011
1012 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001013 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001014}
1015
Jaewoong Jung0949f312019-09-11 10:25:18 -07001016func (a *AndroidTest) InstallInTestcases() bool {
1017 return true
1018}
1019
Colin Crossae5caf52018-05-22 11:11:52 -07001020func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001021 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001022 if a.appTestProperties.Instrumentation_target_package != nil {
1023 a.additionalAaptFlags = append(a.additionalAaptFlags,
1024 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1025 } else if a.appTestProperties.Instrumentation_for != nil {
1026 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001027 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1028 if overridden {
1029 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1030 }
1031 }
Colin Crossae5caf52018-05-22 11:11:52 -07001032 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001033
easoncylee5bcff5d2020-04-30 14:57:06 +08001034 for _, module := range a.testProperties.Test_mainline_modules {
1035 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1036 }
1037
Jaewoong Jung39982342020-01-14 10:27:18 -08001038 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001039 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001040 a.testConfig = a.FixTestConfig(ctx, testConfig)
Colin Cross8a497952019-03-05 22:25:09 -08001041 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001042}
1043
Jaewoong Jung39982342020-01-14 10:27:18 -08001044func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1045 if testConfig == nil {
1046 return nil
1047 }
1048
1049 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
1050 rule := android.NewRuleBuilder()
1051 command := rule.Command().BuiltTool(ctx, "test_config_fixer").Input(testConfig).Output(fixedConfig)
1052 fixNeeded := false
1053
1054 if ctx.ModuleName() != a.installApkName {
1055 fixNeeded = true
1056 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1057 }
1058
1059 if a.overridableAppProperties.Package_name != nil {
1060 fixNeeded = true
1061 command.FlagWithInput("--manifest ", a.manifestPath).
1062 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1063 }
1064
1065 if fixNeeded {
1066 rule.Build(pctx, ctx, "fix_test_config", "fix test config")
1067 return fixedConfig
1068 }
1069 return testConfig
1070}
1071
Colin Cross303e21f2018-08-07 16:49:25 -07001072func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001073 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001074}
1075
1076func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1077 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001078 if a.appTestProperties.Instrumentation_for != nil {
1079 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1080 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1081 // use instrumentationForTag instead of libTag.
1082 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1083 }
Colin Crossae5caf52018-05-22 11:11:52 -07001084}
1085
Colin Cross1b16b0e2019-02-12 14:41:32 -08001086// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1087// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001088func AndroidTestFactory() android.Module {
1089 module := &AndroidTest{}
1090
Sasha Smundak2057f822019-04-16 17:16:58 -07001091 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross5067db92018-09-17 16:46:35 -07001092
1093 module.Module.properties.Instrument = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001094 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001095 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001096 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001097 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001098 module.Module.linter.test = true
Colin Crossae5caf52018-05-22 11:11:52 -07001099
Colin Crossce6734e2020-06-15 16:09:53 -07001100 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001101 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001102 &module.aaptProperties,
1103 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001104 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001105 &module.overridableAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001106 &module.usesLibrary.usesLibraryProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001107 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001108
Colin Crossa4f08812018-10-02 22:03:40 -07001109 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1110 android.InitDefaultableModule(module)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001111 android.InitOverridableModule(module, &module.appProperties.Overrides)
Colin Crossae5caf52018-05-22 11:11:52 -07001112 return module
1113}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001114
Colin Cross252fc6f2018-10-04 15:22:03 -07001115type appTestHelperAppProperties struct {
1116 // list of compatibility suites (for example "cts", "vts") that the module should be
1117 // installed into.
1118 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001119
1120 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1121 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1122 // explicitly.
1123 Auto_gen_config *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001124}
1125
1126type AndroidTestHelperApp struct {
1127 AndroidApp
1128
1129 appTestHelperAppProperties appTestHelperAppProperties
1130}
1131
Jaewoong Jung326a9412019-11-21 10:41:00 -08001132func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1133 return true
1134}
1135
Colin Cross1b16b0e2019-02-12 14:41:32 -08001136// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1137// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1138// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001139func AndroidTestHelperAppFactory() android.Module {
1140 module := &AndroidTestHelperApp{}
1141
Sasha Smundak2057f822019-04-16 17:16:58 -07001142 module.Module.deviceProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001143
1144 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001145 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001146 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001147 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07001148 module.Module.linter.test = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001149
Colin Crossce6734e2020-06-15 16:09:53 -07001150 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001151 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001152 &module.aaptProperties,
1153 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001154 &module.appTestHelperAppProperties,
Colin Cross50ddcc42019-05-16 12:28:22 -07001155 &module.overridableAppProperties,
1156 &module.usesLibrary.usesLibraryProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001157
1158 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1159 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001160 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001161 return module
1162}
1163
Colin Crossbd01e2a2018-10-04 15:21:03 -07001164type AndroidAppCertificate struct {
1165 android.ModuleBase
1166 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001167 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001168}
1169
1170type AndroidAppCertificateProperties struct {
1171 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1172 Certificate *string
1173}
1174
Colin Cross1b16b0e2019-02-12 14:41:32 -08001175// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1176// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001177func AndroidAppCertificateFactory() android.Module {
1178 module := &AndroidAppCertificate{}
1179 module.AddProperties(&module.properties)
1180 android.InitAndroidModule(module)
1181 return module
1182}
1183
Colin Crossbd01e2a2018-10-04 15:21:03 -07001184func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1185 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001186 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001187 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1188 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001189 }
1190}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001191
1192type OverrideAndroidApp struct {
1193 android.ModuleBase
1194 android.OverrideModuleBase
1195}
1196
Sasha Smundak613cbb12020-06-05 10:27:23 -07001197func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001198 // All the overrides happen in the base module.
1199 // TODO(jungjw): Check the base module type.
1200}
1201
1202// override_android_app is used to create an android_app module based on another android_app by overriding
1203// some of its properties.
1204func OverrideAndroidAppModuleFactory() android.Module {
1205 m := &OverrideAndroidApp{}
1206 m.AddProperties(&overridableAppProperties{})
1207
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001208 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001209 android.InitOverrideModule(m)
1210 return m
1211}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001212
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001213type OverrideAndroidTest struct {
1214 android.ModuleBase
1215 android.OverrideModuleBase
1216}
1217
Sasha Smundak613cbb12020-06-05 10:27:23 -07001218func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001219 // All the overrides happen in the base module.
1220 // TODO(jungjw): Check the base module type.
1221}
1222
1223// override_android_test is used to create an android_app module based on another android_test by overriding
1224// some of its properties.
1225func OverrideAndroidTestModuleFactory() android.Module {
1226 m := &OverrideAndroidTest{}
1227 m.AddProperties(&overridableAppProperties{})
1228 m.AddProperties(&appTestProperties{})
1229
1230 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1231 android.InitOverrideModule(m)
1232 return m
1233}
1234
Roshan Pius4df2bc72020-04-27 09:42:27 -07001235type OverrideRuntimeResourceOverlay struct {
1236 android.ModuleBase
1237 android.OverrideModuleBase
1238}
1239
Sasha Smundak613cbb12020-06-05 10:27:23 -07001240func (i *OverrideRuntimeResourceOverlay) GenerateAndroidBuildActions(_ android.ModuleContext) {
Roshan Pius4df2bc72020-04-27 09:42:27 -07001241 // All the overrides happen in the base module.
1242 // TODO(jungjw): Check the base module type.
1243}
1244
1245// override_runtime_resource_overlay is used to create a module based on another
1246// runtime_resource_overlay module by overriding some of its properties.
1247func OverrideRuntimeResourceOverlayModuleFactory() android.Module {
1248 m := &OverrideRuntimeResourceOverlay{}
1249 m.AddProperties(&OverridableRuntimeResourceOverlayProperties{})
1250
1251 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1252 android.InitOverrideModule(m)
1253 return m
1254}
1255
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001256type AndroidAppImport struct {
1257 android.ModuleBase
1258 android.DefaultableModuleBase
Jiyong Park592a6a42020-04-21 22:34:28 +09001259 android.ApexModuleBase
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001260 prebuilt android.Prebuilt
1261
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001262 properties AndroidAppImportProperties
1263 dpiVariants interface{}
1264 archVariants interface{}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001265
1266 outputFile android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001267 certificate Certificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001268
1269 dexpreopter
Colin Cross50ddcc42019-05-16 12:28:22 -07001270
1271 usesLibrary usesLibrary
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001272
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001273 preprocessed bool
1274
Colin Cross70dda7e2019-10-01 22:05:35 -07001275 installPath android.InstallPath
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001276}
1277
1278type AndroidAppImportProperties struct {
1279 // A prebuilt apk to import
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001280 Apk *string
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001281
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001282 // The name of a certificate in the default certificate directory or an android_app_certificate
1283 // module name in the form ":module". Should be empty if presigned or default_dev_cert is set.
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001284 Certificate *string
1285
1286 // Set this flag to true if the prebuilt apk is already signed. The certificate property must not
1287 // be set for presigned modules.
1288 Presigned *bool
1289
Liz Kammer24978992020-05-13 15:49:21 -07001290 // Name of the signing certificate lineage file.
1291 Lineage *string
1292
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001293 // Sign with the default system dev certificate. Must be used judiciously. Most imported apps
1294 // need to either specify a specific certificate or be presigned.
1295 Default_dev_cert *bool
1296
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001297 // Specifies that this app should be installed to the priv-app directory,
1298 // where the system will grant it additional privileges not available to
1299 // normal apps.
1300 Privileged *bool
1301
1302 // Names of modules to be overridden. Listed modules can only be other binaries
1303 // (in Make or Soong).
1304 // This does not completely prevent installation of the overridden binaries, but if both
1305 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1306 // from PRODUCT_PACKAGES.
1307 Overrides []string
Jaewoong Jung8aae22e2019-07-17 10:21:49 -07001308
1309 // Optional name for the installed app. If unspecified, it is derived from the module name.
1310 Filename *string
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001311}
1312
Martin Stjernholm6d415272020-01-31 17:10:36 +00001313func (a *AndroidAppImport) IsInstallable() bool {
1314 return true
1315}
1316
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001317// Updates properties with variant-specific values.
1318func (a *AndroidAppImport) processVariants(ctx android.LoadHookContext) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001319 config := ctx.Config()
1320
1321 dpiProps := reflect.ValueOf(a.dpiVariants).Elem().FieldByName("Dpi_variants")
1322 // Try DPI variant matches in the reverse-priority order so that the highest priority match
1323 // overwrites everything else.
1324 // TODO(jungjw): Can we optimize this by making it priority order?
1325 for i := len(config.ProductAAPTPrebuiltDPI()) - 1; i >= 0; i-- {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001326 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPrebuiltDPI()[i])
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001327 }
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001328 if config.ProductAAPTPreferredConfig() != "" {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001329 MergePropertiesFromVariant(ctx, &a.properties, dpiProps, config.ProductAAPTPreferredConfig())
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001330 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001331
1332 archProps := reflect.ValueOf(a.archVariants).Elem().FieldByName("Arch")
1333 archType := ctx.Config().Targets[android.Android][0].Arch.ArchType
1334 MergePropertiesFromVariant(ctx, &a.properties, archProps, archType.Name)
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001335}
1336
Colin Cross1184b642019-12-30 18:43:07 -08001337func MergePropertiesFromVariant(ctx android.EarlyModuleContext,
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001338 dst interface{}, variantGroup reflect.Value, variant string) {
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001339 src := variantGroup.FieldByName(proptools.FieldNameForProperty(variant))
1340 if !src.IsValid() {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001341 return
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001342 }
1343
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001344 err := proptools.ExtendMatchingProperties([]interface{}{dst}, src.Interface(), nil, proptools.OrderAppend)
1345 if err != nil {
1346 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
1347 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
1348 } else {
1349 panic(err)
1350 }
1351 }
Jaewoong Junga5e5abc2019-04-26 14:31:50 -07001352}
1353
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001354func (a *AndroidAppImport) DepsMutator(ctx android.BottomUpMutatorContext) {
1355 cert := android.SrcIsModule(String(a.properties.Certificate))
1356 if cert != "" {
1357 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1358 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001359
Paul Duffin250e6192019-06-07 10:44:37 +01001360 a.usesLibrary.deps(ctx, true)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001361}
1362
1363func (a *AndroidAppImport) uncompressEmbeddedJniLibs(
1364 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001365 // Test apps don't need their JNI libraries stored uncompressed. As a matter of fact, messing
1366 // with them may invalidate pre-existing signature data.
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001367 if ctx.InstallInTestcases() && (Bool(a.properties.Presigned) || a.preprocessed) {
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001368 ctx.Build(pctx, android.BuildParams{
1369 Rule: android.Cp,
1370 Output: outputPath,
1371 Input: inputPath,
1372 })
1373 return
1374 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001375 rule := android.NewRuleBuilder()
1376 rule.Command().
1377 Textf(`if (zipinfo %s 'lib/*.so' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001378 BuiltTool(ctx, "zip2zip").
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001379 FlagWithInput("-i ", inputPath).
1380 FlagWithOutput("-o ", outputPath).
1381 FlagWithArg("-0 ", "'lib/**/*.so'").
1382 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1383 rule.Build(pctx, ctx, "uncompress-embedded-jni-libs", "Uncompress embedded JIN libs")
1384}
1385
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001386// Returns whether this module should have the dex file stored uncompressed in the APK.
1387func (a *AndroidAppImport) shouldUncompressDex(ctx android.ModuleContext) bool {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001388 if ctx.Config().UnbundledBuild() || a.preprocessed {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001389 return false
1390 }
1391
1392 // Uncompress dex in APKs of privileged apps
Jiyong Parkf7487312019-10-17 12:54:30 +09001393 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001394 return true
1395 }
1396
1397 return shouldUncompressDex(ctx, &a.dexpreopter)
1398}
1399
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001400func (a *AndroidAppImport) uncompressDex(
1401 ctx android.ModuleContext, inputPath android.Path, outputPath android.OutputPath) {
1402 rule := android.NewRuleBuilder()
1403 rule.Command().
1404 Textf(`if (zipinfo %s '*.dex' 2>/dev/null | grep -v ' stor ' >/dev/null) ; then`, inputPath).
Colin Crossee94d6a2019-07-08 17:08:34 -07001405 BuiltTool(ctx, "zip2zip").
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001406 FlagWithInput("-i ", inputPath).
1407 FlagWithOutput("-o ", outputPath).
1408 FlagWithArg("-0 ", "'classes*.dex'").
1409 Textf(`; else cp -f %s %s; fi`, inputPath, outputPath)
1410 rule.Build(pctx, ctx, "uncompress-dex", "Uncompress dex files")
1411}
1412
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001413func (a *AndroidAppImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001414 a.generateAndroidBuildActions(ctx)
1415}
1416
Jooyung Han39ee1192020-03-23 20:21:11 +09001417func (a *AndroidAppImport) InstallApkName() string {
1418 return a.BaseModuleName()
1419}
1420
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001421func (a *AndroidAppImport) generateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001422 numCertPropsSet := 0
1423 if String(a.properties.Certificate) != "" {
1424 numCertPropsSet++
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001425 }
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001426 if Bool(a.properties.Presigned) {
1427 numCertPropsSet++
1428 }
1429 if Bool(a.properties.Default_dev_cert) {
1430 numCertPropsSet++
1431 }
1432 if numCertPropsSet != 1 {
1433 ctx.ModuleErrorf("One and only one of certficate, presigned, and default_dev_cert properties must be set")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001434 }
1435
Colin Crossc2d24052020-05-13 11:05:02 -07001436 _, certificates := collectAppDeps(ctx, a, false, false)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001437
1438 // TODO: LOCAL_EXTRACT_APK/LOCAL_EXTRACT_DPI_APK
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001439 // TODO: LOCAL_PACKAGE_SPLITS
1440
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001441 srcApk := a.prebuilt.SingleSourcePath(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001442
1443 if a.usesLibrary.enforceUsesLibraries() {
1444 srcApk = a.usesLibrary.verifyUsesLibrariesAPK(ctx, srcApk)
1445 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001446
1447 // TODO: Install or embed JNI libraries
1448
1449 // Uncompress JNI libraries in the apk
1450 jnisUncompressed := android.PathForModuleOut(ctx, "jnis-uncompressed", ctx.ModuleName()+".apk")
1451 a.uncompressEmbeddedJniLibs(ctx, srcApk, jnisUncompressed.OutputPath)
1452
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001453 var installDir android.InstallPath
1454 if Bool(a.properties.Privileged) {
1455 installDir = android.PathForModuleInstall(ctx, "priv-app", a.BaseModuleName())
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001456 } else if ctx.InstallInTestcases() {
1457 installDir = android.PathForModuleInstall(ctx, a.BaseModuleName(), ctx.DeviceConfig().DeviceArch())
Kyeongkab.Namc4997142019-11-22 11:38:16 +09001458 } else {
1459 installDir = android.PathForModuleInstall(ctx, "app", a.BaseModuleName())
1460 }
1461
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001462 a.dexpreopter.installPath = installDir.Join(ctx, a.BaseModuleName()+".apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001463 a.dexpreopter.isPresignedPrebuilt = Bool(a.properties.Presigned)
Jaewoong Jungacf18d72019-05-02 14:55:29 -07001464 a.dexpreopter.uncompressedDex = a.shouldUncompressDex(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001465
1466 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
1467 a.dexpreopter.usesLibs = a.usesLibrary.usesLibraryProperties.Uses_libs
1468 a.dexpreopter.optionalUsesLibs = a.usesLibrary.presentOptionalUsesLibs(ctx)
1469 a.dexpreopter.libraryPaths = a.usesLibrary.usesLibraryPaths(ctx)
1470
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001471 dexOutput := a.dexpreopter.dexpreopt(ctx, jnisUncompressed)
Jaewoong Jungea1bdb02019-05-09 14:36:34 -07001472 if a.dexpreopter.uncompressedDex {
1473 dexUncompressed := android.PathForModuleOut(ctx, "dex-uncompressed", ctx.ModuleName()+".apk")
1474 a.uncompressDex(ctx, dexOutput, dexUncompressed.OutputPath)
1475 dexOutput = dexUncompressed
1476 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001477
Jooyung Han39ee1192020-03-23 20:21:11 +09001478 apkFilename := proptools.StringDefault(a.properties.Filename, a.BaseModuleName()+".apk")
1479
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001480 // TODO: Handle EXTERNAL
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001481
1482 // Sign or align the package if package has not been preprocessed
1483 if a.preprocessed {
1484 a.outputFile = srcApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001485 a.certificate = PresignedCertificate
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001486 } else if !Bool(a.properties.Presigned) {
Jaewoong Jung961d4fd2019-08-22 14:25:58 -07001487 // If the certificate property is empty at this point, default_dev_cert must be set to true.
1488 // Which makes processMainCert's behavior for the empty cert string WAI.
1489 certificates = processMainCert(a.ModuleBase, String(a.properties.Certificate), certificates, ctx)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001490 if len(certificates) != 1 {
1491 ctx.ModuleErrorf("Unexpected number of certificates were extracted: %q", certificates)
1492 }
Colin Cross503c1d02020-01-28 14:00:53 -08001493 a.certificate = certificates[0]
Jooyung Han39ee1192020-03-23 20:21:11 +09001494 signed := android.PathForModuleOut(ctx, "signed", apkFilename)
Liz Kammer24978992020-05-13 15:49:21 -07001495 var lineageFile android.Path
1496 if lineage := String(a.properties.Lineage); lineage != "" {
1497 lineageFile = android.PathForModuleSrc(ctx, lineage)
1498 }
1499 SignAppPackage(ctx, signed, dexOutput, certificates, lineageFile)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001500 a.outputFile = signed
1501 } else {
Jooyung Han39ee1192020-03-23 20:21:11 +09001502 alignedApk := android.PathForModuleOut(ctx, "zip-aligned", apkFilename)
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001503 TransformZipAlign(ctx, alignedApk, dexOutput)
1504 a.outputFile = alignedApk
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001505 a.certificate = PresignedCertificate
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001506 }
1507
1508 // TODO: Optionally compress the output apk.
1509
Jiyong Park592a6a42020-04-21 22:34:28 +09001510 if a.IsForPlatform() {
1511 a.installPath = ctx.InstallFile(installDir, apkFilename, a.outputFile)
1512 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001513
1514 // TODO: androidmk converter jni libs
1515}
1516
1517func (a *AndroidAppImport) Prebuilt() *android.Prebuilt {
1518 return &a.prebuilt
1519}
1520
1521func (a *AndroidAppImport) Name() string {
1522 return a.prebuilt.Name(a.ModuleBase.Name())
1523}
1524
Dario Frenicde2a032019-10-27 00:29:22 +01001525func (a *AndroidAppImport) OutputFile() android.Path {
1526 return a.outputFile
1527}
1528
Jiyong Park618922e2020-01-08 13:35:43 +09001529func (a *AndroidAppImport) JacocoReportClassesFile() android.Path {
1530 return nil
1531}
1532
Colin Cross503c1d02020-01-28 14:00:53 -08001533func (a *AndroidAppImport) Certificate() Certificate {
1534 return a.certificate
1535}
1536
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001537var dpiVariantGroupType reflect.Type
1538var archVariantGroupType reflect.Type
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001539
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001540func initAndroidAppImportVariantGroupTypes() {
1541 dpiVariantGroupType = createVariantGroupType(supportedDpis, "Dpi_variants")
1542
1543 archNames := make([]string, len(android.ArchTypeList()))
1544 for i, archType := range android.ArchTypeList() {
1545 archNames[i] = archType.Name
1546 }
1547 archVariantGroupType = createVariantGroupType(archNames, "Arch")
1548}
1549
1550// Populates all variant struct properties at creation time.
1551func (a *AndroidAppImport) populateAllVariantStructs() {
1552 a.dpiVariants = reflect.New(dpiVariantGroupType).Interface()
1553 a.AddProperties(a.dpiVariants)
1554
1555 a.archVariants = reflect.New(archVariantGroupType).Interface()
1556 a.AddProperties(a.archVariants)
1557}
1558
Jiyong Parkf7487312019-10-17 12:54:30 +09001559func (a *AndroidAppImport) Privileged() bool {
1560 return Bool(a.properties.Privileged)
1561}
1562
Sasha Smundak613cbb12020-06-05 10:27:23 -07001563func (a *AndroidAppImport) DepIsInSameApex(_ android.BaseModuleContext, _ android.Module) bool {
Jiyong Park592a6a42020-04-21 22:34:28 +09001564 // android_app_import might have extra dependencies via uses_libs property.
1565 // Don't track the dependency as we don't automatically add those libraries
1566 // to the classpath. It should be explicitly added to java_libs property of APEX
1567 return false
1568}
1569
Colin Crossc2d24052020-05-13 11:05:02 -07001570func (a *AndroidAppImport) sdkVersion() sdkSpec {
1571 return sdkSpecFrom("")
1572}
1573
1574func (a *AndroidAppImport) minSdkVersion() sdkSpec {
1575 return sdkSpecFrom("")
1576}
1577
Jooyung Han749dc692020-04-15 11:03:39 +09001578func (j *AndroidAppImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion int) error {
1579 // Do not check for prebuilts against the min_sdk_version of enclosing APEX
1580 return nil
1581}
1582
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001583func createVariantGroupType(variants []string, variantGroupName string) reflect.Type {
1584 props := reflect.TypeOf((*AndroidAppImportProperties)(nil))
1585
1586 variantFields := make([]reflect.StructField, len(variants))
1587 for i, variant := range variants {
1588 variantFields[i] = reflect.StructField{
1589 Name: proptools.FieldNameForProperty(variant),
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001590 Type: props,
1591 }
1592 }
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001593
1594 variantGroupStruct := reflect.StructOf(variantFields)
1595 return reflect.StructOf([]reflect.StructField{
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001596 {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001597 Name: variantGroupName,
1598 Type: variantGroupStruct,
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001599 },
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001600 })
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001601}
1602
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001603// android_app_import imports a prebuilt apk with additional processing specified in the module.
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001604// DPI-specific apk source files can be specified using dpi_variants. Example:
1605//
1606// android_app_import {
1607// name: "example_import",
1608// apk: "prebuilts/example.apk",
1609// dpi_variants: {
1610// mdpi: {
1611// apk: "prebuilts/example_mdpi.apk",
1612// },
1613// xhdpi: {
1614// apk: "prebuilts/example_xhdpi.apk",
1615// },
1616// },
1617// certificate: "PRESIGNED",
1618// }
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001619func AndroidAppImportFactory() android.Module {
1620 module := &AndroidAppImport{}
1621 module.AddProperties(&module.properties)
1622 module.AddProperties(&module.dexpreoptProperties)
Colin Cross50ddcc42019-05-16 12:28:22 -07001623 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001624 module.populateAllVariantStructs()
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001625 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
Jaewoong Jung1ce9ac62019-08-13 14:11:33 -07001626 module.processVariants(ctx)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001627 })
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001628
Jiyong Park592a6a42020-04-21 22:34:28 +09001629 android.InitApexModule(module)
Jaewoong Jung6abfbf72020-05-26 20:10:08 -07001630 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1631 android.InitDefaultableModule(module)
Jaewoong Jung3e18b192019-06-11 12:25:34 -07001632 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001633
1634 return module
1635}
Colin Cross50ddcc42019-05-16 12:28:22 -07001636
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001637type androidTestImportProperties struct {
1638 // Whether the prebuilt apk can be installed without additional processing. Default is false.
1639 Preprocessed *bool
1640}
1641
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001642type AndroidTestImport struct {
1643 AndroidAppImport
1644
1645 testProperties testProperties
1646
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001647 testImportProperties androidTestImportProperties
1648
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001649 data android.Paths
1650}
1651
1652func (a *AndroidTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001653 a.preprocessed = Bool(a.testImportProperties.Preprocessed)
1654
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001655 a.generateAndroidBuildActions(ctx)
1656
1657 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
1658}
1659
Jaewoong Jung7c5bd832020-01-13 09:55:39 -08001660func (a *AndroidTestImport) InstallInTestcases() bool {
1661 return true
1662}
1663
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001664// android_test_import imports a prebuilt test apk with additional processing specified in the
1665// module. DPI or arch variant configurations can be made as with android_app_import.
1666func AndroidTestImportFactory() android.Module {
1667 module := &AndroidTestImport{}
1668 module.AddProperties(&module.properties)
1669 module.AddProperties(&module.dexpreoptProperties)
1670 module.AddProperties(&module.usesLibrary.usesLibraryProperties)
1671 module.AddProperties(&module.testProperties)
Liz Kammer3b70b3f2020-05-20 14:36:30 -07001672 module.AddProperties(&module.testImportProperties)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001673 module.populateAllVariantStructs()
1674 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1675 module.processVariants(ctx)
1676 })
1677
Colin Crossc80828d2020-05-06 22:29:10 -07001678 module.dexpreopter.isTest = true
1679
Jiyong Park592a6a42020-04-21 22:34:28 +09001680 android.InitApexModule(module)
Jaewoong Jung243688e2020-05-01 15:50:08 -07001681 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1682 android.InitDefaultableModule(module)
Jaewoong Jungb28eb5f2019-08-27 15:01:50 -07001683 android.InitSingleSourcePrebuiltModule(module, &module.properties, "Apk")
1684
1685 return module
1686}
1687
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001688type RuntimeResourceOverlay struct {
1689 android.ModuleBase
1690 android.DefaultableModuleBase
Roshan Pius4df2bc72020-04-27 09:42:27 -07001691 android.OverridableModuleBase
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001692 aapt
1693
Roshan Pius4df2bc72020-04-27 09:42:27 -07001694 properties RuntimeResourceOverlayProperties
1695 overridableProperties OverridableRuntimeResourceOverlayProperties
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001696
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001697 certificate Certificate
1698
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001699 outputFile android.Path
1700 installDir android.InstallPath
1701}
1702
1703type RuntimeResourceOverlayProperties struct {
1704 // the name of a certificate in the default certificate directory or an android_app_certificate
1705 // module name in the form ":module".
1706 Certificate *string
1707
Liz Kammer966b2f02020-05-19 16:15:25 -07001708 // Name of the signing certificate lineage file.
1709 Lineage *string
1710
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001711 // optional theme name. If specified, the overlay package will be applied
1712 // only when the ro.boot.vendor.overlay.theme system property is set to the same value.
1713 Theme *string
1714
1715 // if not blank, set to the version of the sdk to compile against.
1716 // Defaults to compiling against the current platform.
1717 Sdk_version *string
1718
1719 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
1720 // Defaults to sdk_version if not set.
1721 Min_sdk_version *string
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001722
1723 // list of android_library modules whose resources are extracted and linked against statically
1724 Static_libs []string
1725
1726 // list of android_app modules whose resources are extracted and linked against
1727 Resource_libs []string
Jaewoong Jungad0177b2020-04-24 15:22:40 -07001728
1729 // Names of modules to be overridden. Listed modules can only be other overlays
1730 // (in Make or Soong).
1731 // This does not completely prevent installation of the overridden overlays, but if both
1732 // overlays would be installed by default (in PRODUCT_PACKAGES) the other overlay will be removed
1733 // from PRODUCT_PACKAGES.
1734 Overrides []string
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001735}
1736
Jiyong Park69aeba92020-04-24 21:16:36 +09001737// RuntimeResourceOverlayModule interface is used by the apex package to gather information from
1738// a RuntimeResourceOverlay module.
1739type RuntimeResourceOverlayModule interface {
1740 android.Module
1741 OutputFile() android.Path
1742 Certificate() Certificate
1743 Theme() string
1744}
1745
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001746func (r *RuntimeResourceOverlay) DepsMutator(ctx android.BottomUpMutatorContext) {
1747 sdkDep := decodeSdkDep(ctx, sdkContext(r))
1748 if sdkDep.hasFrameworkLibs() {
1749 r.aapt.deps(ctx, sdkDep)
1750 }
1751
1752 cert := android.SrcIsModule(String(r.properties.Certificate))
1753 if cert != "" {
1754 ctx.AddDependency(ctx.Module(), certificateTag, cert)
1755 }
Jaewoong Jungfe3c7f62020-04-09 16:15:30 -07001756
1757 ctx.AddVariationDependencies(nil, staticLibTag, r.properties.Static_libs...)
1758 ctx.AddVariationDependencies(nil, libTag, r.properties.Resource_libs...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001759}
1760
1761func (r *RuntimeResourceOverlay) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1762 // Compile and link resources
1763 r.aapt.hasNoCode = true
Jaewoong Jungf0f747c2020-01-24 10:30:02 -08001764 // Do not remove resources without default values nor dedupe resource configurations with the same value
Roshan Pius4df2bc72020-04-27 09:42:27 -07001765 aaptLinkFlags := []string{"--no-resource-deduping", "--no-resource-removal"}
1766 // Allow the override of "package name" and "overlay target package name"
1767 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
1768 if overridden || r.overridableProperties.Package_name != nil {
1769 // The product override variable has a priority over the package_name property.
1770 if !overridden {
1771 manifestPackageName = *r.overridableProperties.Package_name
1772 }
1773 aaptLinkFlags = append(aaptLinkFlags, "--rename-manifest-package "+manifestPackageName)
1774 }
1775 if r.overridableProperties.Target_package_name != nil {
1776 aaptLinkFlags = append(aaptLinkFlags,
1777 "--rename-overlay-target-package "+*r.overridableProperties.Target_package_name)
1778 }
1779 r.aapt.buildActions(ctx, r, aaptLinkFlags...)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001780
1781 // Sign the built package
Colin Crossc2d24052020-05-13 11:05:02 -07001782 _, certificates := collectAppDeps(ctx, r, false, false)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001783 certificates = processMainCert(r.ModuleBase, String(r.properties.Certificate), certificates, ctx)
1784 signed := android.PathForModuleOut(ctx, "signed", r.Name()+".apk")
Liz Kammer966b2f02020-05-19 16:15:25 -07001785 var lineageFile android.Path
1786 if lineage := String(r.properties.Lineage); lineage != "" {
1787 lineageFile = android.PathForModuleSrc(ctx, lineage)
1788 }
1789 SignAppPackage(ctx, signed, r.aapt.exportPackage, certificates, lineageFile)
Jaewoong Jung78ec5d82020-01-31 10:11:47 -08001790 r.certificate = certificates[0]
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001791
1792 r.outputFile = signed
1793 r.installDir = android.PathForModuleInstall(ctx, "overlay", String(r.properties.Theme))
1794 ctx.InstallFile(r.installDir, r.outputFile.Base(), r.outputFile)
1795}
1796
Jiyong Park6a927c42020-01-21 02:03:43 +09001797func (r *RuntimeResourceOverlay) sdkVersion() sdkSpec {
1798 return sdkSpecFrom(String(r.properties.Sdk_version))
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001799}
1800
1801func (r *RuntimeResourceOverlay) systemModules() string {
1802 return ""
1803}
1804
Jiyong Park6a927c42020-01-21 02:03:43 +09001805func (r *RuntimeResourceOverlay) minSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001806 if r.properties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +09001807 return sdkSpecFrom(*r.properties.Min_sdk_version)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001808 }
1809 return r.sdkVersion()
1810}
1811
Jiyong Park6a927c42020-01-21 02:03:43 +09001812func (r *RuntimeResourceOverlay) targetSdkVersion() sdkSpec {
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001813 return r.sdkVersion()
1814}
1815
Jiyong Park69aeba92020-04-24 21:16:36 +09001816func (r *RuntimeResourceOverlay) Certificate() Certificate {
1817 return r.certificate
1818}
1819
1820func (r *RuntimeResourceOverlay) OutputFile() android.Path {
1821 return r.outputFile
1822}
1823
1824func (r *RuntimeResourceOverlay) Theme() string {
1825 return String(r.properties.Theme)
1826}
1827
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001828// runtime_resource_overlay generates a resource-only apk file that can overlay application and
1829// system resources at run time.
1830func RuntimeResourceOverlayFactory() android.Module {
1831 module := &RuntimeResourceOverlay{}
1832 module.AddProperties(
1833 &module.properties,
Roshan Pius4df2bc72020-04-27 09:42:27 -07001834 &module.aaptProperties,
1835 &module.overridableProperties)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001836
Roshan Pius4df2bc72020-04-27 09:42:27 -07001837 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1838 android.InitDefaultableModule(module)
1839 android.InitOverridableModule(module, &module.properties.Overrides)
Jaewoong Jung9befb0c2020-01-18 10:33:43 -08001840 return module
1841}
1842
Colin Cross50ddcc42019-05-16 12:28:22 -07001843type UsesLibraryProperties struct {
1844 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1845 Uses_libs []string
1846
1847 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1848 // required=false.
1849 Optional_uses_libs []string
1850
1851 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1852 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1853 Enforce_uses_libs *bool
1854}
1855
1856// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1857// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1858// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1859// with knowledge of their shared libraries.
1860type usesLibrary struct {
1861 usesLibraryProperties UsesLibraryProperties
1862}
1863
Paul Duffin250e6192019-06-07 10:44:37 +01001864func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, hasFrameworkLibs bool) {
Colin Cross3245b2c2019-06-07 13:18:09 -07001865 if !ctx.Config().UnbundledBuild() {
1866 ctx.AddVariationDependencies(nil, usesLibTag, u.usesLibraryProperties.Uses_libs...)
1867 ctx.AddVariationDependencies(nil, usesLibTag, u.presentOptionalUsesLibs(ctx)...)
Paul Duffin250e6192019-06-07 10:44:37 +01001868 // Only add these extra dependencies if the module depends on framework libs. This avoids
1869 // creating a cyclic dependency:
1870 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
1871 if hasFrameworkLibs {
Ulya Trafimovich5f364b62020-06-30 12:39:01 +01001872 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1873 // class loader context for dex2oat. Add them as a dependency with a special tag.
Colin Cross3245b2c2019-06-07 13:18:09 -07001874 ctx.AddVariationDependencies(nil, usesLibTag,
1875 "org.apache.http.legacy",
1876 "android.hidl.base-V1.0-java",
1877 "android.hidl.manager-V1.0-java")
Ulya Trafimovichc9af5382020-05-29 15:35:06 +01001878 ctx.AddVariationDependencies(nil, usesLibTag, optionalUsesLibs...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001879 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001880 }
1881}
1882
1883// presentOptionalUsesLibs returns optional_uses_libs after filtering out MissingUsesLibraries, which don't exist in the
1884// build.
1885func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
1886 optionalUsesLibs, _ := android.FilterList(u.usesLibraryProperties.Optional_uses_libs, ctx.Config().MissingUsesLibraries())
1887 return optionalUsesLibs
1888}
1889
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001890// usesLibraryPaths returns a map of module names of shared library dependencies to the paths
1891// to their dex jars on host and on device.
1892func (u *usesLibrary) usesLibraryPaths(ctx android.ModuleContext) dexpreopt.LibraryPaths {
1893 usesLibPaths := make(dexpreopt.LibraryPaths)
Colin Cross50ddcc42019-05-16 12:28:22 -07001894
1895 if !ctx.Config().UnbundledBuild() {
1896 ctx.VisitDirectDepsWithTag(usesLibTag, func(m android.Module) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001897 dep := ctx.OtherModuleName(m)
Colin Cross50ddcc42019-05-16 12:28:22 -07001898 if lib, ok := m.(Dependency); ok {
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001899 buildPath := lib.DexJarBuildPath()
1900 if buildPath == nil {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001901 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must"+
1902 " produce a dex jar, does it have installable: true?", dep)
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001903 return
Colin Cross50ddcc42019-05-16 12:28:22 -07001904 }
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01001905
1906 var devicePath string
1907 installPath := lib.DexJarInstallPath()
1908 if installPath == nil {
1909 devicePath = filepath.Join("/system/framework", dep+".jar")
1910 } else {
1911 devicePath = android.InstallPathToOnDevicePath(ctx, installPath.(android.InstallPath))
1912 }
1913
1914 usesLibPaths[dep] = &dexpreopt.LibraryPath{buildPath, devicePath}
Colin Cross50ddcc42019-05-16 12:28:22 -07001915 } else if ctx.Config().AllowMissingDependencies() {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001916 ctx.AddMissingDependencies([]string{dep})
Colin Cross50ddcc42019-05-16 12:28:22 -07001917 } else {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +01001918 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be "+
1919 "a java library", dep)
Colin Cross50ddcc42019-05-16 12:28:22 -07001920 }
1921 })
1922 }
1923
1924 return usesLibPaths
1925}
1926
1927// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1928// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1929// unconditionally in the future.
1930func (u *usesLibrary) enforceUsesLibraries() bool {
1931 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1932 len(u.usesLibraryProperties.Optional_uses_libs) > 0
1933 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, defaultEnforceUsesLibs)
1934}
1935
1936// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against the ones specified
1937// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the manifest.
1938func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1939 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
1940
1941 rule := android.NewRuleBuilder()
Colin Crossee94d6a2019-07-08 17:08:34 -07001942 cmd := rule.Command().BuiltTool(ctx, "manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001943 Flag("--enforce-uses-libraries").
1944 Input(manifest).
1945 FlagWithOutput("-o ", outputFile)
1946
1947 for _, lib := range u.usesLibraryProperties.Uses_libs {
1948 cmd.FlagWithArg("--uses-library ", lib)
1949 }
1950
1951 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1952 cmd.FlagWithArg("--optional-uses-library ", lib)
1953 }
1954
1955 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1956
1957 return outputFile
1958}
1959
1960// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the ones specified
1961// in the uses_libs and optional_uses_libs properties. It returns the path to a copy of the APK.
1962func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) android.Path {
1963 outputFile := android.PathForModuleOut(ctx, "verify_uses_libraries", apk.Base())
1964
1965 rule := android.NewRuleBuilder()
1966 aapt := ctx.Config().HostToolPath(ctx, "aapt")
1967 rule.Command().
1968 Textf("aapt_binary=%s", aapt.String()).Implicit(aapt).
1969 Textf(`uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Uses_libs, " ")).
1970 Textf(`optional_uses_library_names="%s"`, strings.Join(u.usesLibraryProperties.Optional_uses_libs, " ")).
1971 Tool(android.PathForSource(ctx, "build/make/core/verify_uses_libraries.sh")).Input(apk)
1972 rule.Command().Text("cp -f").Input(apk).Output(outputFile)
1973
1974 rule.Build(pctx, ctx, "verify_uses_libraries", "verify <uses-library>")
1975
1976 return outputFile
1977}