blob: 1aa3afe8eab35d4e930ac042e1ddc8b85222318d [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
Jaewoong Jungf9b44652020-12-21 12:29:12 -080017// This file contains the module implementations for android_app, android_test, and some more
18// related module types, including their override variants.
Colin Cross30e076a2015-04-13 13:58:27 -070019
20import (
Jiakai Zhang4f65a032023-06-01 15:16:58 +010021 "fmt"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070022 "path/filepath"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070023 "strings"
Colin Cross30e076a2015-04-13 13:58:27 -070024
Aditya Choudhary9b593522023-10-06 19:54:58 +000025 "android/soong/testing"
Jihoon Kang84b25892023-12-01 22:01:06 +000026
Colin Cross50ddcc42019-05-16 12:28:22 -070027 "github.com/google/blueprint"
28 "github.com/google/blueprint/proptools"
29
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Crossa4f08812018-10-02 22:03:40 -070031 "android/soong/cc"
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +010032 "android/soong/dexpreopt"
Romain Jobredeaux9973ace2023-08-30 00:27:09 -040033 "android/soong/genrule"
Colin Cross303e21f2018-08-07 16:49:25 -070034 "android/soong/tradefed"
Colin Cross30e076a2015-04-13 13:58:27 -070035)
36
Colin Cross3bc7ffa2017-11-22 16:19:37 -080037func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000038 RegisterAppBuildComponents(android.InitRegistrationContext)
Andrei Onea580636b2022-08-17 16:53:46 +000039 pctx.HostBinToolVariable("ModifyAllowlistCmd", "modify_permissions_allowlist")
Colin Cross3bc7ffa2017-11-22 16:19:37 -080040}
41
Andrei Onea580636b2022-08-17 16:53:46 +000042var (
43 modifyAllowlist = pctx.AndroidStaticRule("modifyAllowlist",
44 blueprint.RuleParams{
45 Command: "${ModifyAllowlistCmd} $in $packageName $out",
46 CommandDeps: []string{"${ModifyAllowlistCmd}"},
47 }, "packageName")
48)
49
Paul Duffinf9b1da02019-12-18 19:51:55 +000050func RegisterAppBuildComponents(ctx android.RegistrationContext) {
51 ctx.RegisterModuleType("android_app", AndroidAppFactory)
52 ctx.RegisterModuleType("android_test", AndroidTestFactory)
53 ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
54 ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
55 ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
56 ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000057}
58
Colin Cross30e076a2015-04-13 13:58:27 -070059// AndroidManifest.xml merging
60// package splits
61
Colin Crossfabb6082018-02-20 17:22:23 -080062type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -070063 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -070064 Additional_certificates []string
65
66 // If set, create package-export.apk, which other packages can
67 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -080068 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -070069
Colin Cross16056062017-12-13 22:46:28 -080070 // Specifies that this app should be installed to the priv-app directory,
71 // where the system will grant it additional privileges not available to
72 // normal apps.
73 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -070074
75 // list of resource labels to generate individual resource packages
76 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -040077
Colin Crossa4f08812018-10-02 22:03:40 -070078 // list of native libraries that will be provided in or alongside the resulting jar
79 Jni_libs []string `android:"arch_variant"`
80
Colin Cross7204cf02020-05-06 17:51:39 -070081 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -080082 // sdk_version.
83 Jni_uses_platform_apis *bool
84
Colin Cross7204cf02020-05-06 17:51:39 -070085 // if true, use JNI libraries that link against SDK APIs even if this module does not set
86 // sdk_version.
87 Jni_uses_sdk_apis *bool
88
Jaewoong Jungbc625cd2019-05-06 15:48:44 -070089 // STL library to use for JNI libraries.
90 Stl *string `android:"arch_variant"`
91
Colin Crosse4246ab2019-02-05 21:55:21 -080092 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
93 // 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 +090094 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
95 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
96 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -080097 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -080098
99 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
100 // they are used from inside the APK at runtime.
101 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700102
103 // Forces native libraries to always be packaged into the APK,
104 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
105 // True for android_test* modules.
106 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700107
108 // If set, find and merge all NOTICE files that this module and its dependencies have and store
109 // it in the APK as an asset.
110 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700111
112 // cc.Coverage related properties
113 PreventInstall bool `blueprint:"mutated"`
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700114 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100115
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000116 // It can be set to test the behaviour of default target sdk version.
117 // Only required when updatable: false. It is an error if updatable: true and this is false.
118 Enforce_default_target_sdk_version *bool
119
120 // If set, the targetSdkVersion for the target is set to the latest default API level.
121 // This would be by default false, unless updatable: true or
122 // enforce_default_target_sdk_version: true in which case this defaults to true.
123 EnforceDefaultTargetSdkVersion bool `blueprint:"mutated"`
124
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100125 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100126 // additional rules to make sure an app can safely be updated. Default is false.
127 // Prefer using other specific properties if build behaviour must be changed; avoid using this
128 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100129 Updatable *bool
Andrei Onea580636b2022-08-17 16:53:46 +0000130
131 // Specifies the file that contains the allowlist for this app.
132 Privapp_allowlist *string `android:"path"`
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900133
134 // If set, create an RRO package which contains only resources having PRODUCT_CHARACTERISTICS
135 // and install the RRO package to /product partition, instead of passing --product argument
136 // to aapt2. Default is false.
137 // Setting this will make this APK identical to all targets, regardless of
138 // PRODUCT_CHARACTERISTICS.
139 Generate_product_characteristics_rro *bool
140
141 ProductCharacteristicsRROPackageName *string `blueprint:"mutated"`
142 ProductCharacteristicsRROManifestModuleName *string `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700143}
144
Jaewoong Jung525443a2019-02-28 15:35:54 -0800145// android_app properties that can be overridden by override_android_app
146type overridableAppProperties struct {
147 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
148 // or an android_app_certificate module name in the form ":module".
149 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700150
Jaewoong Jung1c1b6e62021-03-09 15:02:31 -0800151 // Name of the signing certificate lineage file or filegroup module.
152 Lineage *string `android:"path"`
Liz Kammere2b27f42020-05-07 13:24:05 -0700153
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400154 // For overriding the --rotation-min-sdk-version property of apksig
155 RotationMinSdkVersion *string
156
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700157 // the package name of this app. The package name in the manifest file is used if one was not given.
158 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800159
160 // the logging parent of this app.
161 Logging_parent *string
Liz Kammer9f9fd022020-06-18 19:44:06 +0000162
163 // Whether to rename the package in resources to the override name rather than the base name. Defaults to true.
164 Rename_resources_package *bool
zhidou198f5892022-02-17 02:33:12 +0000165
166 // Names of modules to be overridden. Listed modules can only be other binaries
167 // (in Make or Soong).
168 // This does not completely prevent installation of the overridden binaries, but if both
169 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
170 // from PRODUCT_PACKAGES.
171 Overrides []string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800172}
173
Colin Cross30e076a2015-04-13 13:58:27 -0700174type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700175 Library
176 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800177 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700178
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900179 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700180
Colin Crossfabb6082018-02-20 17:22:23 -0800181 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700182
Jaewoong Jung525443a2019-02-28 15:35:54 -0800183 overridableAppProperties overridableAppProperties
184
Colin Cross403cc152020-07-06 14:15:24 -0700185 jniLibs []jniLib
186 installPathForJNISymbols android.Path
187 embeddedJniLibs bool
188 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700189
190 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800191
192 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
193 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800194
Colin Cross70dda7e2019-10-01 22:05:35 -0700195 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700196
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700197 onDeviceDir string
198
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800199 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700200
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900201 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100202
203 android.ApexBundleDepsInfo
Matt Banda8c801262022-04-01 17:48:31 +0000204
205 javaApiUsedByOutputFile android.ModuleOutPath
Andrei Onea580636b2022-08-17 16:53:46 +0000206
207 privAppAllowlist android.OptionalPath
Colin Crosse1731a52017-12-14 11:22:55 -0800208}
209
Martin Stjernholm6d415272020-01-31 17:10:36 +0000210func (a *AndroidApp) IsInstallable() bool {
211 return Bool(a.properties.Installable)
212}
213
Colin Crossab8d1382023-07-14 17:23:41 +0000214func (a *AndroidApp) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
215 return a.aapt.resourcesNodesDepSet
Colin Cross66f78822018-05-02 12:58:28 -0700216}
217
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900218func (a *AndroidApp) OutputFile() android.Path {
219 return a.outputFile
220}
221
Colin Cross503c1d02020-01-28 14:00:53 -0800222func (a *AndroidApp) Certificate() Certificate {
223 return a.certificate
224}
225
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700226func (a *AndroidApp) JniCoverageOutputs() android.Paths {
227 return a.jniCoverageOutputs
228}
229
Andrei Onea580636b2022-08-17 16:53:46 +0000230func (a *AndroidApp) PrivAppAllowlist() android.OptionalPath {
231 return a.privAppAllowlist
232}
233
Colin Crossa97c5d32018-03-28 14:58:31 -0700234var _ AndroidLibraryDependency = (*AndroidApp)(nil)
235
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900236type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800237 Pem, Key android.Path
238 presigned bool
239}
240
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700241var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800242
243func (c Certificate) AndroidMkString() string {
244 if c.presigned {
245 return "PRESIGNED"
246 } else {
247 return c.Pem.String()
248 }
Colin Cross30e076a2015-04-13 13:58:27 -0700249}
250
Colin Cross46c9b8b2017-06-22 16:51:17 -0700251func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
252 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700253
Jiyong Park92315372021-04-02 08:45:46 +0900254 if String(a.appProperties.Stl) == "c++_shared" && !a.SdkVersion(ctx).Specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700255 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
256 }
257
Jiyong Parkf1691d22021-03-29 20:11:58 +0900258 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100259 if sdkDep.hasFrameworkLibs() {
260 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700261 }
Colin Crossa4f08812018-10-02 22:03:40 -0700262
Jiyong Park92315372021-04-02 08:45:46 +0900263 usesSDK := a.SdkVersion(ctx).Specified() && a.SdkVersion(ctx).Kind != android.SdkCorePlatform
Colin Cross3c007702020-05-08 11:20:24 -0700264
265 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
266 ctx.PropertyErrorf("jni_uses_sdk_apis",
267 "can only be set for modules that do not set sdk_version")
268 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
269 ctx.PropertyErrorf("jni_uses_platform_apis",
270 "can only be set for modules that set sdk_version")
271 }
272
Colin Crossa4f08812018-10-02 22:03:40 -0700273 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700274 variation := append(jniTarget.Variations(),
275 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000276
277 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
278 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700279 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
280 // have stable APIs through the VNDK.
281 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
282 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700283 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000284 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
285 }
Colin Crossde78d132020-10-09 18:59:49 -0700286 ctx.AddFarVariationDependencies(variation, jniLibTag, a.appProperties.Jni_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700287 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700288
Paul Duffin250e6192019-06-07 10:44:37 +0100289 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jihoon Kang9049c272024-03-19 21:57:36 +0000290
291 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
292 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
293 }
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700294}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700295
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700296func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800297 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700298 if cert != "" {
299 ctx.AddDependency(ctx.Module(), certificateTag, cert)
300 }
301
Andrei Onea580636b2022-08-17 16:53:46 +0000302 if a.appProperties.Privapp_allowlist != nil && !Bool(a.appProperties.Privileged) {
Anton Hanssone3f31cf2023-06-03 08:53:47 +0000303 // There are a few uids that are explicitly considered privileged regardless of their
304 // app's location. Bluetooth is one such app. It should arguably be moved to priv-app,
305 // but for now, allow it not to be in priv-app.
306 privilegedBecauseOfUid := ctx.ModuleName() == "Bluetooth"
307 if !privilegedBecauseOfUid {
308 ctx.PropertyErrorf("privapp_allowlist", "privileged must be set in order to use privapp_allowlist (with a few exceptions)")
309 }
Andrei Onea580636b2022-08-17 16:53:46 +0000310 }
311
Colin Crossbd01e2a2018-10-04 15:21:03 -0700312 for _, cert := range a.appProperties.Additional_certificates {
313 cert = android.SrcIsModule(cert)
314 if cert != "" {
315 ctx.AddDependency(ctx.Module(), certificateTag, cert)
316 } else {
317 ctx.PropertyErrorf("additional_certificates",
318 `must be names of android_app_certificate modules in the form ":module"`)
319 }
320 }
Colin Cross30e076a2015-04-13 13:58:27 -0700321}
322
Jeongik Cha538c0d02019-07-11 15:54:27 +0900323func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Alix96ea88452023-08-31 15:48:23 +0000324 applicationId := a.appTestHelperAppProperties.Manifest_values.ApplicationId
325 if applicationId != nil {
326 if a.overridableAppProperties.Package_name != nil {
327 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
328 }
329 a.aapt.manifestValues.applicationId = *applicationId
330 }
Jeongik Cha538c0d02019-07-11 15:54:27 +0900331 a.generateAndroidBuildActions(ctx)
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700332 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
333 TestOnly: true,
334 })
335
Jeongik Cha538c0d02019-07-11 15:54:27 +0900336}
337
Colin Cross46c9b8b2017-06-22 16:51:17 -0700338func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100339 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700340 a.generateAndroidBuildActions(ctx)
Matt Banda8c801262022-04-01 17:48:31 +0000341 a.generateJavaUsedByApex(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700342}
343
Sam Delmerico0e0d96e2023-08-18 22:43:28 +0000344func (a *AndroidApp) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
345 defaultMinSdkVersion := a.Module.MinSdkVersion(ctx)
346 if proptools.Bool(a.appProperties.Updatable) {
347 overrideApiLevel := android.MinSdkVersionFromValue(ctx, ctx.DeviceConfig().ApexGlobalMinSdkVersionOverride())
348 if !overrideApiLevel.IsNone() && overrideApiLevel.CompareTo(defaultMinSdkVersion) > 0 {
349 return overrideApiLevel
350 }
351 }
352 return defaultMinSdkVersion
353}
354
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100355func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100356 if a.Updatable() {
Jiyong Park92315372021-04-02 08:45:46 +0900357 if !a.SdkVersion(ctx).Stable() {
358 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.SdkVersion(ctx))
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100359 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100360 if String(a.deviceProperties.Min_sdk_version) == "" {
361 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
362 }
Jooyung Han749dc692020-04-15 11:03:39 +0900363
Jiyong Park92315372021-04-02 08:45:46 +0900364 if minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx); err == nil {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900365 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
satayevb3fd4112021-12-02 13:59:35 +0000366 android.CheckMinSdkVersion(ctx, minSdkVersion, a.WalkPayloadDeps)
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900367 } else {
368 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
369 }
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000370
371 if !BoolDefault(a.appProperties.Enforce_default_target_sdk_version, true) {
372 ctx.PropertyErrorf("enforce_default_target_sdk_version", "Updatable apps must enforce default target sdk version")
373 }
374 // TODO(b/227460469) after all the modules removes the target sdk version, throw an error if the target sdk version is explicitly set.
375 if a.deviceProperties.Target_sdk_version == nil {
376 a.SetEnforceDefaultTargetSdkVersion(true)
377 }
378 }
379
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100380 a.checkPlatformAPI(ctx)
381 a.checkSdkVersions(ctx)
382}
383
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900384// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
385// This check is enforced for "updatable" APKs (including APK-in-APEX).
Jiyong Park54105c42021-03-31 18:17:53 +0900386func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion android.ApiLevel) {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900387 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
388 ctx.VisitDirectDeps(func(m android.Module) {
389 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
390 return
391 }
392 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900393 // The domain of cc.sdk_version is "current" and <number>
Jiyong Parkf1691d22021-03-29 20:11:58 +0900394 // We can rely on android.SdkSpec to convert it to <number> so that "current" is
395 // handled properly regardless of sdk finalization.
Spandan Das2e8c0442022-05-08 00:39:35 +0000396 jniSdkVersion, err := android.SdkSpecFrom(ctx, dep.MinSdkVersion()).EffectiveVersion(ctx)
Jiyong Park54105c42021-03-31 18:17:53 +0900397 if err != nil || minSdkVersion.LessThan(jniSdkVersion) {
Spandan Das2e8c0442022-05-08 00:39:35 +0000398 ctx.OtherModuleErrorf(dep, "min_sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
399 dep.MinSdkVersion(), minSdkVersion, ctx.ModuleName())
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900400 return
401 }
402
403 })
404}
405
Sasha Smundak6ad77252019-05-01 13:16:22 -0700406// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800407// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700408func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park92315372021-04-02 08:45:46 +0900409 minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800410 if err != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900411 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.MinSdkVersion(ctx), err)
Colin Crosse4246ab2019-02-05 21:55:21 -0800412 }
413
Colin Crossff694a82023-12-13 15:54:49 -0800414 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jiyong Park54105c42021-03-31 18:17:53 +0900415 return (minSdkVersion.FinalOrFutureInt() >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
Colin Cross56a83212020-09-15 18:30:11 -0700416 !apexInfo.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800417}
418
Colin Cross43f08db2018-11-12 10:13:39 -0800419// Returns whether this module should have the dex file stored uncompressed in the APK.
420func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800421 if Bool(a.appProperties.Use_embedded_dex) {
422 return true
423 }
424
Colin Cross53a87f52019-06-25 13:35:30 -0700425 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
426 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900427 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000428 return true
429 }
430
Colin Cross53a87f52019-06-25 13:35:30 -0700431 if ctx.Config().UnbundledBuild() {
432 return false
433 }
434
Spandan Dase21a8d42024-01-23 23:56:29 +0000435 return shouldUncompressDex(ctx, android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName()), &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700436}
437
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700438func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
Colin Crossff694a82023-12-13 15:54:49 -0800439 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700440 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Colin Cross56a83212020-09-15 18:30:11 -0700441 !apexInfo.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700442}
443
Liz Kammer9f9fd022020-06-18 19:44:06 +0000444func generateAaptRenamePackageFlags(packageName string, renameResourcesPackage bool) []string {
445 aaptFlags := []string{"--rename-manifest-package " + packageName}
446 if renameResourcesPackage {
447 // Required to rename the package name in the resources table.
448 aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
449 }
450 return aaptFlags
451}
452
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900453func (a *AndroidApp) OverriddenManifestPackageName() string {
454 return a.overriddenManifestPackageName
455}
456
Liz Kammer9f9fd022020-06-18 19:44:06 +0000457func (a *AndroidApp) renameResourcesPackage() bool {
458 return proptools.BoolDefault(a.overridableAppProperties.Rename_resources_package, true)
459}
460
Jihoon Kang9049c272024-03-19 21:57:36 +0000461func getAconfigFilePaths(ctx android.ModuleContext) (aconfigTextFilePaths android.Paths) {
462 ctx.VisitDirectDepsWithTag(aconfigDeclarationTag, func(dep android.Module) {
463 if provider, ok := android.OtherModuleProvider(ctx, dep, android.AconfigDeclarationsProviderKey); ok {
464 aconfigTextFilePaths = append(aconfigTextFilePaths, provider.IntermediateDumpOutputPath)
465 } else {
466 ctx.ModuleErrorf("Only aconfig_declarations module type is allowed for "+
467 "flags_packages property, but %s is not aconfig_declarations module type",
468 dep.Name(),
469 )
470 }
471 })
472
473 return aconfigTextFilePaths
474}
475
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800476func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900477 usePlatformAPI := proptools.Bool(a.Module.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900478 if ctx.Module().(android.SdkContext).SdkVersion(ctx).Kind == android.SdkModule {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900479 usePlatformAPI = true
480 }
481 a.aapt.usesNonSdkApis = usePlatformAPI
David Brazdild25060a2019-02-18 18:24:16 +0000482
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700483 // Ask manifest_fixer to add or update the application element indicating this app has no code.
484 a.aapt.hasNoCode = !a.hasCode(ctx)
485
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800486 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800487
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800488 // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided.
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900489 autogenerateRRO := proptools.Bool(a.appProperties.Generate_product_characteristics_rro)
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800490 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Inseob Kim10af6ed2024-02-13 12:56:46 +0900491 characteristics := ctx.Config().ProductAAPTCharacteristics()
492 if !autogenerateRRO && !hasProduct && len(characteristics) > 0 && characteristics != "default" {
493 aaptLinkFlags = append(aaptLinkFlags, "--product", characteristics)
Colin Crosse78dcd32018-04-19 15:25:19 -0700494 }
495
Dan Willemsen72be5902018-10-24 20:24:57 -0700496 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
497 // Product AAPT config
498 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800499 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700500 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700501
Dan Willemsen72be5902018-10-24 20:24:57 -0700502 // Product AAPT preferred config
503 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800504 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700505 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700506 }
507
Jiyong Park7f67f482019-01-05 12:57:48 +0900508 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700509 if overridden || a.overridableAppProperties.Package_name != nil {
510 // The product override variable has a priority over the package_name property.
511 if !overridden {
512 manifestPackageName = *a.overridableAppProperties.Package_name
513 }
Liz Kammer9f9fd022020-06-18 19:44:06 +0000514 aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName, a.renameResourcesPackage())...)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900515 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900516 }
517
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800518 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
519
Colin Crosse560c4a2019-03-19 16:03:11 -0700520 a.aapt.splitNames = a.appProperties.Package_splits
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800521 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Alexei Nicoara69cf0f32022-07-27 14:59:18 +0100522 if a.Updatable() {
523 a.aapt.defaultManifestVersion = android.DefaultUpdatableModuleVersion
524 }
Jihoon Kang84b25892023-12-01 22:01:06 +0000525
Rico Winda2fa2632024-03-13 13:09:17 +0100526 // Use non final ids if we are doing optimized shrinking and are using R8.
527 nonFinalIds := Bool(a.dexProperties.Optimize.Optimized_shrink_resources) && a.dexer.effectiveOptimizeEnabled()
Alixf7a10272023-09-27 16:47:56 +0000528 a.aapt.buildActions(ctx,
529 aaptBuildActionOptions{
Jihoon Kang84b25892023-12-01 22:01:06 +0000530 sdkContext: android.SdkContext(a),
531 classLoaderContexts: a.classLoaderContexts,
532 excludedLibs: a.usesLibraryProperties.Exclude_uses_libs,
533 enforceDefaultTargetSdkVersion: a.enforceDefaultTargetSdkVersion(),
Rico Winda2fa2632024-03-13 13:09:17 +0100534 forceNonFinalResourceIDs: nonFinalIds,
Jihoon Kang84b25892023-12-01 22:01:06 +0000535 extraLinkFlags: aaptLinkFlags,
Jihoon Kang9049c272024-03-19 21:57:36 +0000536 aconfigTextFiles: getAconfigFilePaths(ctx),
Alixf7a10272023-09-27 16:47:56 +0000537 },
538 )
Colin Cross30e076a2015-04-13 13:58:27 -0700539
Colin Cross46c9b8b2017-06-22 16:51:17 -0700540 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700541 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800542}
Colin Cross30e076a2015-04-13 13:58:27 -0700543
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800544func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700545 var staticLibProguardFlagFiles android.Paths
546 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800547 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -0400548 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.UnconditionallyExportedProguardFlags.ToList()...)
549 if ctx.OtherModuleDependencyTag(m) == staticLibTag {
550 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.ProguardFlagsFiles.ToList()...)
Colin Cross89c31582018-04-30 15:55:11 -0700551 }
552 })
553
554 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
555
Colin Cross312634e2023-11-21 15:13:56 -0800556 a.Module.extraProguardFlagsFiles = append(a.Module.extraProguardFlagsFiles, staticLibProguardFlagFiles...)
Rico Winda2fa2632024-03-13 13:09:17 +0100557 if !Bool(a.dexProperties.Optimize.Optimized_shrink_resources) {
558 // When using the optimized shrinking the R8 enqueuer will traverse the xml files that become
559 // live for code references and (transitively) mark these as live.
560 // In this case we explicitly don't wan't the aapt2 generated keep files (which would keep the now
561 // dead code alive)
562 a.Module.extraProguardFlagsFiles = append(a.Module.extraProguardFlagsFiles, a.proguardOptionsFile)
563 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800564}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800565
Colin Cross403cc152020-07-06 14:15:24 -0700566func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
Colin Cross43f08db2018-11-12 10:13:39 -0800567 var installDir string
568 if ctx.ModuleName() == "framework-res" {
569 // framework-res.apk is installed as system/framework/framework-res.apk
570 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900571 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800572 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800573 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800574 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800575 }
Colin Cross403cc152020-07-06 14:15:24 -0700576
577 return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
578}
579
Rico Wind98e7fa82023-11-27 09:44:03 +0100580func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) (android.Path, android.Path) {
Colin Cross403cc152020-07-06 14:15:24 -0700581 a.dexpreopter.installPath = a.installPath(ctx)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000582 a.dexpreopter.isApp = true
Liz Kammera7a64f32020-07-09 15:16:41 -0700583 if a.dexProperties.Uncompress_dex == nil {
David Srbeckye033cba2020-05-20 22:20:28 +0100584 // If the value was not force-set by the user, use reasonable default based on the module.
Liz Kammera7a64f32020-07-09 15:16:41 -0700585 a.dexProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
David Srbeckye033cba2020-05-20 22:20:28 +0100586 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700587 a.dexpreopter.uncompressedDex = *a.dexProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700588 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100589 a.dexpreopter.classLoaderContexts = a.classLoaderContexts
Colin Cross50ddcc42019-05-16 12:28:22 -0700590 a.dexpreopter.manifestFile = a.mergedManifestFile
Colin Crossfa9bfcd2021-11-10 16:42:38 -0800591 a.dexpreopter.preventInstall = a.appProperties.PreventInstall
Colin Cross50ddcc42019-05-16 12:28:22 -0700592
Rico Wind98e7fa82023-11-27 09:44:03 +0100593 var packageResources = a.exportPackage
594
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800595 if ctx.ModuleName() != "framework-res" {
Rico Winda2fa2632024-03-13 13:09:17 +0100596 if a.dexProperties.resourceShrinkingEnabled() {
Rico Wind98e7fa82023-11-27 09:44:03 +0100597 protoFile := android.PathForModuleOut(ctx, packageResources.Base()+".proto.apk")
598 aapt2Convert(ctx, protoFile, packageResources, "proto")
599 a.dexer.resourcesInput = android.OptionalPathForPath(protoFile)
600 }
601
Colin Cross4eae06d2023-06-20 22:40:02 -0700602 var extraSrcJars android.Paths
603 var extraClasspathJars android.Paths
604 var extraCombinedJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800605 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700606 // When building an app with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox has already
607 // created R.class files that provide IDs for resources in busybox/R.jar. Pass that file in the
608 // classpath when compiling everything else, and add it to the final classes jar.
609 extraClasspathJars = android.Paths{a.aapt.rJar}
610 extraCombinedJars = android.Paths{a.aapt.rJar}
611 } else {
612 // When building an app without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
613 // R.java files for the app's package and the packages from all transitive static android_library
614 // dependencies. Compile the srcjar alongside the rest of the sources.
615 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
616 }
617
618 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Rico Winda2fa2632024-03-13 13:09:17 +0100619 if a.dexProperties.resourceShrinkingEnabled() {
Rico Wind98e7fa82023-11-27 09:44:03 +0100620 binaryResources := android.PathForModuleOut(ctx, packageResources.Base()+".binary.out.apk")
621 aapt2Convert(ctx, binaryResources, a.dexer.resourcesOutput.Path(), "binary")
622 packageResources = binaryResources
623 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800624 }
Colin Cross30e076a2015-04-13 13:58:27 -0700625
Rico Wind98e7fa82023-11-27 09:44:03 +0100626 return a.dexJarFile.PathOrNil(), packageResources
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800627}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800628
Sam Delmerico82602492022-06-10 17:05:42 +0000629func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, prebuiltJniPackages android.Paths, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700630 var jniJarFile android.WritablePath
Sam Delmerico82602492022-06-10 17:05:42 +0000631 if len(jniLibs) > 0 || len(prebuiltJniPackages) > 0 {
Colin Cross403cc152020-07-06 14:15:24 -0700632 a.jniLibs = jniLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700633 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700634 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Colin Crossc68db4b2021-11-11 18:59:15 -0800635 a.installPathForJNISymbols = a.installPath(ctx)
Sam Delmerico82602492022-06-10 17:05:42 +0000636 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, prebuiltJniPackages, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700637 for _, jni := range jniLibs {
638 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700639 // Only collect coverage for the first target arch if this is a multilib target.
640 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
641 // data file path collisions since the current coverage file path format doesn't contain
642 // arch-related strings. This is fine for now though; the code coverage team doesn't use
643 // multi-arch targets such as test_suite_* for coverage collections yet.
644 //
645 // Work with the team to come up with a new format that handles multilib modules properly
646 // and change this.
647 if len(ctx.Config().Targets[android.Android]) == 1 ||
Jaewoong Jung642916f2020-10-09 17:25:15 -0700648 ctx.Config().AndroidFirstDeviceTarget.Arch.ArchType == jni.target.Arch.ArchType {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700649 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
650 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700651 }
652 }
Colin Cross403cc152020-07-06 14:15:24 -0700653 a.embeddedJniLibs = true
Colin Crossa4f08812018-10-02 22:03:40 -0700654 }
655 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800656 return jniJarFile
657}
Colin Crossa4f08812018-10-02 22:03:40 -0700658
Colin Cross403cc152020-07-06 14:15:24 -0700659func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
660 var jniSymbols android.RuleBuilderInstalls
661 for _, jniLib := range a.jniLibs {
662 if jniLib.unstrippedFile != nil {
663 jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
664 From: jniLib.unstrippedFile,
665 To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
666 })
667 }
668 }
669 return jniSymbols
670}
671
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700672// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
673// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
Colin Crossbc2c8a72022-09-14 12:45:42 -0700674func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate,
675 ctx android.ModuleContext) (mainCertificate Certificate, allCertificates []Certificate) {
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700676 if android.SrcIsModule(certPropValue) == "" {
677 var mainCert Certificate
678 if certPropValue != "" {
679 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
680 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800681 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
682 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700683 }
684 } else {
685 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800686 mainCert = Certificate{
687 Pem: pem,
688 Key: key,
689 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700690 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700691 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700692 }
693
Colin Crossbc2c8a72022-09-14 12:45:42 -0700694 if len(certificates) > 0 {
695 mainCertificate = certificates[0]
696 } else {
697 // This can be reached with an empty certificate list if AllowMissingDependencies is set
698 // and the certificate property for this module is a module reference to a missing module.
699 if !ctx.Config().AllowMissingDependencies() && len(ctx.GetMissingDependencies()) > 0 {
700 panic("Should only get here if AllowMissingDependencies set and there are missing dependencies")
701 }
702 // Set a certificate to avoid panics later when accessing it.
703 mainCertificate = Certificate{
704 Key: android.PathForModuleOut(ctx, "missing.pk8"),
Colin Crossa54f4b52022-11-21 04:35:53 +0000705 Pem: android.PathForModuleOut(ctx, "missing.x509.pem"),
Colin Crossbc2c8a72022-09-14 12:45:42 -0700706 }
707 }
708
Zyan Wub7550aa2023-05-18 15:46:31 +0800709 if !m.Platform() {
710 certPath := mainCertificate.Pem.String()
711 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
712 if strings.HasPrefix(certPath, systemCertPath) {
713 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
714 allowed := ctx.Config().EnforceSystemCertificateAllowList()
715
716 if enforceSystemCert && !inList(m.Name(), allowed) {
717 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
718 }
719 }
720 }
721
Colin Crossbc2c8a72022-09-14 12:45:42 -0700722 return mainCertificate, certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800723}
724
Jooyung Han39ee1192020-03-23 20:21:11 +0900725func (a *AndroidApp) InstallApkName() string {
726 return a.installApkName
727}
728
Sam Delmerico15809f82023-05-15 17:21:47 -0400729func (a *AndroidApp) createPrivappAllowlist(ctx android.ModuleContext) android.Path {
Andrei Onea580636b2022-08-17 16:53:46 +0000730 if a.appProperties.Privapp_allowlist == nil {
731 return nil
732 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400733
734 isOverrideApp := a.GetOverriddenBy() != ""
735 if !isOverrideApp {
736 // if this is not an override, we don't need to rewrite the existing privapp allowlist
737 return android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist)
738 }
739
Andrei Onea580636b2022-08-17 16:53:46 +0000740 if a.overridableAppProperties.Package_name == nil {
741 ctx.PropertyErrorf("privapp_allowlist", "package_name must be set to use privapp_allowlist")
742 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400743
Andrei Onea580636b2022-08-17 16:53:46 +0000744 packageName := *a.overridableAppProperties.Package_name
745 fileName := "privapp_allowlist_" + packageName + ".xml"
746 outPath := android.PathForModuleOut(ctx, fileName).OutputPath
747 ctx.Build(pctx, android.BuildParams{
748 Rule: modifyAllowlist,
749 Input: android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist),
750 Output: outPath,
751 Args: map[string]string{
752 "packageName": packageName,
753 },
754 })
755 return &outPath
756}
757
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800758func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700759 var apkDeps android.Paths
760
Colin Crossff694a82023-12-13 15:54:49 -0800761 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
762 if !apexInfo.IsForPlatform() {
Colin Cross56a83212020-09-15 18:30:11 -0700763 a.hideApexVariantFromMake = true
764 }
765
Jeongik Cha538c0d02019-07-11 15:54:27 +0900766 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
767 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
768
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000769 // Unlike installApkName, a.stem should respect base module name for override_android_app.
770 // Therefore, use ctx.ModuleName() instead of a.Name().
yangbill2af0b6e2024-03-15 09:29:29 +0000771 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000772
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800773 // Check if the install APK name needs to be overridden.
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000774 // Both android_app and override_android_app module are expected to possess
775 // its module bound apk path. However, override_android_app inherits ctx.ModuleName()
776 // from the base module. Therefore, use a.Name() which represents
777 // the module name for both android_app and override_android_app.
778 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(
yangbill2af0b6e2024-03-15 09:29:29 +0000779 proptools.StringDefault(a.overridableProperties.Stem, a.Name()))
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800780
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700781 if ctx.ModuleName() == "framework-res" {
782 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700783 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900784 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700785 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
786 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800787 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700788 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700789 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700790 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700791 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700792
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100793 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000794 if a.usesLibrary.shouldDisableDexpreopt {
795 a.dexpreopter.disableDexpreopt()
796 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000797
Colin Cross61fb62e2022-06-23 10:46:28 -0700798 var noticeAssetPath android.WritablePath
799 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
800 // The rule to create the notice file can't be generated yet, as the final output path
801 // for the apk isn't known yet. Add the path where the notice file will be generated to the
802 // aapt rules now before calling aaptBuildActions, the rule to create the notice file will
803 // be generated later.
804 noticeAssetPath = android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
805 a.aapt.noticeFile = android.OptionalPathForPath(noticeAssetPath)
806 }
807
Harshit Mahajan8f202ad2023-01-09 20:45:55 +0000808 // For apps targeting latest target_sdk_version
809 if Bool(a.appProperties.Enforce_default_target_sdk_version) {
810 a.SetEnforceDefaultTargetSdkVersion(true)
811 }
812
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800813 // Process all building blocks, from AAPT to certificates.
814 a.aaptBuildActions(ctx)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100815 // The decision to enforce <uses-library> checks is made before adding implicit SDK libraries.
816 a.usesLibrary.freezeEnforceUsesLibraries()
817
818 // Add implicit SDK libraries to <uses-library> list.
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100819 requiredUsesLibs, optionalUsesLibs := a.classLoaderContexts.UsesLibs()
820 for _, usesLib := range requiredUsesLibs {
821 a.usesLibrary.addLib(usesLib, false)
822 }
823 for _, usesLib := range optionalUsesLibs {
824 a.usesLibrary.addLib(usesLib, true)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100825 }
826
827 // Check that the <uses-library> list is coherent with the manifest.
Colin Cross50ddcc42019-05-16 12:28:22 -0700828 if a.usesLibrary.enforceUsesLibraries() {
829 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
830 apkDeps = append(apkDeps, manifestCheckFile)
831 }
832
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800833 a.proguardBuildActions(ctx)
834
Colin Cross014489c2020-06-02 20:09:13 -0700835 a.linter.mergedManifest = a.aapt.mergedManifestFile
836 a.linter.manifest = a.aapt.manifestPath
837 a.linter.resources = a.aapt.resourceFiles
Colin Crossc0efd1d2020-07-03 11:56:24 -0700838 a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
Colin Cross014489c2020-06-02 20:09:13 -0700839
Rico Wind98e7fa82023-11-27 09:44:03 +0100840 dexJarFile, packageResources := a.dexBuildActions(ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800841
Colin Crossbc2c8a72022-09-14 12:45:42 -0700842 jniLibs, prebuiltJniPackages, certificates := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Sam Delmerico82602492022-06-10 17:05:42 +0000843 jniJarFile := a.jniBuildActions(jniLibs, prebuiltJniPackages, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800844
845 if ctx.Failed() {
846 return
847 }
848
Colin Crossbc2c8a72022-09-14 12:45:42 -0700849 a.certificate, certificates = processMainCert(a.ModuleBase, a.getCertString(ctx), certificates, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800850
851 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800852 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700853 v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
854 var v4SignatureFile android.WritablePath = nil
855 if v4SigningRequested {
856 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
857 }
Liz Kammere2b27f42020-05-07 13:24:05 -0700858 var lineageFile android.Path
859 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
860 lineageFile = android.PathForModuleSrc(ctx, lineage)
861 }
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400862 rotationMinSdkVersion := String(a.overridableAppProperties.RotationMinSdkVersion)
863
Rico Wind98e7fa82023-11-27 09:44:03 +0100864 CreateAndSignAppPackage(ctx, packageFile, packageResources, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800865 a.outputFile = packageFile
Songchun Fan17d69e32020-03-24 20:32:24 -0700866 if v4SigningRequested {
867 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
868 }
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800869
Colin Cross61fb62e2022-06-23 10:46:28 -0700870 if a.aapt.noticeFile.Valid() {
871 // Generating the notice file rule has to be here after a.outputFile is known.
Bob Badoureef4c1c2022-05-16 12:20:04 -0700872 noticeFile := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700873 android.BuildNoticeHtmlOutputFromLicenseMetadata(
874 ctx, noticeFile, "", "",
875 []string{
876 a.installDir.String() + "/",
877 android.PathForModuleInstall(ctx).String() + "/",
878 a.outputFile.String(),
879 })
Bob Badoureef4c1c2022-05-16 12:20:04 -0700880 builder := android.NewRuleBuilder(pctx, ctx)
881 builder.Command().Text("cp").
882 Input(noticeFile).
883 Output(noticeAssetPath)
884 builder.Build("notice_dir", "Building notice dir")
Bob Badoureef4c1c2022-05-16 12:20:04 -0700885 }
886
Colin Crosse560c4a2019-03-19 16:03:11 -0700887 for _, split := range a.aapt.splits {
888 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800889 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700890 if v4SigningRequested {
891 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
892 }
Rico Wind98e7fa82023-11-27 09:44:03 +0100893 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Crosse560c4a2019-03-19 16:03:11 -0700894 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
Songchun Fan17d69e32020-03-24 20:32:24 -0700895 if v4SigningRequested {
896 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
897 }
Colin Crosse560c4a2019-03-19 16:03:11 -0700898 }
899
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800900 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700901 bundleFile := android.PathForModuleOut(ctx, "base.zip")
902 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
903 a.bundleFile = bundleFile
904
Andrei Onea580636b2022-08-17 16:53:46 +0000905 allowlist := a.createPrivappAllowlist(ctx)
906 if allowlist != nil {
907 a.privAppAllowlist = android.OptionalPathForPath(allowlist)
908 }
909
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800910 // Install the app package.
Andrei Onea580636b2022-08-17 16:53:46 +0000911 shouldInstallAppPackage := (Bool(a.Module.properties.Installable) || ctx.Host()) && apexInfo.IsForPlatform() && !a.appProperties.PreventInstall
912 if shouldInstallAppPackage {
Sam Delmericob1daccd2023-05-25 14:45:30 -0400913 if a.privAppAllowlist.Valid() {
Anton Hansson0e486a42023-06-01 16:38:35 +0000914 allowlistInstallPath := android.PathForModuleInstall(ctx, "etc", "permissions")
915 allowlistInstallFilename := a.installApkName + ".xml"
916 ctx.InstallFile(allowlistInstallPath, allowlistInstallFilename, a.privAppAllowlist.Path())
Sam Delmericob1daccd2023-05-25 14:45:30 -0400917 }
918
Colin Cross09ad3a62023-11-15 12:29:33 -0800919 var extraInstalledPaths android.InstallPaths
Jiyong Park8ba50f92019-11-13 15:01:01 +0900920 for _, extra := range a.extraOutputFiles {
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700921 installed := ctx.InstallFile(a.installDir, extra.Base(), extra)
922 extraInstalledPaths = append(extraInstalledPaths, installed)
Jiyong Park8ba50f92019-11-13 15:01:01 +0900923 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700924 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile, extraInstalledPaths...)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800925 }
Artur Satayev1111b842020-04-27 19:05:28 +0100926
927 a.buildAppDependencyInfo(ctx)
Spandan Das3490dfd2024-03-11 21:37:25 +0000928
929 providePrebuiltInfo(ctx,
930 prebuiltInfoProps{
931 baseModuleName: a.BaseModuleName(),
932 isPrebuilt: false,
933 },
934 )
Colin Cross30e076a2015-04-13 13:58:27 -0700935}
936
Colin Crossc2d24052020-05-13 11:05:02 -0700937type appDepsInterface interface {
Jiyong Park92315372021-04-02 08:45:46 +0900938 SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000939 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Colin Crossc2d24052020-05-13 11:05:02 -0700940 RequiresStableAPIs(ctx android.BaseModuleContext) bool
941}
942
943func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
944 shouldCollectRecursiveNativeDeps bool,
Sam Delmerico82602492022-06-10 17:05:42 +0000945 checkNativeSdkVersion bool) ([]jniLib, android.Paths, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700946
Colin Crossc2d24052020-05-13 11:05:02 -0700947 if checkNativeSdkVersion {
Jiyong Park92315372021-04-02 08:45:46 +0900948 checkNativeSdkVersion = app.SdkVersion(ctx).Specified() &&
949 app.SdkVersion(ctx).Kind != android.SdkCorePlatform && !app.RequiresStableAPIs(ctx)
Colin Crossc2d24052020-05-13 11:05:02 -0700950 }
Makoto Onuki2ca84272024-02-10 00:15:21 +0000951 jniLib, prebuiltJniPackages := collectJniDeps(ctx, shouldCollectRecursiveNativeDeps,
952 checkNativeSdkVersion, func(dep cc.LinkableInterface) bool {
953 return !dep.IsNdk(ctx.Config()) && !dep.IsStubs()
954 })
955
956 var certificates []Certificate
957
958 ctx.VisitDirectDeps(func(module android.Module) {
959 otherName := ctx.OtherModuleName(module)
960 tag := ctx.OtherModuleDependencyTag(module)
961
962 if tag == certificateTag {
963 if dep, ok := module.(*AndroidAppCertificate); ok {
964 certificates = append(certificates, dep.Certificate)
965 } else {
966 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
967 }
968 }
969 })
970 return jniLib, prebuiltJniPackages, certificates
971}
972
973func collectJniDeps(ctx android.ModuleContext,
974 shouldCollectRecursiveNativeDeps bool,
975 checkNativeSdkVersion bool,
976 filter func(cc.LinkableInterface) bool) ([]jniLib, android.Paths) {
977 var jniLibs []jniLib
978 var prebuiltJniPackages android.Paths
979 seenModulePaths := make(map[string]bool)
Colin Crossc2d24052020-05-13 11:05:02 -0700980
Peter Collingbournead84f972019-12-17 16:46:18 -0800981 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700982 otherName := ctx.OtherModuleName(module)
983 tag := ctx.OtherModuleDependencyTag(module)
984
Colin Crossf0913fb2020-07-29 12:59:39 -0700985 if IsJniDepTag(tag) || cc.IsSharedDepTag(tag) {
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400986 if dep, ok := module.(cc.LinkableInterface); ok {
Makoto Onuki2ca84272024-02-10 00:15:21 +0000987 if filter != nil && !filter(dep) {
Peter Collingbournead84f972019-12-17 16:46:18 -0800988 return false
989 }
990
Colin Crossa4f08812018-10-02 22:03:40 -0700991 lib := dep.OutputFile()
992 if lib.Valid() {
Cole Faust64cb7c92021-09-14 17:32:49 -0700993 path := lib.Path()
994 if seenModulePaths[path.String()] {
995 return false
996 }
997 seenModulePaths[path.String()] = true
998
999 if checkNativeSdkVersion && dep.SdkVersion() == "" {
1000 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
1001 otherName)
1002 }
1003
Colin Crossa4f08812018-10-02 22:03:40 -07001004 jniLibs = append(jniLibs, jniLib{
Colin Cross403cc152020-07-06 14:15:24 -07001005 name: ctx.OtherModuleName(module),
1006 path: path,
1007 target: module.Target(),
1008 coverageFile: dep.CoverageOutputFile(),
1009 unstrippedFile: dep.UnstrippedOutputFile(),
Jihoon Kangf78a8902022-09-01 22:47:07 +00001010 partition: dep.Partition(),
Colin Crossa4f08812018-10-02 22:03:40 -07001011 })
Colin Crossdd5261c2022-12-19 12:26:43 -08001012 } else if ctx.Config().AllowMissingDependencies() {
1013 ctx.AddMissingDependencies([]string{otherName})
Colin Crossa4f08812018-10-02 22:03:40 -07001014 } else {
1015 ctx.ModuleErrorf("dependency %q missing output file", otherName)
1016 }
1017 } else {
1018 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -07001019 }
Peter Collingbournead84f972019-12-17 16:46:18 -08001020
1021 return shouldCollectRecursiveNativeDeps
1022 }
1023
Colin Cross313aa542023-12-13 13:47:44 -08001024 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +00001025 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
1026 }
1027
Peter Collingbournead84f972019-12-17 16:46:18 -08001028 return false
Colin Crossa4f08812018-10-02 22:03:40 -07001029 })
1030
Makoto Onuki2ca84272024-02-10 00:15:21 +00001031 return jniLibs, prebuiltJniPackages
Colin Crossa4f08812018-10-02 22:03:40 -07001032}
1033
Jooyung Han749dc692020-04-15 11:03:39 +09001034func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +01001035 ctx.WalkDeps(func(child, parent android.Module) bool {
1036 isExternal := !a.DepIsInSameApex(ctx, child)
1037 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +09001038 if !do(ctx, parent, am, isExternal) {
1039 return false
1040 }
Artur Satayev1111b842020-04-27 19:05:28 +01001041 }
1042 return !isExternal
1043 })
1044}
1045
1046func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
1047 if ctx.Host() {
1048 return
1049 }
1050
1051 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001052 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +01001053 depName := to.Name()
Artur Satayev533b98c2021-03-11 18:03:42 +00001054
1055 // Skip dependencies that are only available to APEXes; they are developed with updatability
1056 // in mind and don't need manual approval.
1057 if to.(android.ApexModule).NotAvailableForPlatform() {
1058 return true
1059 }
1060
Artur Satayev1111b842020-04-27 19:05:28 +01001061 if info, exist := depsInfo[depName]; exist {
1062 info.From = append(info.From, from.Name())
1063 info.IsExternal = info.IsExternal && externalDep
1064 depsInfo[depName] = info
1065 } else {
1066 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001067 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001068 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001069 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001070 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1071 toMinSdkVersion = v.String()
Artur Satayev1111b842020-04-27 19:05:28 +01001072 }
Jiyong Park92315372021-04-02 08:45:46 +09001073 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1074 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1075 // string
1076 if v := m.MinSdkVersion(); v != "" {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001077 toMinSdkVersion = v
1078 }
Artur Satayev1111b842020-04-27 19:05:28 +01001079 }
1080 depsInfo[depName] = android.ApexModuleDepInfo{
1081 To: depName,
1082 From: []string{from.Name()},
1083 IsExternal: externalDep,
1084 MinSdkVersion: toMinSdkVersion,
1085 }
1086 }
Jooyung Han749dc692020-04-15 11:03:39 +09001087 return true
Artur Satayev1111b842020-04-27 19:05:28 +01001088 })
1089
Jiyong Park92315372021-04-02 08:45:46 +09001090 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depsInfo)
Artur Satayev1111b842020-04-27 19:05:28 +01001091}
1092
Harshit Mahajan5b8b7302022-06-10 11:24:05 +00001093func (a *AndroidApp) enforceDefaultTargetSdkVersion() bool {
1094 return a.appProperties.EnforceDefaultTargetSdkVersion
1095}
1096
1097func (a *AndroidApp) SetEnforceDefaultTargetSdkVersion(val bool) {
1098 a.appProperties.EnforceDefaultTargetSdkVersion = val
1099}
1100
Artur Satayev849f8442020-04-28 14:57:42 +01001101func (a *AndroidApp) Updatable() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001102 return Bool(a.appProperties.Updatable)
Artur Satayev849f8442020-04-28 14:57:42 +01001103}
1104
Spandan Das42e89502022-05-06 22:12:55 +00001105func (a *AndroidApp) SetUpdatable(val bool) {
1106 a.appProperties.Updatable = &val
1107}
1108
Colin Cross0ea8ba82019-06-06 14:33:29 -07001109func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001110 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
1111 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001112 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001113 }
Jaewoong Jung525443a2019-02-28 15:35:54 -08001114 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001115}
1116
Jiyong Park0f80c182020-01-31 02:49:53 +09001117func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1118 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
1119 return true
1120 }
1121 return a.Library.DepIsInSameApex(ctx, dep)
1122}
1123
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001124// For OutputFileProducer interface
1125func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
1126 switch tag {
Jared Duke34b080d2023-03-30 16:40:24 -07001127 // In some instances, it can be useful to reference the aapt-generated flags from another
1128 // target, e.g., system server implements services declared in the framework-res manifest.
1129 case ".aapt.proguardOptionsFile":
1130 return []android.Path{a.proguardOptionsFile}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001131 case ".aapt.srcjar":
Colin Crossf3b7bad2023-08-02 15:49:00 -07001132 if a.aaptSrcJar != nil {
1133 return []android.Path{a.aaptSrcJar}, nil
1134 }
1135 case ".aapt.jar":
1136 if a.rJar != nil {
1137 return []android.Path{a.rJar}, nil
1138 }
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001139 case ".apk":
1140 return []android.Path{a.outputFile}, nil
Anton Hansson092aca42020-08-13 19:37:22 +01001141 case ".export-package.apk":
1142 return []android.Path{a.exportPackage}, nil
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001143 case ".manifest.xml":
1144 return []android.Path{a.aapt.manifestPath}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001145 }
1146 return a.Library.OutputFiles(tag)
1147}
1148
Jiyong Parkf7487312019-10-17 12:54:30 +09001149func (a *AndroidApp) Privileged() bool {
1150 return Bool(a.appProperties.Privileged)
1151}
1152
Colin Crossf5f4ad32024-01-19 15:41:48 -08001153func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.IncomingTransitionContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001154 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001155}
1156
Ivan Lozanod7586b62021-04-01 09:49:36 -04001157func (a *AndroidApp) SetPreventInstall() {
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001158 a.appProperties.PreventInstall = true
1159}
1160
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001161func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
1162 a.appProperties.IsCoverageVariant = coverage
1163}
1164
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001165func (a *AndroidApp) EnableCoverageIfNeeded() {}
1166
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001167var _ cc.Coverage = (*AndroidApp)(nil)
1168
Colin Cross95b53b82023-10-17 13:21:02 -07001169func (a *AndroidApp) IDEInfo(dpInfo *android.IdeInfo) {
1170 a.Library.IDEInfo(dpInfo)
1171 a.aapt.IDEInfo(dpInfo)
1172}
1173
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001174func (a *AndroidApp) productCharacteristicsRROPackageName() string {
1175 return proptools.String(a.appProperties.ProductCharacteristicsRROPackageName)
1176}
1177
1178func (a *AndroidApp) productCharacteristicsRROManifestModuleName() string {
1179 return proptools.String(a.appProperties.ProductCharacteristicsRROManifestModuleName)
1180}
1181
Colin Cross1b16b0e2019-02-12 14:41:32 -08001182// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -07001183func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -07001184 module := &AndroidApp{}
1185
Liz Kammera7a64f32020-07-09 15:16:41 -07001186 module.Module.dexProperties.Optimize.EnabledByDefault = true
1187 module.Module.dexProperties.Optimize.Shrink = proptools.BoolPtr(true)
Jared Dukeaa88b3d2023-08-29 17:07:20 +00001188 module.Module.dexProperties.Optimize.Proguard_compatibility = proptools.BoolPtr(false)
Colin Cross66dbc0b2017-12-28 12:23:20 -08001189
Colin Crossae5caf52018-05-22 11:11:52 -07001190 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001191 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001192 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001193
Colin Crossce6734e2020-06-15 16:09:53 -07001194 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -07001195 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -07001196 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001197 &module.appProperties,
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001198 &module.overridableAppProperties,
1199 &module.Library.sourceProperties)
Colin Cross36242852017-06-23 15:06:31 -07001200
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001201 module.usesLibrary.enforce = true
1202
Colin Crossa4f08812018-10-02 22:03:40 -07001203 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1204 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001205 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001206 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001207
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001208 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1209 a := ctx.Module().(*AndroidApp)
1210
1211 characteristics := ctx.Config().ProductAAPTCharacteristics()
1212 if characteristics == "default" || characteristics == "" {
1213 module.appProperties.Generate_product_characteristics_rro = nil
1214 // no need to create RRO
1215 return
1216 }
1217
1218 if !proptools.Bool(module.appProperties.Generate_product_characteristics_rro) {
1219 return
1220 }
1221
1222 rroPackageName := a.Name() + "__" + strings.ReplaceAll(characteristics, ",", "_") + "__auto_generated_characteristics_rro"
1223 rroManifestName := rroPackageName + "_manifest"
1224
1225 a.appProperties.ProductCharacteristicsRROPackageName = proptools.StringPtr(rroPackageName)
1226 a.appProperties.ProductCharacteristicsRROManifestModuleName = proptools.StringPtr(rroManifestName)
1227
1228 rroManifestProperties := struct {
1229 Name *string
1230 Tools []string
1231 Out []string
1232 Srcs []string
1233 Cmd *string
1234 }{
1235 Name: proptools.StringPtr(rroManifestName),
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001236 Tools: []string{"characteristics_rro_generator", "aapt2"},
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001237 Out: []string{"AndroidManifest.xml"},
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001238 Srcs: []string{":" + a.Name() + "{.apk}"},
1239 Cmd: proptools.StringPtr("$(location characteristics_rro_generator) $$($(location aapt2) dump packagename $(in)) $(out)"),
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001240 }
1241 ctx.CreateModule(genrule.GenRuleFactory, &rroManifestProperties)
1242
1243 rroProperties := struct {
1244 Name *string
1245 Filter_product *string
1246 Aaptflags []string
1247 Manifest *string
1248 Resource_dirs []string
1249 }{
1250 Name: proptools.StringPtr(rroPackageName),
1251 Filter_product: proptools.StringPtr(characteristics),
1252 Aaptflags: []string{"--auto-add-overlay"},
1253 Manifest: proptools.StringPtr(":" + rroManifestName),
1254 Resource_dirs: a.aaptProperties.Resource_dirs,
1255 }
1256 ctx.CreateModule(RuntimeResourceOverlayFactory, &rroProperties)
1257 })
1258
Colin Cross36242852017-06-23 15:06:31 -07001259 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001260}
Colin Crossae5caf52018-05-22 11:11:52 -07001261
Alix96ea88452023-08-31 15:48:23 +00001262// A dictionary of values to be overridden in the manifest.
1263type Manifest_values struct {
1264 // Overrides the value of package_name in the manifest
1265 ApplicationId *string
1266}
1267
Colin Crossae5caf52018-05-22 11:11:52 -07001268type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001269 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001270 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001271
Seth Moorec6f4b532023-02-02 13:22:26 -08001272 // If specified, the instrumentation target package name in the manifest is overwritten by it.
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001273 Instrumentation_target_package *string
Seth Moorec6f4b532023-02-02 13:22:26 -08001274
1275 // If specified, the mainline module package name in the test config is overwritten by it.
1276 Mainline_package_name *string
Alix96ea88452023-08-31 15:48:23 +00001277
1278 Manifest_values Manifest_values
Colin Crossae5caf52018-05-22 11:11:52 -07001279}
1280
1281type AndroidTest struct {
1282 AndroidApp
1283
1284 appTestProperties appTestProperties
1285
1286 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001287
Dan Shi95d19422020-08-15 12:24:26 -07001288 testConfig android.Path
1289 extraTestConfigs android.Paths
1290 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001291}
1292
Jaewoong Jung0949f312019-09-11 10:25:18 -07001293func (a *AndroidTest) InstallInTestcases() bool {
1294 return true
1295}
1296
Spandan Das9f7ae7f2022-07-25 00:34:18 +00001297type androidTestApp interface {
1298 includedInTestSuite(searchPrefix string) bool
1299}
1300
1301func (a *AndroidTest) includedInTestSuite(searchPrefix string) bool {
1302 return android.PrefixInList(a.testProperties.Test_suites, searchPrefix)
1303}
1304
1305func (a *AndroidTestHelperApp) includedInTestSuite(searchPrefix string) bool {
1306 return android.PrefixInList(a.appTestHelperAppProperties.Test_suites, searchPrefix)
1307}
1308
Colin Crossae5caf52018-05-22 11:11:52 -07001309func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001310 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001311 if a.appTestProperties.Instrumentation_target_package != nil {
1312 a.additionalAaptFlags = append(a.additionalAaptFlags,
1313 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1314 } else if a.appTestProperties.Instrumentation_for != nil {
1315 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001316 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1317 if overridden {
1318 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1319 }
1320 }
Alix96ea88452023-08-31 15:48:23 +00001321 applicationId := a.appTestProperties.Manifest_values.ApplicationId
1322 if applicationId != nil {
1323 if a.overridableAppProperties.Package_name != nil {
1324 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
1325 }
1326 a.aapt.manifestValues.applicationId = *applicationId
1327 }
Colin Crossae5caf52018-05-22 11:11:52 -07001328 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001329
easoncylee5bcff5d2020-04-30 14:57:06 +08001330 for _, module := range a.testProperties.Test_mainline_modules {
1331 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1332 }
1333
Jaewoong Jung39982342020-01-14 10:27:18 -08001334 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001335 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001336 a.testConfig = a.FixTestConfig(ctx, testConfig)
Dan Shi95d19422020-08-15 12:24:26 -07001337 a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
Colin Cross8a497952019-03-05 22:25:09 -08001338 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross40213022023-12-13 15:19:49 -08001339 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Ronald Braunsteinfce43162024-02-02 12:37:20 -08001340 android.SetProvider(ctx, tradefed.BaseTestProviderKey, tradefed.BaseTestProviderData{
1341 InstalledFiles: a.data,
1342 OutputFile: a.OutputFile(),
1343 TestConfig: a.testConfig,
1344 HostRequiredModuleNames: a.HostRequiredModuleNames(),
Ronald Braunstein1a6e7c02024-03-14 21:14:39 +00001345 TestSuites: a.testProperties.Test_suites,
1346 IsHost: false,
Ronald Braunsteinfce43162024-02-02 12:37:20 -08001347 })
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001348 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
1349 TestOnly: true,
1350 TopLevelTarget: true,
1351 })
1352
Colin Cross303e21f2018-08-07 16:49:25 -07001353}
1354
Jaewoong Jung39982342020-01-14 10:27:18 -08001355func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1356 if testConfig == nil {
1357 return nil
1358 }
1359
1360 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
Colin Crossf1a035e2020-11-16 17:32:30 -08001361 rule := android.NewRuleBuilder(pctx, ctx)
1362 command := rule.Command().BuiltTool("test_config_fixer").Input(testConfig).Output(fixedConfig)
Jaewoong Jung39982342020-01-14 10:27:18 -08001363 fixNeeded := false
1364
Jooyung Han29e2f6d2022-01-08 12:13:59 +09001365 // Auto-generated test config uses `ModuleName` as the APK name. So fix it if it is not the case.
Jaewoong Jung39982342020-01-14 10:27:18 -08001366 if ctx.ModuleName() != a.installApkName {
1367 fixNeeded = true
1368 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1369 }
1370
1371 if a.overridableAppProperties.Package_name != nil {
1372 fixNeeded = true
1373 command.FlagWithInput("--manifest ", a.manifestPath).
1374 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1375 }
1376
Seth Moorec6f4b532023-02-02 13:22:26 -08001377 if a.appTestProperties.Mainline_package_name != nil {
1378 fixNeeded = true
1379 command.FlagWithArg("--mainline-package-name ", *a.appTestProperties.Mainline_package_name)
1380 }
1381
Jaewoong Jung39982342020-01-14 10:27:18 -08001382 if fixNeeded {
Colin Crossf1a035e2020-11-16 17:32:30 -08001383 rule.Build("fix_test_config", "fix test config")
Jaewoong Jung39982342020-01-14 10:27:18 -08001384 return fixedConfig
1385 }
1386 return testConfig
1387}
1388
Colin Cross303e21f2018-08-07 16:49:25 -07001389func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001390 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001391}
1392
1393func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1394 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001395 if a.appTestProperties.Instrumentation_for != nil {
1396 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1397 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1398 // use instrumentationForTag instead of libTag.
1399 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1400 }
Colin Crossae5caf52018-05-22 11:11:52 -07001401}
1402
Colin Cross1b16b0e2019-02-12 14:41:32 -08001403// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1404// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001405func AndroidTestFactory() android.Module {
1406 module := &AndroidTest{}
1407
Jared Duke63a3da92022-06-02 19:11:14 +00001408 module.Module.dexProperties.Optimize.EnabledByDefault = false
Colin Cross5067db92018-09-17 16:46:35 -07001409
1410 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001411 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001412 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001413 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001414 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001415 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001416 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001417
Colin Crossce6734e2020-06-15 16:09:53 -07001418 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001419 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001420 &module.aaptProperties,
1421 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001422 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001423 &module.overridableAppProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001424 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001425
Colin Crossa4f08812018-10-02 22:03:40 -07001426 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1427 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001428 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jingwen Chene12c0832023-08-25 09:00:16 +00001429
Colin Crossae5caf52018-05-22 11:11:52 -07001430 return module
1431}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001432
Colin Cross252fc6f2018-10-04 15:22:03 -07001433type appTestHelperAppProperties struct {
1434 // list of compatibility suites (for example "cts", "vts") that the module should be
1435 // installed into.
1436 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001437
1438 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1439 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1440 // explicitly.
1441 Auto_gen_config *bool
Colin Crosscfb0f5e2021-09-24 15:47:17 -07001442
1443 // Install the test into a folder named for the module in all test suites.
1444 Per_testcase_directory *bool
Alix96ea88452023-08-31 15:48:23 +00001445
1446 Manifest_values Manifest_values
Colin Cross252fc6f2018-10-04 15:22:03 -07001447}
1448
1449type AndroidTestHelperApp struct {
1450 AndroidApp
1451
1452 appTestHelperAppProperties appTestHelperAppProperties
1453}
1454
Jaewoong Jung326a9412019-11-21 10:41:00 -08001455func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1456 return true
1457}
1458
Colin Cross1b16b0e2019-02-12 14:41:32 -08001459// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1460// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1461// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001462func AndroidTestHelperAppFactory() android.Module {
1463 module := &AndroidTestHelperApp{}
1464
Jared Duke63a3da92022-06-02 19:11:14 +00001465 // TODO(b/192032291): Disable by default after auditing downstream usage.
Liz Kammera7a64f32020-07-09 15:16:41 -07001466 module.Module.dexProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001467
1468 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001469 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001470 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001471 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001472 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross252fc6f2018-10-04 15:22:03 -07001473
Colin Crossce6734e2020-06-15 16:09:53 -07001474 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001475 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001476 &module.aaptProperties,
1477 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001478 &module.appTestHelperAppProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001479 &module.overridableAppProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001480
1481 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1482 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001483 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001484 return module
1485}
1486
Colin Crossbd01e2a2018-10-04 15:21:03 -07001487type AndroidAppCertificate struct {
1488 android.ModuleBase
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001489
Colin Crossbd01e2a2018-10-04 15:21:03 -07001490 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001491 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001492}
1493
1494type AndroidAppCertificateProperties struct {
1495 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1496 Certificate *string
1497}
1498
Colin Cross1b16b0e2019-02-12 14:41:32 -08001499// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1500// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001501func AndroidAppCertificateFactory() android.Module {
1502 module := &AndroidAppCertificate{}
1503 module.AddProperties(&module.properties)
1504 android.InitAndroidModule(module)
1505 return module
1506}
1507
Colin Crossbd01e2a2018-10-04 15:21:03 -07001508func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1509 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001510 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001511 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1512 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001513 }
1514}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001515
1516type OverrideAndroidApp struct {
1517 android.ModuleBase
1518 android.OverrideModuleBase
1519}
1520
Sasha Smundak613cbb12020-06-05 10:27:23 -07001521func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001522 // All the overrides happen in the base module.
1523 // TODO(jungjw): Check the base module type.
1524}
1525
1526// override_android_app is used to create an android_app module based on another android_app by overriding
1527// some of its properties.
1528func OverrideAndroidAppModuleFactory() android.Module {
1529 m := &OverrideAndroidApp{}
Jooyung Han01d80d82022-01-08 12:16:32 +09001530 m.AddProperties(
yangbill2af0b6e2024-03-15 09:29:29 +00001531 &OverridableProperties{},
Jooyung Han01d80d82022-01-08 12:16:32 +09001532 &overridableAppProperties{},
1533 )
Jaewoong Jung525443a2019-02-28 15:35:54 -08001534
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001535 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001536 android.InitOverrideModule(m)
1537 return m
1538}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001539
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001540type OverrideAndroidTest struct {
1541 android.ModuleBase
1542 android.OverrideModuleBase
1543}
1544
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001545func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001546 // All the overrides happen in the base module.
1547 // TODO(jungjw): Check the base module type.
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001548 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
1549 TestOnly: true,
1550 TopLevelTarget: true,
1551 })
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001552}
1553
1554// override_android_test is used to create an android_app module based on another android_test by overriding
1555// some of its properties.
1556func OverrideAndroidTestModuleFactory() android.Module {
1557 m := &OverrideAndroidTest{}
1558 m.AddProperties(&overridableAppProperties{})
1559 m.AddProperties(&appTestProperties{})
1560
1561 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1562 android.InitOverrideModule(m)
1563 return m
1564}
1565
Colin Cross50ddcc42019-05-16 12:28:22 -07001566type UsesLibraryProperties struct {
1567 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1568 Uses_libs []string
1569
1570 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1571 // required=false.
1572 Optional_uses_libs []string
1573
1574 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1575 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1576 Enforce_uses_libs *bool
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001577
Ulya Trafimovich54027b52020-09-09 14:08:23 +01001578 // Optional name of the <uses-library> provided by this module. This is needed for non-SDK
1579 // libraries, because SDK ones are automatically picked up by Soong. The <uses-library> name
1580 // normally is the same as the module name, but there are exceptions.
1581 Provides_uses_lib *string
Paul Duffin06530572022-02-03 17:54:15 +00001582
1583 // A list of shared library names to exclude from the classpath of the APK. Adding a library here
1584 // will prevent it from being used when precompiling the APK and prevent it from being implicitly
1585 // added to the APK's manifest's <uses-library> elements.
1586 //
1587 // Care must be taken when using this as it could result in runtime errors if the APK actually
1588 // uses classes provided by the library and which are not provided in any other way.
1589 //
1590 // This is primarily intended for use by various CTS tests that check the runtime handling of the
1591 // android.test.base shared library (and related libraries) but which depend on some common
1592 // libraries that depend on the android.test.base library. Without this those tests will end up
1593 // with a <uses-library android:name="android.test.base"/> in their manifest which would either
1594 // render the tests worthless (as they would be testing the wrong behavior), or would break the
1595 // test altogether by providing access to classes that the tests were not expecting. Those tests
1596 // provide the android.test.base statically and use jarjar to rename them so they do not collide
1597 // with the classes provided by the android.test.base library.
1598 Exclude_uses_libs []string
Colin Cross50ddcc42019-05-16 12:28:22 -07001599}
1600
1601// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1602// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1603// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1604// with knowledge of their shared libraries.
1605type usesLibrary struct {
1606 usesLibraryProperties UsesLibraryProperties
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001607
1608 // Whether to enforce verify_uses_library check.
1609 enforce bool
Spandan Das0727ba72024-02-13 16:37:43 +00001610
1611 // Whether dexpreopt should be disabled
1612 shouldDisableDexpreopt bool
Colin Cross50ddcc42019-05-16 12:28:22 -07001613}
1614
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001615func (u *usesLibrary) addLib(lib string, optional bool) {
1616 if !android.InList(lib, u.usesLibraryProperties.Uses_libs) && !android.InList(lib, u.usesLibraryProperties.Optional_uses_libs) {
1617 if optional {
1618 u.usesLibraryProperties.Optional_uses_libs = append(u.usesLibraryProperties.Optional_uses_libs, lib)
1619 } else {
1620 u.usesLibraryProperties.Uses_libs = append(u.usesLibraryProperties.Uses_libs, lib)
1621 }
1622 }
1623}
1624
Colin Cross4a80a152022-12-21 21:51:52 -08001625func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, addCompatDeps bool) {
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001626 if !ctx.Config().UnbundledBuild() || ctx.Config().UnbundledBuildImage() {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001627 ctx.AddVariationDependencies(nil, usesLibReqTag, u.usesLibraryProperties.Uses_libs...)
1628 ctx.AddVariationDependencies(nil, usesLibOptTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross4a80a152022-12-21 21:51:52 -08001629 // Only add these extra dependencies if the module is an app that depends on framework
1630 // libs. This avoids creating a cyclic dependency:
Paul Duffin250e6192019-06-07 10:44:37 +01001631 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
Colin Cross4a80a152022-12-21 21:51:52 -08001632 if addCompatDeps {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001633 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1634 // class loader context for dex2oat. Add them as a dependency with a special tag.
1635 ctx.AddVariationDependencies(nil, usesLibCompat29ReqTag, dexpreopt.CompatUsesLibs29...)
1636 ctx.AddVariationDependencies(nil, usesLibCompat28OptTag, dexpreopt.OptionalCompatUsesLibs28...)
1637 ctx.AddVariationDependencies(nil, usesLibCompat30OptTag, dexpreopt.OptionalCompatUsesLibs30...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001638 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001639 } else {
1640 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.usesLibraryProperties.Uses_libs...)
1641 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross50ddcc42019-05-16 12:28:22 -07001642 }
1643}
1644
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001645// presentOptionalUsesLibs returns optional_uses_libs after filtering out libraries that don't exist in the source tree.
Colin Cross50ddcc42019-05-16 12:28:22 -07001646func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001647 optionalUsesLibs := android.FilterListPred(u.usesLibraryProperties.Optional_uses_libs, func(s string) bool {
1648 exists := ctx.OtherModuleExists(s)
Jiakai Zhang48203e32023-06-02 23:42:21 +01001649 if !exists && !android.InList(ctx.ModuleName(), ctx.Config().BuildWarningBadOptionalUsesLibsAllowlist()) {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001650 fmt.Printf("Warning: Module '%s' depends on non-existing optional_uses_libs '%s'\n", ctx.ModuleName(), s)
1651 }
1652 return exists
1653 })
Colin Cross50ddcc42019-05-16 12:28:22 -07001654 return optionalUsesLibs
1655}
1656
Ulya Trafimovicheea486a2021-02-26 11:38:21 +00001657// Helper function to replace string in a list.
1658func replaceInList(list []string, oldstr, newstr string) {
1659 for i, str := range list {
1660 if str == oldstr {
1661 list[i] = newstr
1662 }
1663 }
1664}
1665
Ulya Trafimovich24446712021-07-15 14:59:34 +01001666// Returns a map of module names of shared library dependencies to the paths to their dex jars on
1667// host and on device.
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001668func (u *usesLibrary) classLoaderContextForUsesLibDeps(ctx android.ModuleContext) dexpreopt.ClassLoaderContextMap {
1669 clcMap := make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich24446712021-07-15 14:59:34 +01001670
1671 // Skip when UnbundledBuild() is true, but UnbundledBuildImage() is false. With
1672 // UnbundledBuildImage() it is necessary to generate dexpreopt.config for post-dexpreopting.
1673 if ctx.Config().UnbundledBuild() && !ctx.Config().UnbundledBuildImage() {
1674 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001675 }
1676
Ulya Trafimovich24446712021-07-15 14:59:34 +01001677 ctx.VisitDirectDeps(func(m android.Module) {
1678 tag, isUsesLibTag := ctx.OtherModuleDependencyTag(m).(usesLibraryDependencyTag)
1679 if !isUsesLibTag {
1680 return
1681 }
1682
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001683 dep := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(m))
Ulya Trafimovich24446712021-07-15 14:59:34 +01001684
Ulya Trafimovich840efb62021-07-15 14:34:40 +01001685 // Skip stub libraries. A dependency on the implementation library has been added earlier,
1686 // so it will be added to CLC, but the stub shouldn't be. Stub libraries can be distingushed
1687 // from implementation libraries by their name, which is different as it has a suffix.
1688 if comp, ok := m.(SdkLibraryComponentDependency); ok {
1689 if impl := comp.OptionalSdkLibraryImplementation(); impl != nil && *impl != dep {
1690 return
1691 }
1692 }
1693
Spandan Das0727ba72024-02-13 16:37:43 +00001694 // Skip java_sdk_library dependencies that provide stubs, but not an implementation.
1695 // This will be restricted to optional_uses_libs
1696 if sdklib, ok := m.(SdkLibraryDependency); ok {
1697 if tag == usesLibOptTag && sdklib.DexJarBuildPath(ctx).PathOrNil() == nil {
1698 u.shouldDisableDexpreopt = true
1699 return
1700 }
1701 }
1702
Ulya Trafimovich24446712021-07-15 14:59:34 +01001703 if lib, ok := m.(UsesLibraryDependency); ok {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001704 libName := dep
Ulya Trafimovich24446712021-07-15 14:59:34 +01001705 if ulib, ok := m.(ProvidesUsesLib); ok && ulib.ProvidesUsesLib() != nil {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001706 libName = *ulib.ProvidesUsesLib()
Ulya Trafimovich24446712021-07-15 14:59:34 +01001707 // Replace module name with library name in `uses_libs`/`optional_uses_libs` in
1708 // order to pass verify_uses_libraries check (which compares these properties
1709 // against library names written in the manifest).
1710 replaceInList(u.usesLibraryProperties.Uses_libs, dep, libName)
1711 replaceInList(u.usesLibraryProperties.Optional_uses_libs, dep, libName)
1712 }
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001713 clcMap.AddContext(ctx, tag.sdkVersion, libName, tag.optional,
Spandan Das59a4a2b2024-01-09 21:35:56 +00001714 lib.DexJarBuildPath(ctx).PathOrNil(), lib.DexJarInstallPath(),
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001715 lib.ClassLoaderContexts())
Ulya Trafimovich24446712021-07-15 14:59:34 +01001716 } else if ctx.Config().AllowMissingDependencies() {
1717 ctx.AddMissingDependencies([]string{dep})
1718 } else {
1719 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", dep)
1720 }
1721 })
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001722 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001723}
1724
1725// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1726// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1727// unconditionally in the future.
1728func (u *usesLibrary) enforceUsesLibraries() bool {
1729 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1730 len(u.usesLibraryProperties.Optional_uses_libs) > 0
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001731 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, u.enforce || defaultEnforceUsesLibs)
Colin Cross50ddcc42019-05-16 12:28:22 -07001732}
1733
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001734// Freeze the value of `enforce_uses_libs` based on the current values of `uses_libs` and `optional_uses_libs`.
1735func (u *usesLibrary) freezeEnforceUsesLibraries() {
1736 enforce := u.enforceUsesLibraries()
1737 u.usesLibraryProperties.Enforce_uses_libs = &enforce
1738}
1739
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001740// verifyUsesLibraries checks the <uses-library> tags in the manifest against the ones specified
1741// in the `uses_libs`/`optional_uses_libs` properties. The input can be either an XML manifest, or
1742// an APK with the manifest embedded in it (manifest_check will know which one it is by the file
1743// extension: APKs are supposed to end with '.apk').
1744func (u *usesLibrary) verifyUsesLibraries(ctx android.ModuleContext, inputFile android.Path,
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001745 outputFile android.WritablePath) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001746
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001747 statusFile := dexpreopt.UsesLibrariesStatusFile(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001748
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001749 // Disable verify_uses_libraries check if dexpreopt is globally disabled. Without dexpreopt the
1750 // check is not necessary, and although it is good to have, it is difficult to maintain on
1751 // non-linux build platforms where dexpreopt is generally disabled (the check may fail due to
1752 // various unrelated reasons, such as a failure to get manifest from an APK).
Ulya Trafimovich39dd0a42021-03-29 14:57:34 +01001753 global := dexpreopt.GetGlobalConfig(ctx)
Jiakai Zhang23984422023-11-09 16:47:04 +00001754 if global.DisablePreopt || global.OnlyPreoptArtBootImage {
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001755 return inputFile
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001756 }
1757
Colin Crossf1a035e2020-11-16 17:32:30 -08001758 rule := android.NewRuleBuilder(pctx, ctx)
1759 cmd := rule.Command().BuiltTool("manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001760 Flag("--enforce-uses-libraries").
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001761 Input(inputFile).
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001762 FlagWithOutput("--enforce-uses-libraries-status ", statusFile).
Saeid Farivar Asanjanfd27c7c2022-08-08 20:21:26 +00001763 FlagWithInput("--aapt ", ctx.Config().HostToolPath(ctx, "aapt2"))
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001764
1765 if outputFile != nil {
1766 cmd.FlagWithOutput("-o ", outputFile)
1767 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001768
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001769 if dexpreopt.GetGlobalConfig(ctx).RelaxUsesLibraryCheck {
1770 cmd.Flag("--enforce-uses-libraries-relax")
1771 }
1772
Colin Cross50ddcc42019-05-16 12:28:22 -07001773 for _, lib := range u.usesLibraryProperties.Uses_libs {
1774 cmd.FlagWithArg("--uses-library ", lib)
1775 }
1776
1777 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1778 cmd.FlagWithArg("--optional-uses-library ", lib)
1779 }
1780
Colin Crossf1a035e2020-11-16 17:32:30 -08001781 rule.Build("verify_uses_libraries", "verify <uses-library>")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001782 return outputFile
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001783}
Colin Cross50ddcc42019-05-16 12:28:22 -07001784
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001785// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against
1786// the build system and returns the path to a copy of the manifest.
1787func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1788 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001789 return u.verifyUsesLibraries(ctx, manifest, outputFile)
Colin Cross50ddcc42019-05-16 12:28:22 -07001790}
1791
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001792// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the build
1793// system and returns the path to a copy of the APK.
Cole Faust2f1da162023-04-17 15:06:56 -07001794func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001795 u.verifyUsesLibraries(ctx, apk, nil) // for APKs manifest_check does not write output file
Colin Cross50ddcc42019-05-16 12:28:22 -07001796}