blob: 254fbf4fd4333754541f39311930126ec124e20a [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
Jiyong Park20df11e2024-05-08 09:54:22 +000093 // flag so that they are used from inside the APK at runtime. This property is respected only for
94 // APKs built using android_test or android_test_helper_app. For other APKs, this property is ignored
95 // and native libraries are always embedded compressed.
Colin Crosse4246ab2019-02-05 21:55:21 -080096 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -080097
98 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
99 // they are used from inside the APK at runtime.
100 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700101
Jiyong Park20df11e2024-05-08 09:54:22 +0000102 // Allows compressing of embedded native libs. Only for android_test and android_test_helper_app.
103 AllowCompressingNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700104
105 // If set, find and merge all NOTICE files that this module and its dependencies have and store
106 // it in the APK as an asset.
107 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700108
109 // cc.Coverage related properties
110 PreventInstall bool `blueprint:"mutated"`
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700111 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100112
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000113 // It can be set to test the behaviour of default target sdk version.
114 // Only required when updatable: false. It is an error if updatable: true and this is false.
115 Enforce_default_target_sdk_version *bool
116
117 // If set, the targetSdkVersion for the target is set to the latest default API level.
118 // This would be by default false, unless updatable: true or
119 // enforce_default_target_sdk_version: true in which case this defaults to true.
120 EnforceDefaultTargetSdkVersion bool `blueprint:"mutated"`
121
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100122 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100123 // additional rules to make sure an app can safely be updated. Default is false.
124 // Prefer using other specific properties if build behaviour must be changed; avoid using this
125 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100126 Updatable *bool
Andrei Onea580636b2022-08-17 16:53:46 +0000127
128 // Specifies the file that contains the allowlist for this app.
129 Privapp_allowlist *string `android:"path"`
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900130
131 // If set, create an RRO package which contains only resources having PRODUCT_CHARACTERISTICS
132 // and install the RRO package to /product partition, instead of passing --product argument
133 // to aapt2. Default is false.
134 // Setting this will make this APK identical to all targets, regardless of
135 // PRODUCT_CHARACTERISTICS.
136 Generate_product_characteristics_rro *bool
137
138 ProductCharacteristicsRROPackageName *string `blueprint:"mutated"`
139 ProductCharacteristicsRROManifestModuleName *string `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700140}
141
Jaewoong Jung525443a2019-02-28 15:35:54 -0800142// android_app properties that can be overridden by override_android_app
143type overridableAppProperties struct {
144 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
145 // or an android_app_certificate module name in the form ":module".
146 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700147
Jaewoong Jung1c1b6e62021-03-09 15:02:31 -0800148 // Name of the signing certificate lineage file or filegroup module.
149 Lineage *string `android:"path"`
Liz Kammere2b27f42020-05-07 13:24:05 -0700150
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400151 // For overriding the --rotation-min-sdk-version property of apksig
152 RotationMinSdkVersion *string
153
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700154 // the package name of this app. The package name in the manifest file is used if one was not given.
155 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800156
157 // the logging parent of this app.
158 Logging_parent *string
Liz Kammer9f9fd022020-06-18 19:44:06 +0000159
160 // Whether to rename the package in resources to the override name rather than the base name. Defaults to true.
161 Rename_resources_package *bool
zhidou198f5892022-02-17 02:33:12 +0000162
163 // Names of modules to be overridden. Listed modules can only be other binaries
164 // (in Make or Soong).
165 // This does not completely prevent installation of the overridden binaries, but if both
166 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
167 // from PRODUCT_PACKAGES.
168 Overrides []string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800169}
170
Colin Cross30e076a2015-04-13 13:58:27 -0700171type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700172 Library
173 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800174 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700175
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900176 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700177
Colin Crossfabb6082018-02-20 17:22:23 -0800178 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700179
Jaewoong Jung525443a2019-02-28 15:35:54 -0800180 overridableAppProperties overridableAppProperties
181
Colin Cross403cc152020-07-06 14:15:24 -0700182 jniLibs []jniLib
183 installPathForJNISymbols android.Path
184 embeddedJniLibs bool
185 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700186
187 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800188
189 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
190 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800191
Colin Cross70dda7e2019-10-01 22:05:35 -0700192 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700193
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700194 onDeviceDir string
195
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800196 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700197
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900198 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100199
200 android.ApexBundleDepsInfo
Matt Banda8c801262022-04-01 17:48:31 +0000201
202 javaApiUsedByOutputFile android.ModuleOutPath
Andrei Onea580636b2022-08-17 16:53:46 +0000203
204 privAppAllowlist android.OptionalPath
Colin Crosse1731a52017-12-14 11:22:55 -0800205}
206
Martin Stjernholm6d415272020-01-31 17:10:36 +0000207func (a *AndroidApp) IsInstallable() bool {
208 return Bool(a.properties.Installable)
209}
210
Colin Crossab8d1382023-07-14 17:23:41 +0000211func (a *AndroidApp) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
212 return a.aapt.resourcesNodesDepSet
Colin Cross66f78822018-05-02 12:58:28 -0700213}
214
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900215func (a *AndroidApp) OutputFile() android.Path {
216 return a.outputFile
217}
218
Colin Cross503c1d02020-01-28 14:00:53 -0800219func (a *AndroidApp) Certificate() Certificate {
220 return a.certificate
221}
222
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700223func (a *AndroidApp) JniCoverageOutputs() android.Paths {
224 return a.jniCoverageOutputs
225}
226
Andrei Onea580636b2022-08-17 16:53:46 +0000227func (a *AndroidApp) PrivAppAllowlist() android.OptionalPath {
228 return a.privAppAllowlist
229}
230
Colin Crossa97c5d32018-03-28 14:58:31 -0700231var _ AndroidLibraryDependency = (*AndroidApp)(nil)
232
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900233type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800234 Pem, Key android.Path
235 presigned bool
236}
237
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700238var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800239
240func (c Certificate) AndroidMkString() string {
241 if c.presigned {
242 return "PRESIGNED"
243 } else {
244 return c.Pem.String()
245 }
Colin Cross30e076a2015-04-13 13:58:27 -0700246}
247
Colin Cross46c9b8b2017-06-22 16:51:17 -0700248func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
Jiyong Park92315372021-04-02 08:45:46 +0900249 if String(a.appProperties.Stl) == "c++_shared" && !a.SdkVersion(ctx).Specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700250 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
251 }
252
Jiyong Parkf1691d22021-03-29 20:11:58 +0900253 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Jiakai Zhangf98da192024-04-15 11:15:41 +0000254 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
255 a.Module.deps(ctx)
Paul Duffin250e6192019-06-07 10:44:37 +0100256 if sdkDep.hasFrameworkLibs() {
257 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700258 }
Colin Crossa4f08812018-10-02 22:03:40 -0700259
Jiyong Park92315372021-04-02 08:45:46 +0900260 usesSDK := a.SdkVersion(ctx).Specified() && a.SdkVersion(ctx).Kind != android.SdkCorePlatform
Colin Cross3c007702020-05-08 11:20:24 -0700261
262 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
263 ctx.PropertyErrorf("jni_uses_sdk_apis",
264 "can only be set for modules that do not set sdk_version")
265 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
266 ctx.PropertyErrorf("jni_uses_platform_apis",
267 "can only be set for modules that set sdk_version")
268 }
269
Colin Crossa4f08812018-10-02 22:03:40 -0700270 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700271 variation := append(jniTarget.Variations(),
272 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000273
274 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
275 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700276 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
277 // have stable APIs through the VNDK.
278 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
279 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700280 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000281 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
282 }
Colin Crossde78d132020-10-09 18:59:49 -0700283 ctx.AddFarVariationDependencies(variation, jniLibTag, a.appProperties.Jni_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700284 }
Jihoon Kang9049c272024-03-19 21:57:36 +0000285 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
286 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
287 }
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700288}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700289
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700290func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800291 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700292 if cert != "" {
293 ctx.AddDependency(ctx.Module(), certificateTag, cert)
294 }
295
Andrei Onea580636b2022-08-17 16:53:46 +0000296 if a.appProperties.Privapp_allowlist != nil && !Bool(a.appProperties.Privileged) {
Anton Hanssone3f31cf2023-06-03 08:53:47 +0000297 // There are a few uids that are explicitly considered privileged regardless of their
298 // app's location. Bluetooth is one such app. It should arguably be moved to priv-app,
299 // but for now, allow it not to be in priv-app.
300 privilegedBecauseOfUid := ctx.ModuleName() == "Bluetooth"
301 if !privilegedBecauseOfUid {
302 ctx.PropertyErrorf("privapp_allowlist", "privileged must be set in order to use privapp_allowlist (with a few exceptions)")
303 }
Andrei Onea580636b2022-08-17 16:53:46 +0000304 }
305
Colin Crossbd01e2a2018-10-04 15:21:03 -0700306 for _, cert := range a.appProperties.Additional_certificates {
307 cert = android.SrcIsModule(cert)
308 if cert != "" {
309 ctx.AddDependency(ctx.Module(), certificateTag, cert)
310 } else {
311 ctx.PropertyErrorf("additional_certificates",
312 `must be names of android_app_certificate modules in the form ":module"`)
313 }
314 }
Colin Cross30e076a2015-04-13 13:58:27 -0700315}
316
Jeongik Cha538c0d02019-07-11 15:54:27 +0900317func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Alix96ea88452023-08-31 15:48:23 +0000318 applicationId := a.appTestHelperAppProperties.Manifest_values.ApplicationId
319 if applicationId != nil {
320 if a.overridableAppProperties.Package_name != nil {
321 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
322 }
323 a.aapt.manifestValues.applicationId = *applicationId
324 }
Jeongik Cha538c0d02019-07-11 15:54:27 +0900325 a.generateAndroidBuildActions(ctx)
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700326 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
327 TestOnly: true,
328 })
329
Jeongik Cha538c0d02019-07-11 15:54:27 +0900330}
331
Colin Cross46c9b8b2017-06-22 16:51:17 -0700332func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100333 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700334 a.generateAndroidBuildActions(ctx)
Matt Banda8c801262022-04-01 17:48:31 +0000335 a.generateJavaUsedByApex(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700336}
337
Sam Delmerico0e0d96e2023-08-18 22:43:28 +0000338func (a *AndroidApp) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
339 defaultMinSdkVersion := a.Module.MinSdkVersion(ctx)
340 if proptools.Bool(a.appProperties.Updatable) {
341 overrideApiLevel := android.MinSdkVersionFromValue(ctx, ctx.DeviceConfig().ApexGlobalMinSdkVersionOverride())
342 if !overrideApiLevel.IsNone() && overrideApiLevel.CompareTo(defaultMinSdkVersion) > 0 {
343 return overrideApiLevel
344 }
345 }
346 return defaultMinSdkVersion
347}
348
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100349func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100350 if a.Updatable() {
Jiyong Park92315372021-04-02 08:45:46 +0900351 if !a.SdkVersion(ctx).Stable() {
352 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.SdkVersion(ctx))
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100353 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100354 if String(a.deviceProperties.Min_sdk_version) == "" {
355 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
356 }
Jooyung Han749dc692020-04-15 11:03:39 +0900357
Jiyong Park92315372021-04-02 08:45:46 +0900358 if minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx); err == nil {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900359 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
satayevb3fd4112021-12-02 13:59:35 +0000360 android.CheckMinSdkVersion(ctx, minSdkVersion, a.WalkPayloadDeps)
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900361 } else {
362 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
363 }
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000364
365 if !BoolDefault(a.appProperties.Enforce_default_target_sdk_version, true) {
366 ctx.PropertyErrorf("enforce_default_target_sdk_version", "Updatable apps must enforce default target sdk version")
367 }
368 // TODO(b/227460469) after all the modules removes the target sdk version, throw an error if the target sdk version is explicitly set.
369 if a.deviceProperties.Target_sdk_version == nil {
370 a.SetEnforceDefaultTargetSdkVersion(true)
371 }
372 }
373
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100374 a.checkPlatformAPI(ctx)
375 a.checkSdkVersions(ctx)
376}
377
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900378// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
379// This check is enforced for "updatable" APKs (including APK-in-APEX).
Jiyong Park54105c42021-03-31 18:17:53 +0900380func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion android.ApiLevel) {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900381 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
382 ctx.VisitDirectDeps(func(m android.Module) {
383 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
384 return
385 }
386 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900387 // The domain of cc.sdk_version is "current" and <number>
Jiyong Parkf1691d22021-03-29 20:11:58 +0900388 // We can rely on android.SdkSpec to convert it to <number> so that "current" is
389 // handled properly regardless of sdk finalization.
Spandan Das2e8c0442022-05-08 00:39:35 +0000390 jniSdkVersion, err := android.SdkSpecFrom(ctx, dep.MinSdkVersion()).EffectiveVersion(ctx)
Jiyong Park54105c42021-03-31 18:17:53 +0900391 if err != nil || minSdkVersion.LessThan(jniSdkVersion) {
Spandan Das2e8c0442022-05-08 00:39:35 +0000392 ctx.OtherModuleErrorf(dep, "min_sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
393 dep.MinSdkVersion(), minSdkVersion, ctx.ModuleName())
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900394 return
395 }
396
397 })
398}
399
Sasha Smundak6ad77252019-05-01 13:16:22 -0700400// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800401// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700402func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park20df11e2024-05-08 09:54:22 +0000403 var useEmbedded bool
404 if a.appProperties.AllowCompressingNativeLibs {
405 useEmbedded = BoolDefault(a.appProperties.Use_embedded_native_libs, true)
406 } else {
407 useEmbedded = true // always uncompress for non-test apps
408 }
409
Jiyong Park92315372021-04-02 08:45:46 +0900410 minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800411 if err != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900412 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.MinSdkVersion(ctx), err)
Colin Crosse4246ab2019-02-05 21:55:21 -0800413 }
Jiyong Park20df11e2024-05-08 09:54:22 +0000414 supported := minSdkVersion.FinalOrFutureInt() >= 23
Colin Crosse4246ab2019-02-05 21:55:21 -0800415
Jiyong Park20df11e2024-05-08 09:54:22 +0000416 return useEmbedded && supported
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 {
Jiyong Park20df11e2024-05-08 09:54:22 +0000439 // Always!
440 return true
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700441}
442
Jiyong Parkef5511f2024-05-08 09:54:22 +0000443func (a *AndroidApp) shouldCollectRecursiveNativeDeps(ctx android.ModuleContext) bool {
444 // JNI libs are always embedded, but whether to embed their transitive dependencies as well
445 // or not is determined here. For most of the apps built here (using the platform build
446 // system), we don't need to collect the transitive deps because they will anyway be
447 // available in the partition image where the app will be installed to.
448 //
449 // Collecting transitive dependencies is required only for unbundled apps.
450 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
451 apkInApex := !apexInfo.IsForPlatform()
452 testApp := a.appProperties.AllowCompressingNativeLibs
453 unbundledApp := ctx.Config().UnbundledBuild() || apkInApex || testApp
454
455 return a.shouldEmbedJnis(ctx) && unbundledApp
456}
457
Liz Kammer9f9fd022020-06-18 19:44:06 +0000458func generateAaptRenamePackageFlags(packageName string, renameResourcesPackage bool) []string {
459 aaptFlags := []string{"--rename-manifest-package " + packageName}
460 if renameResourcesPackage {
461 // Required to rename the package name in the resources table.
462 aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
463 }
464 return aaptFlags
465}
466
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900467func (a *AndroidApp) OverriddenManifestPackageName() string {
468 return a.overriddenManifestPackageName
469}
470
Liz Kammer9f9fd022020-06-18 19:44:06 +0000471func (a *AndroidApp) renameResourcesPackage() bool {
472 return proptools.BoolDefault(a.overridableAppProperties.Rename_resources_package, true)
473}
474
Jihoon Kang9049c272024-03-19 21:57:36 +0000475func getAconfigFilePaths(ctx android.ModuleContext) (aconfigTextFilePaths android.Paths) {
476 ctx.VisitDirectDepsWithTag(aconfigDeclarationTag, func(dep android.Module) {
477 if provider, ok := android.OtherModuleProvider(ctx, dep, android.AconfigDeclarationsProviderKey); ok {
478 aconfigTextFilePaths = append(aconfigTextFilePaths, provider.IntermediateDumpOutputPath)
479 } else {
480 ctx.ModuleErrorf("Only aconfig_declarations module type is allowed for "+
481 "flags_packages property, but %s is not aconfig_declarations module type",
482 dep.Name(),
483 )
484 }
485 })
486
487 return aconfigTextFilePaths
488}
489
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800490func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900491 usePlatformAPI := proptools.Bool(a.Module.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900492 if ctx.Module().(android.SdkContext).SdkVersion(ctx).Kind == android.SdkModule {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900493 usePlatformAPI = true
494 }
495 a.aapt.usesNonSdkApis = usePlatformAPI
David Brazdild25060a2019-02-18 18:24:16 +0000496
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700497 // Ask manifest_fixer to add or update the application element indicating this app has no code.
498 a.aapt.hasNoCode = !a.hasCode(ctx)
499
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800500 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800501
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800502 // 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 +0900503 autogenerateRRO := proptools.Bool(a.appProperties.Generate_product_characteristics_rro)
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800504 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Inseob Kim10af6ed2024-02-13 12:56:46 +0900505 characteristics := ctx.Config().ProductAAPTCharacteristics()
506 if !autogenerateRRO && !hasProduct && len(characteristics) > 0 && characteristics != "default" {
507 aaptLinkFlags = append(aaptLinkFlags, "--product", characteristics)
Colin Crosse78dcd32018-04-19 15:25:19 -0700508 }
509
Dan Willemsen72be5902018-10-24 20:24:57 -0700510 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
511 // Product AAPT config
512 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800513 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700514 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700515
Dan Willemsen72be5902018-10-24 20:24:57 -0700516 // Product AAPT preferred config
517 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800518 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700519 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700520 }
521
Jiyong Park7f67f482019-01-05 12:57:48 +0900522 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700523 if overridden || a.overridableAppProperties.Package_name != nil {
524 // The product override variable has a priority over the package_name property.
525 if !overridden {
526 manifestPackageName = *a.overridableAppProperties.Package_name
527 }
Liz Kammer9f9fd022020-06-18 19:44:06 +0000528 aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName, a.renameResourcesPackage())...)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900529 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900530 }
531
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800532 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
533
Colin Crosse560c4a2019-03-19 16:03:11 -0700534 a.aapt.splitNames = a.appProperties.Package_splits
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800535 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Alexei Nicoara69cf0f32022-07-27 14:59:18 +0100536 if a.Updatable() {
537 a.aapt.defaultManifestVersion = android.DefaultUpdatableModuleVersion
538 }
Jihoon Kang84b25892023-12-01 22:01:06 +0000539
Rico Winda2fa2632024-03-13 13:09:17 +0100540 // Use non final ids if we are doing optimized shrinking and are using R8.
541 nonFinalIds := Bool(a.dexProperties.Optimize.Optimized_shrink_resources) && a.dexer.effectiveOptimizeEnabled()
Alixf7a10272023-09-27 16:47:56 +0000542 a.aapt.buildActions(ctx,
543 aaptBuildActionOptions{
Jihoon Kang84b25892023-12-01 22:01:06 +0000544 sdkContext: android.SdkContext(a),
545 classLoaderContexts: a.classLoaderContexts,
546 excludedLibs: a.usesLibraryProperties.Exclude_uses_libs,
547 enforceDefaultTargetSdkVersion: a.enforceDefaultTargetSdkVersion(),
Rico Winda2fa2632024-03-13 13:09:17 +0100548 forceNonFinalResourceIDs: nonFinalIds,
Jihoon Kang84b25892023-12-01 22:01:06 +0000549 extraLinkFlags: aaptLinkFlags,
Jihoon Kang9049c272024-03-19 21:57:36 +0000550 aconfigTextFiles: getAconfigFilePaths(ctx),
Jiakai Zhang36937082024-04-15 11:15:50 +0000551 usesLibrary: &a.usesLibrary,
Alixf7a10272023-09-27 16:47:56 +0000552 },
553 )
Colin Cross30e076a2015-04-13 13:58:27 -0700554
Colin Cross46c9b8b2017-06-22 16:51:17 -0700555 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700556 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800557}
Colin Cross30e076a2015-04-13 13:58:27 -0700558
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800559func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700560 var staticLibProguardFlagFiles android.Paths
561 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800562 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -0400563 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.UnconditionallyExportedProguardFlags.ToList()...)
564 if ctx.OtherModuleDependencyTag(m) == staticLibTag {
565 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.ProguardFlagsFiles.ToList()...)
Colin Cross89c31582018-04-30 15:55:11 -0700566 }
567 })
568
569 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
570
Colin Cross312634e2023-11-21 15:13:56 -0800571 a.Module.extraProguardFlagsFiles = append(a.Module.extraProguardFlagsFiles, staticLibProguardFlagFiles...)
Rico Winda2fa2632024-03-13 13:09:17 +0100572 if !Bool(a.dexProperties.Optimize.Optimized_shrink_resources) {
573 // When using the optimized shrinking the R8 enqueuer will traverse the xml files that become
574 // live for code references and (transitively) mark these as live.
575 // In this case we explicitly don't wan't the aapt2 generated keep files (which would keep the now
576 // dead code alive)
577 a.Module.extraProguardFlagsFiles = append(a.Module.extraProguardFlagsFiles, a.proguardOptionsFile)
578 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800579}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800580
Colin Cross403cc152020-07-06 14:15:24 -0700581func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
Colin Cross43f08db2018-11-12 10:13:39 -0800582 var installDir string
583 if ctx.ModuleName() == "framework-res" {
584 // framework-res.apk is installed as system/framework/framework-res.apk
585 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900586 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800587 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800588 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800589 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800590 }
Colin Cross403cc152020-07-06 14:15:24 -0700591
592 return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
593}
594
Rico Wind98e7fa82023-11-27 09:44:03 +0100595func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) (android.Path, android.Path) {
Colin Cross403cc152020-07-06 14:15:24 -0700596 a.dexpreopter.installPath = a.installPath(ctx)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000597 a.dexpreopter.isApp = true
Liz Kammera7a64f32020-07-09 15:16:41 -0700598 if a.dexProperties.Uncompress_dex == nil {
David Srbeckye033cba2020-05-20 22:20:28 +0100599 // If the value was not force-set by the user, use reasonable default based on the module.
Liz Kammera7a64f32020-07-09 15:16:41 -0700600 a.dexProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
David Srbeckye033cba2020-05-20 22:20:28 +0100601 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700602 a.dexpreopter.uncompressedDex = *a.dexProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700603 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100604 a.dexpreopter.classLoaderContexts = a.classLoaderContexts
Colin Cross50ddcc42019-05-16 12:28:22 -0700605 a.dexpreopter.manifestFile = a.mergedManifestFile
Colin Crossfa9bfcd2021-11-10 16:42:38 -0800606 a.dexpreopter.preventInstall = a.appProperties.PreventInstall
Colin Cross50ddcc42019-05-16 12:28:22 -0700607
Rico Wind98e7fa82023-11-27 09:44:03 +0100608 var packageResources = a.exportPackage
609
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800610 if ctx.ModuleName() != "framework-res" {
Rico Winda2fa2632024-03-13 13:09:17 +0100611 if a.dexProperties.resourceShrinkingEnabled() {
Rico Wind98e7fa82023-11-27 09:44:03 +0100612 protoFile := android.PathForModuleOut(ctx, packageResources.Base()+".proto.apk")
613 aapt2Convert(ctx, protoFile, packageResources, "proto")
614 a.dexer.resourcesInput = android.OptionalPathForPath(protoFile)
615 }
616
Colin Cross4eae06d2023-06-20 22:40:02 -0700617 var extraSrcJars android.Paths
618 var extraClasspathJars android.Paths
619 var extraCombinedJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800620 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700621 // When building an app with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox has already
622 // created R.class files that provide IDs for resources in busybox/R.jar. Pass that file in the
623 // classpath when compiling everything else, and add it to the final classes jar.
624 extraClasspathJars = android.Paths{a.aapt.rJar}
625 extraCombinedJars = android.Paths{a.aapt.rJar}
626 } else {
627 // When building an app without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
628 // R.java files for the app's package and the packages from all transitive static android_library
629 // dependencies. Compile the srcjar alongside the rest of the sources.
630 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
631 }
632
633 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Rico Winda2fa2632024-03-13 13:09:17 +0100634 if a.dexProperties.resourceShrinkingEnabled() {
Rico Wind98e7fa82023-11-27 09:44:03 +0100635 binaryResources := android.PathForModuleOut(ctx, packageResources.Base()+".binary.out.apk")
636 aapt2Convert(ctx, binaryResources, a.dexer.resourcesOutput.Path(), "binary")
637 packageResources = binaryResources
638 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800639 }
Colin Cross30e076a2015-04-13 13:58:27 -0700640
Rico Wind98e7fa82023-11-27 09:44:03 +0100641 return a.dexJarFile.PathOrNil(), packageResources
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800642}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800643
Sam Delmerico82602492022-06-10 17:05:42 +0000644func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, prebuiltJniPackages android.Paths, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700645 var jniJarFile android.WritablePath
Sam Delmerico82602492022-06-10 17:05:42 +0000646 if len(jniLibs) > 0 || len(prebuiltJniPackages) > 0 {
Colin Cross403cc152020-07-06 14:15:24 -0700647 a.jniLibs = jniLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700648 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700649 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Colin Crossc68db4b2021-11-11 18:59:15 -0800650 a.installPathForJNISymbols = a.installPath(ctx)
Sam Delmerico82602492022-06-10 17:05:42 +0000651 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, prebuiltJniPackages, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700652 for _, jni := range jniLibs {
653 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700654 // Only collect coverage for the first target arch if this is a multilib target.
655 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
656 // data file path collisions since the current coverage file path format doesn't contain
657 // arch-related strings. This is fine for now though; the code coverage team doesn't use
658 // multi-arch targets such as test_suite_* for coverage collections yet.
659 //
660 // Work with the team to come up with a new format that handles multilib modules properly
661 // and change this.
662 if len(ctx.Config().Targets[android.Android]) == 1 ||
Jaewoong Jung642916f2020-10-09 17:25:15 -0700663 ctx.Config().AndroidFirstDeviceTarget.Arch.ArchType == jni.target.Arch.ArchType {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700664 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
665 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700666 }
667 }
Colin Cross403cc152020-07-06 14:15:24 -0700668 a.embeddedJniLibs = true
Colin Crossa4f08812018-10-02 22:03:40 -0700669 }
670 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800671 return jniJarFile
672}
Colin Crossa4f08812018-10-02 22:03:40 -0700673
Colin Cross403cc152020-07-06 14:15:24 -0700674func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
675 var jniSymbols android.RuleBuilderInstalls
676 for _, jniLib := range a.jniLibs {
677 if jniLib.unstrippedFile != nil {
678 jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
679 From: jniLib.unstrippedFile,
680 To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
681 })
682 }
683 }
684 return jniSymbols
685}
686
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700687// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
688// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
Colin Crossbc2c8a72022-09-14 12:45:42 -0700689func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate,
690 ctx android.ModuleContext) (mainCertificate Certificate, allCertificates []Certificate) {
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700691 if android.SrcIsModule(certPropValue) == "" {
692 var mainCert Certificate
693 if certPropValue != "" {
694 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
695 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800696 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
697 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700698 }
699 } else {
700 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800701 mainCert = Certificate{
702 Pem: pem,
703 Key: key,
704 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700705 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700706 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700707 }
708
Colin Crossbc2c8a72022-09-14 12:45:42 -0700709 if len(certificates) > 0 {
710 mainCertificate = certificates[0]
711 } else {
712 // This can be reached with an empty certificate list if AllowMissingDependencies is set
713 // and the certificate property for this module is a module reference to a missing module.
714 if !ctx.Config().AllowMissingDependencies() && len(ctx.GetMissingDependencies()) > 0 {
715 panic("Should only get here if AllowMissingDependencies set and there are missing dependencies")
716 }
717 // Set a certificate to avoid panics later when accessing it.
718 mainCertificate = Certificate{
719 Key: android.PathForModuleOut(ctx, "missing.pk8"),
Colin Crossa54f4b52022-11-21 04:35:53 +0000720 Pem: android.PathForModuleOut(ctx, "missing.x509.pem"),
Colin Crossbc2c8a72022-09-14 12:45:42 -0700721 }
722 }
723
Zyan Wub7550aa2023-05-18 15:46:31 +0800724 if !m.Platform() {
725 certPath := mainCertificate.Pem.String()
726 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
727 if strings.HasPrefix(certPath, systemCertPath) {
728 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
729 allowed := ctx.Config().EnforceSystemCertificateAllowList()
730
731 if enforceSystemCert && !inList(m.Name(), allowed) {
732 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
733 }
734 }
735 }
736
Colin Crossbc2c8a72022-09-14 12:45:42 -0700737 return mainCertificate, certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800738}
739
Jooyung Han39ee1192020-03-23 20:21:11 +0900740func (a *AndroidApp) InstallApkName() string {
741 return a.installApkName
742}
743
Sam Delmerico15809f82023-05-15 17:21:47 -0400744func (a *AndroidApp) createPrivappAllowlist(ctx android.ModuleContext) android.Path {
Andrei Onea580636b2022-08-17 16:53:46 +0000745 if a.appProperties.Privapp_allowlist == nil {
746 return nil
747 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400748
749 isOverrideApp := a.GetOverriddenBy() != ""
750 if !isOverrideApp {
751 // if this is not an override, we don't need to rewrite the existing privapp allowlist
752 return android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist)
753 }
754
Andrei Onea580636b2022-08-17 16:53:46 +0000755 if a.overridableAppProperties.Package_name == nil {
756 ctx.PropertyErrorf("privapp_allowlist", "package_name must be set to use privapp_allowlist")
757 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400758
Andrei Onea580636b2022-08-17 16:53:46 +0000759 packageName := *a.overridableAppProperties.Package_name
760 fileName := "privapp_allowlist_" + packageName + ".xml"
761 outPath := android.PathForModuleOut(ctx, fileName).OutputPath
762 ctx.Build(pctx, android.BuildParams{
763 Rule: modifyAllowlist,
764 Input: android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist),
765 Output: outPath,
766 Args: map[string]string{
767 "packageName": packageName,
768 },
769 })
770 return &outPath
771}
772
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800773func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700774 var apkDeps android.Paths
775
Colin Crossff694a82023-12-13 15:54:49 -0800776 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
777 if !apexInfo.IsForPlatform() {
Colin Cross56a83212020-09-15 18:30:11 -0700778 a.hideApexVariantFromMake = true
779 }
780
Jeongik Cha538c0d02019-07-11 15:54:27 +0900781 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
782 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
783
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000784 // Unlike installApkName, a.stem should respect base module name for override_android_app.
785 // Therefore, use ctx.ModuleName() instead of a.Name().
yangbill2af0b6e2024-03-15 09:29:29 +0000786 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000787
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800788 // Check if the install APK name needs to be overridden.
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000789 // Both android_app and override_android_app module are expected to possess
790 // its module bound apk path. However, override_android_app inherits ctx.ModuleName()
791 // from the base module. Therefore, use a.Name() which represents
792 // the module name for both android_app and override_android_app.
793 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(
yangbill2af0b6e2024-03-15 09:29:29 +0000794 proptools.StringDefault(a.overridableProperties.Stem, a.Name()))
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800795
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700796 if ctx.ModuleName() == "framework-res" {
797 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700798 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900799 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700800 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
801 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800802 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700803 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700804 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700805 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700806 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700807
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100808 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000809 if a.usesLibrary.shouldDisableDexpreopt {
810 a.dexpreopter.disableDexpreopt()
811 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000812
Colin Cross61fb62e2022-06-23 10:46:28 -0700813 var noticeAssetPath android.WritablePath
814 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
815 // The rule to create the notice file can't be generated yet, as the final output path
816 // for the apk isn't known yet. Add the path where the notice file will be generated to the
817 // aapt rules now before calling aaptBuildActions, the rule to create the notice file will
818 // be generated later.
819 noticeAssetPath = android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
820 a.aapt.noticeFile = android.OptionalPathForPath(noticeAssetPath)
821 }
822
Harshit Mahajan8f202ad2023-01-09 20:45:55 +0000823 // For apps targeting latest target_sdk_version
824 if Bool(a.appProperties.Enforce_default_target_sdk_version) {
825 a.SetEnforceDefaultTargetSdkVersion(true)
826 }
827
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800828 // Process all building blocks, from AAPT to certificates.
829 a.aaptBuildActions(ctx)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100830 // The decision to enforce <uses-library> checks is made before adding implicit SDK libraries.
831 a.usesLibrary.freezeEnforceUsesLibraries()
832
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100833 // Check that the <uses-library> list is coherent with the manifest.
Colin Cross50ddcc42019-05-16 12:28:22 -0700834 if a.usesLibrary.enforceUsesLibraries() {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000835 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(
836 ctx, a.mergedManifestFile, &a.classLoaderContexts)
Colin Cross50ddcc42019-05-16 12:28:22 -0700837 apkDeps = append(apkDeps, manifestCheckFile)
838 }
839
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800840 a.proguardBuildActions(ctx)
841
Colin Cross014489c2020-06-02 20:09:13 -0700842 a.linter.mergedManifest = a.aapt.mergedManifestFile
843 a.linter.manifest = a.aapt.manifestPath
844 a.linter.resources = a.aapt.resourceFiles
Colin Crossc0efd1d2020-07-03 11:56:24 -0700845 a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
Colin Cross014489c2020-06-02 20:09:13 -0700846
Rico Wind98e7fa82023-11-27 09:44:03 +0100847 dexJarFile, packageResources := a.dexBuildActions(ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800848
Jiyong Parkef5511f2024-05-08 09:54:22 +0000849 jniLibs, prebuiltJniPackages, certificates := collectAppDeps(ctx, a, a.shouldCollectRecursiveNativeDeps(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Sam Delmerico82602492022-06-10 17:05:42 +0000850 jniJarFile := a.jniBuildActions(jniLibs, prebuiltJniPackages, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800851
852 if ctx.Failed() {
853 return
854 }
855
Colin Crossbc2c8a72022-09-14 12:45:42 -0700856 a.certificate, certificates = processMainCert(a.ModuleBase, a.getCertString(ctx), certificates, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800857
858 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800859 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700860 v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
861 var v4SignatureFile android.WritablePath = nil
862 if v4SigningRequested {
863 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
864 }
Liz Kammere2b27f42020-05-07 13:24:05 -0700865 var lineageFile android.Path
866 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
867 lineageFile = android.PathForModuleSrc(ctx, lineage)
868 }
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400869 rotationMinSdkVersion := String(a.overridableAppProperties.RotationMinSdkVersion)
870
Rico Wind98e7fa82023-11-27 09:44:03 +0100871 CreateAndSignAppPackage(ctx, packageFile, packageResources, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800872 a.outputFile = packageFile
Songchun Fan17d69e32020-03-24 20:32:24 -0700873 if v4SigningRequested {
874 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
875 }
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800876
Colin Cross61fb62e2022-06-23 10:46:28 -0700877 if a.aapt.noticeFile.Valid() {
878 // Generating the notice file rule has to be here after a.outputFile is known.
Bob Badoureef4c1c2022-05-16 12:20:04 -0700879 noticeFile := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700880 android.BuildNoticeHtmlOutputFromLicenseMetadata(
881 ctx, noticeFile, "", "",
882 []string{
883 a.installDir.String() + "/",
884 android.PathForModuleInstall(ctx).String() + "/",
885 a.outputFile.String(),
886 })
Bob Badoureef4c1c2022-05-16 12:20:04 -0700887 builder := android.NewRuleBuilder(pctx, ctx)
888 builder.Command().Text("cp").
889 Input(noticeFile).
890 Output(noticeAssetPath)
891 builder.Build("notice_dir", "Building notice dir")
Bob Badoureef4c1c2022-05-16 12:20:04 -0700892 }
893
Colin Crosse560c4a2019-03-19 16:03:11 -0700894 for _, split := range a.aapt.splits {
895 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800896 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700897 if v4SigningRequested {
898 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
899 }
Rico Wind98e7fa82023-11-27 09:44:03 +0100900 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Crosse560c4a2019-03-19 16:03:11 -0700901 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
Songchun Fan17d69e32020-03-24 20:32:24 -0700902 if v4SigningRequested {
903 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
904 }
Colin Crosse560c4a2019-03-19 16:03:11 -0700905 }
906
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800907 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700908 bundleFile := android.PathForModuleOut(ctx, "base.zip")
909 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
910 a.bundleFile = bundleFile
911
Andrei Onea580636b2022-08-17 16:53:46 +0000912 allowlist := a.createPrivappAllowlist(ctx)
913 if allowlist != nil {
914 a.privAppAllowlist = android.OptionalPathForPath(allowlist)
915 }
916
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800917 // Install the app package.
Andrei Onea580636b2022-08-17 16:53:46 +0000918 shouldInstallAppPackage := (Bool(a.Module.properties.Installable) || ctx.Host()) && apexInfo.IsForPlatform() && !a.appProperties.PreventInstall
919 if shouldInstallAppPackage {
Sam Delmericob1daccd2023-05-25 14:45:30 -0400920 if a.privAppAllowlist.Valid() {
Anton Hansson0e486a42023-06-01 16:38:35 +0000921 allowlistInstallPath := android.PathForModuleInstall(ctx, "etc", "permissions")
922 allowlistInstallFilename := a.installApkName + ".xml"
923 ctx.InstallFile(allowlistInstallPath, allowlistInstallFilename, a.privAppAllowlist.Path())
Sam Delmericob1daccd2023-05-25 14:45:30 -0400924 }
925
Colin Cross09ad3a62023-11-15 12:29:33 -0800926 var extraInstalledPaths android.InstallPaths
Jiyong Park8ba50f92019-11-13 15:01:01 +0900927 for _, extra := range a.extraOutputFiles {
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700928 installed := ctx.InstallFile(a.installDir, extra.Base(), extra)
929 extraInstalledPaths = append(extraInstalledPaths, installed)
Jiyong Park8ba50f92019-11-13 15:01:01 +0900930 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700931 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile, extraInstalledPaths...)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800932 }
Artur Satayev1111b842020-04-27 19:05:28 +0100933
934 a.buildAppDependencyInfo(ctx)
Spandan Das3490dfd2024-03-11 21:37:25 +0000935
936 providePrebuiltInfo(ctx,
937 prebuiltInfoProps{
938 baseModuleName: a.BaseModuleName(),
939 isPrebuilt: false,
940 },
941 )
Colin Cross30e076a2015-04-13 13:58:27 -0700942}
943
Colin Crossc2d24052020-05-13 11:05:02 -0700944type appDepsInterface interface {
Jiyong Park92315372021-04-02 08:45:46 +0900945 SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000946 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Colin Crossc2d24052020-05-13 11:05:02 -0700947 RequiresStableAPIs(ctx android.BaseModuleContext) bool
948}
949
950func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
951 shouldCollectRecursiveNativeDeps bool,
Sam Delmerico82602492022-06-10 17:05:42 +0000952 checkNativeSdkVersion bool) ([]jniLib, android.Paths, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700953
Colin Crossc2d24052020-05-13 11:05:02 -0700954 if checkNativeSdkVersion {
Jiyong Park92315372021-04-02 08:45:46 +0900955 checkNativeSdkVersion = app.SdkVersion(ctx).Specified() &&
956 app.SdkVersion(ctx).Kind != android.SdkCorePlatform && !app.RequiresStableAPIs(ctx)
Colin Crossc2d24052020-05-13 11:05:02 -0700957 }
Makoto Onuki2ca84272024-02-10 00:15:21 +0000958 jniLib, prebuiltJniPackages := collectJniDeps(ctx, shouldCollectRecursiveNativeDeps,
959 checkNativeSdkVersion, func(dep cc.LinkableInterface) bool {
960 return !dep.IsNdk(ctx.Config()) && !dep.IsStubs()
961 })
962
963 var certificates []Certificate
964
965 ctx.VisitDirectDeps(func(module android.Module) {
966 otherName := ctx.OtherModuleName(module)
967 tag := ctx.OtherModuleDependencyTag(module)
968
969 if tag == certificateTag {
970 if dep, ok := module.(*AndroidAppCertificate); ok {
971 certificates = append(certificates, dep.Certificate)
972 } else {
973 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
974 }
975 }
976 })
977 return jniLib, prebuiltJniPackages, certificates
978}
979
980func collectJniDeps(ctx android.ModuleContext,
981 shouldCollectRecursiveNativeDeps bool,
982 checkNativeSdkVersion bool,
983 filter func(cc.LinkableInterface) bool) ([]jniLib, android.Paths) {
984 var jniLibs []jniLib
985 var prebuiltJniPackages android.Paths
986 seenModulePaths := make(map[string]bool)
Colin Crossc2d24052020-05-13 11:05:02 -0700987
Peter Collingbournead84f972019-12-17 16:46:18 -0800988 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700989 otherName := ctx.OtherModuleName(module)
990 tag := ctx.OtherModuleDependencyTag(module)
991
Colin Crossf0913fb2020-07-29 12:59:39 -0700992 if IsJniDepTag(tag) || cc.IsSharedDepTag(tag) {
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400993 if dep, ok := module.(cc.LinkableInterface); ok {
Makoto Onuki2ca84272024-02-10 00:15:21 +0000994 if filter != nil && !filter(dep) {
Peter Collingbournead84f972019-12-17 16:46:18 -0800995 return false
996 }
997
Colin Crossa4f08812018-10-02 22:03:40 -0700998 lib := dep.OutputFile()
999 if lib.Valid() {
Cole Faust64cb7c92021-09-14 17:32:49 -07001000 path := lib.Path()
1001 if seenModulePaths[path.String()] {
1002 return false
1003 }
1004 seenModulePaths[path.String()] = true
1005
1006 if checkNativeSdkVersion && dep.SdkVersion() == "" {
1007 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
1008 otherName)
1009 }
1010
Colin Crossa4f08812018-10-02 22:03:40 -07001011 jniLibs = append(jniLibs, jniLib{
Colin Cross403cc152020-07-06 14:15:24 -07001012 name: ctx.OtherModuleName(module),
1013 path: path,
1014 target: module.Target(),
1015 coverageFile: dep.CoverageOutputFile(),
1016 unstrippedFile: dep.UnstrippedOutputFile(),
Jihoon Kangf78a8902022-09-01 22:47:07 +00001017 partition: dep.Partition(),
Colin Crossa4f08812018-10-02 22:03:40 -07001018 })
Colin Crossdd5261c2022-12-19 12:26:43 -08001019 } else if ctx.Config().AllowMissingDependencies() {
1020 ctx.AddMissingDependencies([]string{otherName})
Colin Crossa4f08812018-10-02 22:03:40 -07001021 } else {
1022 ctx.ModuleErrorf("dependency %q missing output file", otherName)
1023 }
1024 } else {
1025 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -07001026 }
Peter Collingbournead84f972019-12-17 16:46:18 -08001027
1028 return shouldCollectRecursiveNativeDeps
1029 }
1030
Colin Cross313aa542023-12-13 13:47:44 -08001031 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +00001032 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
1033 }
1034
Peter Collingbournead84f972019-12-17 16:46:18 -08001035 return false
Colin Crossa4f08812018-10-02 22:03:40 -07001036 })
1037
Makoto Onuki2ca84272024-02-10 00:15:21 +00001038 return jniLibs, prebuiltJniPackages
Colin Crossa4f08812018-10-02 22:03:40 -07001039}
1040
Jooyung Han749dc692020-04-15 11:03:39 +09001041func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +01001042 ctx.WalkDeps(func(child, parent android.Module) bool {
1043 isExternal := !a.DepIsInSameApex(ctx, child)
1044 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +09001045 if !do(ctx, parent, am, isExternal) {
1046 return false
1047 }
Artur Satayev1111b842020-04-27 19:05:28 +01001048 }
1049 return !isExternal
1050 })
1051}
1052
1053func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
1054 if ctx.Host() {
1055 return
1056 }
1057
1058 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001059 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +01001060 depName := to.Name()
Artur Satayev533b98c2021-03-11 18:03:42 +00001061
1062 // Skip dependencies that are only available to APEXes; they are developed with updatability
1063 // in mind and don't need manual approval.
1064 if to.(android.ApexModule).NotAvailableForPlatform() {
1065 return true
1066 }
1067
Artur Satayev1111b842020-04-27 19:05:28 +01001068 if info, exist := depsInfo[depName]; exist {
1069 info.From = append(info.From, from.Name())
1070 info.IsExternal = info.IsExternal && externalDep
1071 depsInfo[depName] = info
1072 } else {
1073 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001074 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001075 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001076 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001077 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1078 toMinSdkVersion = v.String()
Artur Satayev1111b842020-04-27 19:05:28 +01001079 }
Jiyong Park92315372021-04-02 08:45:46 +09001080 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1081 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1082 // string
1083 if v := m.MinSdkVersion(); v != "" {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001084 toMinSdkVersion = v
1085 }
Artur Satayev1111b842020-04-27 19:05:28 +01001086 }
1087 depsInfo[depName] = android.ApexModuleDepInfo{
1088 To: depName,
1089 From: []string{from.Name()},
1090 IsExternal: externalDep,
1091 MinSdkVersion: toMinSdkVersion,
1092 }
1093 }
Jooyung Han749dc692020-04-15 11:03:39 +09001094 return true
Artur Satayev1111b842020-04-27 19:05:28 +01001095 })
1096
Jiyong Park92315372021-04-02 08:45:46 +09001097 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depsInfo)
Artur Satayev1111b842020-04-27 19:05:28 +01001098}
1099
Harshit Mahajan5b8b7302022-06-10 11:24:05 +00001100func (a *AndroidApp) enforceDefaultTargetSdkVersion() bool {
1101 return a.appProperties.EnforceDefaultTargetSdkVersion
1102}
1103
1104func (a *AndroidApp) SetEnforceDefaultTargetSdkVersion(val bool) {
1105 a.appProperties.EnforceDefaultTargetSdkVersion = val
1106}
1107
Artur Satayev849f8442020-04-28 14:57:42 +01001108func (a *AndroidApp) Updatable() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001109 return Bool(a.appProperties.Updatable)
Artur Satayev849f8442020-04-28 14:57:42 +01001110}
1111
Spandan Das42e89502022-05-06 22:12:55 +00001112func (a *AndroidApp) SetUpdatable(val bool) {
1113 a.appProperties.Updatable = &val
1114}
1115
Colin Cross0ea8ba82019-06-06 14:33:29 -07001116func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001117 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
1118 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001119 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001120 }
Jaewoong Jung525443a2019-02-28 15:35:54 -08001121 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001122}
1123
Jiyong Park0f80c182020-01-31 02:49:53 +09001124func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1125 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
1126 return true
1127 }
1128 return a.Library.DepIsInSameApex(ctx, dep)
1129}
1130
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001131// For OutputFileProducer interface
1132func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
1133 switch tag {
Jared Duke34b080d2023-03-30 16:40:24 -07001134 // In some instances, it can be useful to reference the aapt-generated flags from another
1135 // target, e.g., system server implements services declared in the framework-res manifest.
1136 case ".aapt.proguardOptionsFile":
1137 return []android.Path{a.proguardOptionsFile}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001138 case ".aapt.srcjar":
Colin Crossf3b7bad2023-08-02 15:49:00 -07001139 if a.aaptSrcJar != nil {
1140 return []android.Path{a.aaptSrcJar}, nil
1141 }
1142 case ".aapt.jar":
1143 if a.rJar != nil {
1144 return []android.Path{a.rJar}, nil
1145 }
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001146 case ".apk":
1147 return []android.Path{a.outputFile}, nil
Anton Hansson092aca42020-08-13 19:37:22 +01001148 case ".export-package.apk":
1149 return []android.Path{a.exportPackage}, nil
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001150 case ".manifest.xml":
1151 return []android.Path{a.aapt.manifestPath}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001152 }
1153 return a.Library.OutputFiles(tag)
1154}
1155
Jiyong Parkf7487312019-10-17 12:54:30 +09001156func (a *AndroidApp) Privileged() bool {
1157 return Bool(a.appProperties.Privileged)
1158}
1159
Colin Crossf5f4ad32024-01-19 15:41:48 -08001160func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.IncomingTransitionContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001161 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001162}
1163
Ivan Lozanod7586b62021-04-01 09:49:36 -04001164func (a *AndroidApp) SetPreventInstall() {
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001165 a.appProperties.PreventInstall = true
1166}
1167
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001168func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
1169 a.appProperties.IsCoverageVariant = coverage
1170}
1171
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001172func (a *AndroidApp) EnableCoverageIfNeeded() {}
1173
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001174var _ cc.Coverage = (*AndroidApp)(nil)
1175
Colin Cross95b53b82023-10-17 13:21:02 -07001176func (a *AndroidApp) IDEInfo(dpInfo *android.IdeInfo) {
1177 a.Library.IDEInfo(dpInfo)
1178 a.aapt.IDEInfo(dpInfo)
1179}
1180
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001181func (a *AndroidApp) productCharacteristicsRROPackageName() string {
1182 return proptools.String(a.appProperties.ProductCharacteristicsRROPackageName)
1183}
1184
1185func (a *AndroidApp) productCharacteristicsRROManifestModuleName() string {
1186 return proptools.String(a.appProperties.ProductCharacteristicsRROManifestModuleName)
1187}
1188
Colin Cross1b16b0e2019-02-12 14:41:32 -08001189// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -07001190func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -07001191 module := &AndroidApp{}
1192
Liz Kammera7a64f32020-07-09 15:16:41 -07001193 module.Module.dexProperties.Optimize.EnabledByDefault = true
1194 module.Module.dexProperties.Optimize.Shrink = proptools.BoolPtr(true)
Jared Dukeaa88b3d2023-08-29 17:07:20 +00001195 module.Module.dexProperties.Optimize.Proguard_compatibility = proptools.BoolPtr(false)
Colin Cross66dbc0b2017-12-28 12:23:20 -08001196
Colin Crossae5caf52018-05-22 11:11:52 -07001197 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001198 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001199 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001200
Colin Crossce6734e2020-06-15 16:09:53 -07001201 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -07001202 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -07001203 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001204 &module.appProperties,
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001205 &module.overridableAppProperties,
1206 &module.Library.sourceProperties)
Colin Cross36242852017-06-23 15:06:31 -07001207
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001208 module.usesLibrary.enforce = true
1209
Colin Crossa4f08812018-10-02 22:03:40 -07001210 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1211 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001212 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001213 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001214
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001215 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1216 a := ctx.Module().(*AndroidApp)
1217
1218 characteristics := ctx.Config().ProductAAPTCharacteristics()
1219 if characteristics == "default" || characteristics == "" {
1220 module.appProperties.Generate_product_characteristics_rro = nil
1221 // no need to create RRO
1222 return
1223 }
1224
1225 if !proptools.Bool(module.appProperties.Generate_product_characteristics_rro) {
1226 return
1227 }
1228
1229 rroPackageName := a.Name() + "__" + strings.ReplaceAll(characteristics, ",", "_") + "__auto_generated_characteristics_rro"
1230 rroManifestName := rroPackageName + "_manifest"
1231
1232 a.appProperties.ProductCharacteristicsRROPackageName = proptools.StringPtr(rroPackageName)
1233 a.appProperties.ProductCharacteristicsRROManifestModuleName = proptools.StringPtr(rroManifestName)
1234
1235 rroManifestProperties := struct {
1236 Name *string
1237 Tools []string
1238 Out []string
1239 Srcs []string
1240 Cmd *string
1241 }{
1242 Name: proptools.StringPtr(rroManifestName),
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001243 Tools: []string{"characteristics_rro_generator", "aapt2"},
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001244 Out: []string{"AndroidManifest.xml"},
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001245 Srcs: []string{":" + a.Name() + "{.apk}"},
1246 Cmd: proptools.StringPtr("$(location characteristics_rro_generator) $$($(location aapt2) dump packagename $(in)) $(out)"),
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001247 }
1248 ctx.CreateModule(genrule.GenRuleFactory, &rroManifestProperties)
1249
1250 rroProperties := struct {
1251 Name *string
1252 Filter_product *string
1253 Aaptflags []string
1254 Manifest *string
1255 Resource_dirs []string
1256 }{
1257 Name: proptools.StringPtr(rroPackageName),
1258 Filter_product: proptools.StringPtr(characteristics),
1259 Aaptflags: []string{"--auto-add-overlay"},
1260 Manifest: proptools.StringPtr(":" + rroManifestName),
1261 Resource_dirs: a.aaptProperties.Resource_dirs,
1262 }
1263 ctx.CreateModule(RuntimeResourceOverlayFactory, &rroProperties)
1264 })
1265
Colin Cross36242852017-06-23 15:06:31 -07001266 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001267}
Colin Crossae5caf52018-05-22 11:11:52 -07001268
Alix96ea88452023-08-31 15:48:23 +00001269// A dictionary of values to be overridden in the manifest.
1270type Manifest_values struct {
1271 // Overrides the value of package_name in the manifest
1272 ApplicationId *string
1273}
1274
Colin Crossae5caf52018-05-22 11:11:52 -07001275type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001276 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001277 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001278
Seth Moorec6f4b532023-02-02 13:22:26 -08001279 // If specified, the instrumentation target package name in the manifest is overwritten by it.
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001280 Instrumentation_target_package *string
Seth Moorec6f4b532023-02-02 13:22:26 -08001281
1282 // If specified, the mainline module package name in the test config is overwritten by it.
1283 Mainline_package_name *string
Alix96ea88452023-08-31 15:48:23 +00001284
1285 Manifest_values Manifest_values
Colin Crossae5caf52018-05-22 11:11:52 -07001286}
1287
1288type AndroidTest struct {
1289 AndroidApp
1290
1291 appTestProperties appTestProperties
1292
1293 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001294
Dan Shi95d19422020-08-15 12:24:26 -07001295 testConfig android.Path
1296 extraTestConfigs android.Paths
1297 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001298}
1299
Jaewoong Jung0949f312019-09-11 10:25:18 -07001300func (a *AndroidTest) InstallInTestcases() bool {
1301 return true
1302}
1303
Spandan Das9f7ae7f2022-07-25 00:34:18 +00001304type androidTestApp interface {
1305 includedInTestSuite(searchPrefix string) bool
1306}
1307
1308func (a *AndroidTest) includedInTestSuite(searchPrefix string) bool {
1309 return android.PrefixInList(a.testProperties.Test_suites, searchPrefix)
1310}
1311
1312func (a *AndroidTestHelperApp) includedInTestSuite(searchPrefix string) bool {
1313 return android.PrefixInList(a.appTestHelperAppProperties.Test_suites, searchPrefix)
1314}
1315
Colin Crossae5caf52018-05-22 11:11:52 -07001316func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001317 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001318 if a.appTestProperties.Instrumentation_target_package != nil {
1319 a.additionalAaptFlags = append(a.additionalAaptFlags,
1320 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1321 } else if a.appTestProperties.Instrumentation_for != nil {
1322 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001323 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1324 if overridden {
1325 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1326 }
1327 }
Alix96ea88452023-08-31 15:48:23 +00001328 applicationId := a.appTestProperties.Manifest_values.ApplicationId
1329 if applicationId != nil {
1330 if a.overridableAppProperties.Package_name != nil {
1331 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
1332 }
1333 a.aapt.manifestValues.applicationId = *applicationId
1334 }
Colin Crossae5caf52018-05-22 11:11:52 -07001335 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001336
easoncylee5bcff5d2020-04-30 14:57:06 +08001337 for _, module := range a.testProperties.Test_mainline_modules {
1338 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1339 }
1340
Jaewoong Jung39982342020-01-14 10:27:18 -08001341 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001342 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001343 a.testConfig = a.FixTestConfig(ctx, testConfig)
Dan Shi95d19422020-08-15 12:24:26 -07001344 a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
Colin Cross8a497952019-03-05 22:25:09 -08001345 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross40213022023-12-13 15:19:49 -08001346 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Ronald Braunsteinfce43162024-02-02 12:37:20 -08001347 android.SetProvider(ctx, tradefed.BaseTestProviderKey, tradefed.BaseTestProviderData{
1348 InstalledFiles: a.data,
1349 OutputFile: a.OutputFile(),
1350 TestConfig: a.testConfig,
1351 HostRequiredModuleNames: a.HostRequiredModuleNames(),
Ronald Braunstein1a6e7c02024-03-14 21:14:39 +00001352 TestSuites: a.testProperties.Test_suites,
1353 IsHost: false,
Ronald Braunsteinfce43162024-02-02 12:37:20 -08001354 })
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001355 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
1356 TestOnly: true,
1357 TopLevelTarget: true,
1358 })
1359
Colin Cross303e21f2018-08-07 16:49:25 -07001360}
1361
Jaewoong Jung39982342020-01-14 10:27:18 -08001362func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1363 if testConfig == nil {
1364 return nil
1365 }
1366
1367 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
Colin Crossf1a035e2020-11-16 17:32:30 -08001368 rule := android.NewRuleBuilder(pctx, ctx)
1369 command := rule.Command().BuiltTool("test_config_fixer").Input(testConfig).Output(fixedConfig)
Jaewoong Jung39982342020-01-14 10:27:18 -08001370 fixNeeded := false
1371
Jooyung Han29e2f6d2022-01-08 12:13:59 +09001372 // 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 -08001373 if ctx.ModuleName() != a.installApkName {
1374 fixNeeded = true
1375 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1376 }
1377
1378 if a.overridableAppProperties.Package_name != nil {
1379 fixNeeded = true
1380 command.FlagWithInput("--manifest ", a.manifestPath).
1381 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1382 }
1383
Seth Moorec6f4b532023-02-02 13:22:26 -08001384 if a.appTestProperties.Mainline_package_name != nil {
1385 fixNeeded = true
1386 command.FlagWithArg("--mainline-package-name ", *a.appTestProperties.Mainline_package_name)
1387 }
1388
Jaewoong Jung39982342020-01-14 10:27:18 -08001389 if fixNeeded {
Colin Crossf1a035e2020-11-16 17:32:30 -08001390 rule.Build("fix_test_config", "fix test config")
Jaewoong Jung39982342020-01-14 10:27:18 -08001391 return fixedConfig
1392 }
1393 return testConfig
1394}
1395
Colin Cross303e21f2018-08-07 16:49:25 -07001396func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001397 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001398}
1399
1400func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1401 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001402 if a.appTestProperties.Instrumentation_for != nil {
1403 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1404 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1405 // use instrumentationForTag instead of libTag.
1406 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1407 }
Colin Crossae5caf52018-05-22 11:11:52 -07001408}
1409
Colin Cross1b16b0e2019-02-12 14:41:32 -08001410// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1411// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001412func AndroidTestFactory() android.Module {
1413 module := &AndroidTest{}
1414
Jared Duke63a3da92022-06-02 19:11:14 +00001415 module.Module.dexProperties.Optimize.EnabledByDefault = false
Colin Cross5067db92018-09-17 16:46:35 -07001416
1417 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001418 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001419 module.Module.properties.Installable = proptools.BoolPtr(true)
Jiyong Park20df11e2024-05-08 09:54:22 +00001420 module.appProperties.AllowCompressingNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001421 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001422 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001423
Colin Crossce6734e2020-06-15 16:09:53 -07001424 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001425 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001426 &module.aaptProperties,
1427 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001428 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001429 &module.overridableAppProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001430 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001431
Colin Crossa4f08812018-10-02 22:03:40 -07001432 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1433 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001434 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jingwen Chene12c0832023-08-25 09:00:16 +00001435
Colin Crossae5caf52018-05-22 11:11:52 -07001436 return module
1437}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001438
Colin Cross252fc6f2018-10-04 15:22:03 -07001439type appTestHelperAppProperties struct {
1440 // list of compatibility suites (for example "cts", "vts") that the module should be
1441 // installed into.
1442 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001443
1444 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1445 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1446 // explicitly.
1447 Auto_gen_config *bool
Colin Crosscfb0f5e2021-09-24 15:47:17 -07001448
1449 // Install the test into a folder named for the module in all test suites.
1450 Per_testcase_directory *bool
Alix96ea88452023-08-31 15:48:23 +00001451
1452 Manifest_values Manifest_values
Colin Cross252fc6f2018-10-04 15:22:03 -07001453}
1454
1455type AndroidTestHelperApp struct {
1456 AndroidApp
1457
1458 appTestHelperAppProperties appTestHelperAppProperties
1459}
1460
Jaewoong Jung326a9412019-11-21 10:41:00 -08001461func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1462 return true
1463}
1464
Colin Cross1b16b0e2019-02-12 14:41:32 -08001465// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1466// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1467// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001468func AndroidTestHelperAppFactory() android.Module {
1469 module := &AndroidTestHelperApp{}
1470
Jared Duke63a3da92022-06-02 19:11:14 +00001471 // TODO(b/192032291): Disable by default after auditing downstream usage.
Liz Kammera7a64f32020-07-09 15:16:41 -07001472 module.Module.dexProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001473
1474 module.Module.properties.Installable = proptools.BoolPtr(true)
Jiyong Park20df11e2024-05-08 09:54:22 +00001475 module.appProperties.AllowCompressingNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001476 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001477 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross252fc6f2018-10-04 15:22:03 -07001478
Colin Crossce6734e2020-06-15 16:09:53 -07001479 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001480 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001481 &module.aaptProperties,
1482 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001483 &module.appTestHelperAppProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001484 &module.overridableAppProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001485
1486 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1487 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001488 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001489 return module
1490}
1491
Colin Crossbd01e2a2018-10-04 15:21:03 -07001492type AndroidAppCertificate struct {
1493 android.ModuleBase
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001494
Colin Crossbd01e2a2018-10-04 15:21:03 -07001495 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001496 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001497}
1498
1499type AndroidAppCertificateProperties struct {
1500 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1501 Certificate *string
1502}
1503
Colin Cross1b16b0e2019-02-12 14:41:32 -08001504// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1505// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001506func AndroidAppCertificateFactory() android.Module {
1507 module := &AndroidAppCertificate{}
1508 module.AddProperties(&module.properties)
1509 android.InitAndroidModule(module)
1510 return module
1511}
1512
Colin Crossbd01e2a2018-10-04 15:21:03 -07001513func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1514 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001515 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001516 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1517 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001518 }
1519}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001520
1521type OverrideAndroidApp struct {
1522 android.ModuleBase
1523 android.OverrideModuleBase
1524}
1525
Sasha Smundak613cbb12020-06-05 10:27:23 -07001526func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001527 // All the overrides happen in the base module.
1528 // TODO(jungjw): Check the base module type.
1529}
1530
1531// override_android_app is used to create an android_app module based on another android_app by overriding
1532// some of its properties.
1533func OverrideAndroidAppModuleFactory() android.Module {
1534 m := &OverrideAndroidApp{}
Jooyung Han01d80d82022-01-08 12:16:32 +09001535 m.AddProperties(
yangbill2af0b6e2024-03-15 09:29:29 +00001536 &OverridableProperties{},
Jooyung Han01d80d82022-01-08 12:16:32 +09001537 &overridableAppProperties{},
1538 )
Jaewoong Jung525443a2019-02-28 15:35:54 -08001539
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001540 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001541 android.InitOverrideModule(m)
1542 return m
1543}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001544
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001545type OverrideAndroidTest struct {
1546 android.ModuleBase
1547 android.OverrideModuleBase
1548}
1549
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001550func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001551 // All the overrides happen in the base module.
1552 // TODO(jungjw): Check the base module type.
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001553 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
1554 TestOnly: true,
1555 TopLevelTarget: true,
1556 })
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001557}
1558
1559// override_android_test is used to create an android_app module based on another android_test by overriding
1560// some of its properties.
1561func OverrideAndroidTestModuleFactory() android.Module {
1562 m := &OverrideAndroidTest{}
1563 m.AddProperties(&overridableAppProperties{})
1564 m.AddProperties(&appTestProperties{})
1565
1566 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1567 android.InitOverrideModule(m)
1568 return m
1569}
1570
Colin Cross50ddcc42019-05-16 12:28:22 -07001571type UsesLibraryProperties struct {
1572 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1573 Uses_libs []string
1574
1575 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1576 // required=false.
1577 Optional_uses_libs []string
1578
1579 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1580 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1581 Enforce_uses_libs *bool
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001582
Ulya Trafimovich54027b52020-09-09 14:08:23 +01001583 // Optional name of the <uses-library> provided by this module. This is needed for non-SDK
1584 // libraries, because SDK ones are automatically picked up by Soong. The <uses-library> name
1585 // normally is the same as the module name, but there are exceptions.
1586 Provides_uses_lib *string
Paul Duffin06530572022-02-03 17:54:15 +00001587
1588 // A list of shared library names to exclude from the classpath of the APK. Adding a library here
1589 // will prevent it from being used when precompiling the APK and prevent it from being implicitly
1590 // added to the APK's manifest's <uses-library> elements.
1591 //
1592 // Care must be taken when using this as it could result in runtime errors if the APK actually
1593 // uses classes provided by the library and which are not provided in any other way.
1594 //
1595 // This is primarily intended for use by various CTS tests that check the runtime handling of the
1596 // android.test.base shared library (and related libraries) but which depend on some common
1597 // libraries that depend on the android.test.base library. Without this those tests will end up
1598 // with a <uses-library android:name="android.test.base"/> in their manifest which would either
1599 // render the tests worthless (as they would be testing the wrong behavior), or would break the
1600 // test altogether by providing access to classes that the tests were not expecting. Those tests
1601 // provide the android.test.base statically and use jarjar to rename them so they do not collide
1602 // with the classes provided by the android.test.base library.
1603 Exclude_uses_libs []string
Jiakai Zhangf98da192024-04-15 11:15:41 +00001604
1605 // The module names of optional uses-library libraries that are missing from the source tree.
1606 Missing_optional_uses_libs []string `blueprint:"mutated"`
Colin Cross50ddcc42019-05-16 12:28:22 -07001607}
1608
1609// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1610// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1611// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1612// with knowledge of their shared libraries.
1613type usesLibrary struct {
1614 usesLibraryProperties UsesLibraryProperties
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001615
1616 // Whether to enforce verify_uses_library check.
1617 enforce bool
Spandan Das0727ba72024-02-13 16:37:43 +00001618
1619 // Whether dexpreopt should be disabled
1620 shouldDisableDexpreopt bool
Colin Cross50ddcc42019-05-16 12:28:22 -07001621}
1622
Colin Cross4a80a152022-12-21 21:51:52 -08001623func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, addCompatDeps bool) {
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001624 if !ctx.Config().UnbundledBuild() || ctx.Config().UnbundledBuildImage() {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001625 ctx.AddVariationDependencies(nil, usesLibReqTag, u.usesLibraryProperties.Uses_libs...)
Jiakai Zhangf98da192024-04-15 11:15:41 +00001626 presentOptionalUsesLibs := u.presentOptionalUsesLibs(ctx)
1627 ctx.AddVariationDependencies(nil, usesLibOptTag, presentOptionalUsesLibs...)
Colin Cross4a80a152022-12-21 21:51:52 -08001628 // Only add these extra dependencies if the module is an app that depends on framework
1629 // libs. This avoids creating a cyclic dependency:
Paul Duffin250e6192019-06-07 10:44:37 +01001630 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
Colin Cross4a80a152022-12-21 21:51:52 -08001631 if addCompatDeps {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001632 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1633 // class loader context for dex2oat. Add them as a dependency with a special tag.
1634 ctx.AddVariationDependencies(nil, usesLibCompat29ReqTag, dexpreopt.CompatUsesLibs29...)
1635 ctx.AddVariationDependencies(nil, usesLibCompat28OptTag, dexpreopt.OptionalCompatUsesLibs28...)
1636 ctx.AddVariationDependencies(nil, usesLibCompat30OptTag, dexpreopt.OptionalCompatUsesLibs30...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001637 }
Jiakai Zhangf98da192024-04-15 11:15:41 +00001638 _, diff, _ := android.ListSetDifference(u.usesLibraryProperties.Optional_uses_libs, presentOptionalUsesLibs)
1639 u.usesLibraryProperties.Missing_optional_uses_libs = diff
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001640 } else {
1641 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.usesLibraryProperties.Uses_libs...)
1642 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross50ddcc42019-05-16 12:28:22 -07001643 }
1644}
1645
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001646// presentOptionalUsesLibs returns optional_uses_libs after filtering out libraries that don't exist in the source tree.
Colin Cross50ddcc42019-05-16 12:28:22 -07001647func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001648 optionalUsesLibs := android.FilterListPred(u.usesLibraryProperties.Optional_uses_libs, func(s string) bool {
1649 exists := ctx.OtherModuleExists(s)
Jiakai Zhang48203e32023-06-02 23:42:21 +01001650 if !exists && !android.InList(ctx.ModuleName(), ctx.Config().BuildWarningBadOptionalUsesLibsAllowlist()) {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001651 fmt.Printf("Warning: Module '%s' depends on non-existing optional_uses_libs '%s'\n", ctx.ModuleName(), s)
1652 }
1653 return exists
1654 })
Colin Cross50ddcc42019-05-16 12:28:22 -07001655 return optionalUsesLibs
1656}
1657
Ulya Trafimovich24446712021-07-15 14:59:34 +01001658// Returns a map of module names of shared library dependencies to the paths to their dex jars on
1659// host and on device.
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001660func (u *usesLibrary) classLoaderContextForUsesLibDeps(ctx android.ModuleContext) dexpreopt.ClassLoaderContextMap {
1661 clcMap := make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich24446712021-07-15 14:59:34 +01001662
1663 // Skip when UnbundledBuild() is true, but UnbundledBuildImage() is false. With
1664 // UnbundledBuildImage() it is necessary to generate dexpreopt.config for post-dexpreopting.
1665 if ctx.Config().UnbundledBuild() && !ctx.Config().UnbundledBuildImage() {
1666 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001667 }
1668
Ulya Trafimovich24446712021-07-15 14:59:34 +01001669 ctx.VisitDirectDeps(func(m android.Module) {
1670 tag, isUsesLibTag := ctx.OtherModuleDependencyTag(m).(usesLibraryDependencyTag)
1671 if !isUsesLibTag {
1672 return
1673 }
1674
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001675 dep := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(m))
Ulya Trafimovich24446712021-07-15 14:59:34 +01001676
Ulya Trafimovich840efb62021-07-15 14:34:40 +01001677 // Skip stub libraries. A dependency on the implementation library has been added earlier,
1678 // so it will be added to CLC, but the stub shouldn't be. Stub libraries can be distingushed
1679 // from implementation libraries by their name, which is different as it has a suffix.
1680 if comp, ok := m.(SdkLibraryComponentDependency); ok {
1681 if impl := comp.OptionalSdkLibraryImplementation(); impl != nil && *impl != dep {
1682 return
1683 }
1684 }
1685
Spandan Das0727ba72024-02-13 16:37:43 +00001686 // Skip java_sdk_library dependencies that provide stubs, but not an implementation.
1687 // This will be restricted to optional_uses_libs
1688 if sdklib, ok := m.(SdkLibraryDependency); ok {
1689 if tag == usesLibOptTag && sdklib.DexJarBuildPath(ctx).PathOrNil() == nil {
1690 u.shouldDisableDexpreopt = true
1691 return
1692 }
1693 }
1694
Ulya Trafimovich24446712021-07-15 14:59:34 +01001695 if lib, ok := m.(UsesLibraryDependency); ok {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001696 libName := dep
Ulya Trafimovich24446712021-07-15 14:59:34 +01001697 if ulib, ok := m.(ProvidesUsesLib); ok && ulib.ProvidesUsesLib() != nil {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001698 libName = *ulib.ProvidesUsesLib()
Ulya Trafimovich24446712021-07-15 14:59:34 +01001699 }
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001700 clcMap.AddContext(ctx, tag.sdkVersion, libName, tag.optional,
Spandan Das59a4a2b2024-01-09 21:35:56 +00001701 lib.DexJarBuildPath(ctx).PathOrNil(), lib.DexJarInstallPath(),
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001702 lib.ClassLoaderContexts())
Ulya Trafimovich24446712021-07-15 14:59:34 +01001703 } else if ctx.Config().AllowMissingDependencies() {
1704 ctx.AddMissingDependencies([]string{dep})
1705 } else {
1706 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", dep)
1707 }
1708 })
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001709 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001710}
1711
1712// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1713// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1714// unconditionally in the future.
1715func (u *usesLibrary) enforceUsesLibraries() bool {
1716 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1717 len(u.usesLibraryProperties.Optional_uses_libs) > 0
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001718 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, u.enforce || defaultEnforceUsesLibs)
Colin Cross50ddcc42019-05-16 12:28:22 -07001719}
1720
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001721// Freeze the value of `enforce_uses_libs` based on the current values of `uses_libs` and `optional_uses_libs`.
1722func (u *usesLibrary) freezeEnforceUsesLibraries() {
1723 enforce := u.enforceUsesLibraries()
1724 u.usesLibraryProperties.Enforce_uses_libs = &enforce
1725}
1726
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001727// verifyUsesLibraries checks the <uses-library> tags in the manifest against the ones specified
1728// in the `uses_libs`/`optional_uses_libs` properties. The input can be either an XML manifest, or
1729// an APK with the manifest embedded in it (manifest_check will know which one it is by the file
1730// extension: APKs are supposed to end with '.apk').
1731func (u *usesLibrary) verifyUsesLibraries(ctx android.ModuleContext, inputFile android.Path,
Jiakai Zhangf98da192024-04-15 11:15:41 +00001732 outputFile android.WritablePath, classLoaderContexts *dexpreopt.ClassLoaderContextMap) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001733
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001734 statusFile := dexpreopt.UsesLibrariesStatusFile(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001735
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001736 // Disable verify_uses_libraries check if dexpreopt is globally disabled. Without dexpreopt the
1737 // check is not necessary, and although it is good to have, it is difficult to maintain on
1738 // non-linux build platforms where dexpreopt is generally disabled (the check may fail due to
1739 // various unrelated reasons, such as a failure to get manifest from an APK).
Ulya Trafimovich39dd0a42021-03-29 14:57:34 +01001740 global := dexpreopt.GetGlobalConfig(ctx)
Jiakai Zhang23984422023-11-09 16:47:04 +00001741 if global.DisablePreopt || global.OnlyPreoptArtBootImage {
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001742 return inputFile
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001743 }
1744
Colin Crossf1a035e2020-11-16 17:32:30 -08001745 rule := android.NewRuleBuilder(pctx, ctx)
1746 cmd := rule.Command().BuiltTool("manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001747 Flag("--enforce-uses-libraries").
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001748 Input(inputFile).
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001749 FlagWithOutput("--enforce-uses-libraries-status ", statusFile).
Saeid Farivar Asanjanfd27c7c2022-08-08 20:21:26 +00001750 FlagWithInput("--aapt ", ctx.Config().HostToolPath(ctx, "aapt2"))
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001751
1752 if outputFile != nil {
1753 cmd.FlagWithOutput("-o ", outputFile)
1754 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001755
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001756 if dexpreopt.GetGlobalConfig(ctx).RelaxUsesLibraryCheck {
1757 cmd.Flag("--enforce-uses-libraries-relax")
1758 }
1759
Jiakai Zhangf98da192024-04-15 11:15:41 +00001760 requiredUsesLibs, optionalUsesLibs := classLoaderContexts.UsesLibs()
1761 for _, lib := range requiredUsesLibs {
Colin Cross50ddcc42019-05-16 12:28:22 -07001762 cmd.FlagWithArg("--uses-library ", lib)
1763 }
Jiakai Zhangf98da192024-04-15 11:15:41 +00001764 for _, lib := range optionalUsesLibs {
Colin Cross50ddcc42019-05-16 12:28:22 -07001765 cmd.FlagWithArg("--optional-uses-library ", lib)
1766 }
1767
Jiakai Zhangf98da192024-04-15 11:15:41 +00001768 // Also add missing optional uses libs, as the manifest check expects them.
1769 // Note that what we add here are the module names of those missing libs, not library names, while
1770 // the manifest check actually expects library names. However, the case where a library is missing
1771 // and the module name != the library name is too rare for us to handle.
1772 for _, lib := range u.usesLibraryProperties.Missing_optional_uses_libs {
1773 cmd.FlagWithArg("--missing-optional-uses-library ", lib)
1774 }
1775
Colin Crossf1a035e2020-11-16 17:32:30 -08001776 rule.Build("verify_uses_libraries", "verify <uses-library>")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001777 return outputFile
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001778}
Colin Cross50ddcc42019-05-16 12:28:22 -07001779
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001780// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against
1781// the build system and returns the path to a copy of the manifest.
Jiakai Zhangf98da192024-04-15 11:15:41 +00001782func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path,
1783 classLoaderContexts *dexpreopt.ClassLoaderContextMap) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001784 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
Jiakai Zhangf98da192024-04-15 11:15:41 +00001785 return u.verifyUsesLibraries(ctx, manifest, outputFile, classLoaderContexts)
Colin Cross50ddcc42019-05-16 12:28:22 -07001786}
1787
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001788// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the build
1789// system and returns the path to a copy of the APK.
Jiakai Zhangf98da192024-04-15 11:15:41 +00001790func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path,
1791 classLoaderContexts *dexpreopt.ClassLoaderContextMap) {
1792 u.verifyUsesLibraries(ctx, apk, nil, classLoaderContexts) // for APKs manifest_check does not write output file
Colin Cross50ddcc42019-05-16 12:28:22 -07001793}