blob: b3d76da5386d4d76884232807b6e8515169ae8cd [file] [log] [blame]
Colin Cross30e076a2015-04-13 13:58:27 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
Jaewoong Jungf9b44652020-12-21 12:29:12 -080017// This file contains the module implementations for android_app, android_test, and some more
18// related module types, including their override variants.
Colin Cross30e076a2015-04-13 13:58:27 -070019
20import (
Jiakai Zhang4f65a032023-06-01 15:16:58 +010021 "fmt"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070022 "path/filepath"
Jaewoong Junga5e5abc2019-04-26 14:31:50 -070023 "strings"
Colin Cross30e076a2015-04-13 13:58:27 -070024
Aditya Choudhary9b593522023-10-06 19:54:58 +000025 "android/soong/testing"
Jihoon Kang84b25892023-12-01 22:01:06 +000026
Colin Cross50ddcc42019-05-16 12:28:22 -070027 "github.com/google/blueprint"
28 "github.com/google/blueprint/proptools"
29
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Crossa4f08812018-10-02 22:03:40 -070031 "android/soong/cc"
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +010032 "android/soong/dexpreopt"
Romain Jobredeaux9973ace2023-08-30 00:27:09 -040033 "android/soong/genrule"
Colin Cross303e21f2018-08-07 16:49:25 -070034 "android/soong/tradefed"
Colin Cross30e076a2015-04-13 13:58:27 -070035)
36
Colin Cross3bc7ffa2017-11-22 16:19:37 -080037func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000038 RegisterAppBuildComponents(android.InitRegistrationContext)
Andrei Onea580636b2022-08-17 16:53:46 +000039 pctx.HostBinToolVariable("ModifyAllowlistCmd", "modify_permissions_allowlist")
Colin Cross3bc7ffa2017-11-22 16:19:37 -080040}
41
Andrei Onea580636b2022-08-17 16:53:46 +000042var (
43 modifyAllowlist = pctx.AndroidStaticRule("modifyAllowlist",
44 blueprint.RuleParams{
45 Command: "${ModifyAllowlistCmd} $in $packageName $out",
46 CommandDeps: []string{"${ModifyAllowlistCmd}"},
47 }, "packageName")
48)
49
Paul Duffinf9b1da02019-12-18 19:51:55 +000050func RegisterAppBuildComponents(ctx android.RegistrationContext) {
51 ctx.RegisterModuleType("android_app", AndroidAppFactory)
52 ctx.RegisterModuleType("android_test", AndroidTestFactory)
53 ctx.RegisterModuleType("android_test_helper_app", AndroidTestHelperAppFactory)
54 ctx.RegisterModuleType("android_app_certificate", AndroidAppCertificateFactory)
55 ctx.RegisterModuleType("override_android_app", OverrideAndroidAppModuleFactory)
56 ctx.RegisterModuleType("override_android_test", OverrideAndroidTestModuleFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000057}
58
Colin Cross30e076a2015-04-13 13:58:27 -070059// AndroidManifest.xml merging
60// package splits
61
Colin Crossfabb6082018-02-20 17:22:23 -080062type appProperties struct {
Colin Crossbd01e2a2018-10-04 15:21:03 -070063 // Names of extra android_app_certificate modules to sign the apk with in the form ":module".
Colin Cross7d5136f2015-05-11 13:39:40 -070064 Additional_certificates []string
65
66 // If set, create package-export.apk, which other packages can
67 // use to get PRODUCT-agnostic resource data like IDs and type definitions.
Nan Zhangea568a42017-11-08 21:20:04 -080068 Export_package_resources *bool
Colin Cross7d5136f2015-05-11 13:39:40 -070069
Colin Cross16056062017-12-13 22:46:28 -080070 // Specifies that this app should be installed to the priv-app directory,
71 // where the system will grant it additional privileges not available to
72 // normal apps.
73 Privileged *bool
Colin Crossa97c5d32018-03-28 14:58:31 -070074
75 // list of resource labels to generate individual resource packages
76 Package_splits []string
Jason Monkd4122be2018-08-10 09:33:36 -040077
Colin Crossa4f08812018-10-02 22:03:40 -070078 // list of native libraries that will be provided in or alongside the resulting jar
79 Jni_libs []string `android:"arch_variant"`
80
Colin Cross7204cf02020-05-06 17:51:39 -070081 // if true, use JNI libraries that link against platform APIs even if this module sets
Colin Crossee87c602020-02-19 16:57:15 -080082 // sdk_version.
83 Jni_uses_platform_apis *bool
84
Colin Cross7204cf02020-05-06 17:51:39 -070085 // if true, use JNI libraries that link against SDK APIs even if this module does not set
86 // sdk_version.
87 Jni_uses_sdk_apis *bool
88
Jaewoong Jungbc625cd2019-05-06 15:48:44 -070089 // STL library to use for JNI libraries.
90 Stl *string `android:"arch_variant"`
91
Colin Crosse4246ab2019-02-05 21:55:21 -080092 // Store native libraries uncompressed in the APK and set the android:extractNativeLibs="false" manifest
93 // flag so that they are used from inside the APK at runtime. Defaults to true for android_test modules unless
Jiyong Park52cd06f2019-11-11 10:14:32 +090094 // sdk_version or min_sdk_version is set to a version that doesn't support it (<23), defaults to true for
95 // android_app modules that are embedded to APEXes, defaults to false for other module types where the native
96 // libraries are generally preinstalled outside the APK.
Colin Crosse4246ab2019-02-05 21:55:21 -080097 Use_embedded_native_libs *bool
Colin Cross46abdad2019-02-07 13:07:08 -080098
99 // Store dex files uncompressed in the APK and set the android:useEmbeddedDex="true" manifest attribute so that
100 // they are used from inside the APK at runtime.
101 Use_embedded_dex *bool
Colin Cross47fa9d32019-03-26 10:51:39 -0700102
103 // Forces native libraries to always be packaged into the APK,
104 // Use_embedded_native_libs still selects whether they are stored uncompressed and aligned or compressed.
105 // True for android_test* modules.
106 AlwaysPackageNativeLibs bool `blueprint:"mutated"`
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700107
108 // If set, find and merge all NOTICE files that this module and its dependencies have and store
109 // it in the APK as an asset.
110 Embed_notices *bool
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700111
112 // cc.Coverage related properties
113 PreventInstall bool `blueprint:"mutated"`
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700114 IsCoverageVariant bool `blueprint:"mutated"`
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100115
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000116 // It can be set to test the behaviour of default target sdk version.
117 // Only required when updatable: false. It is an error if updatable: true and this is false.
118 Enforce_default_target_sdk_version *bool
119
120 // If set, the targetSdkVersion for the target is set to the latest default API level.
121 // This would be by default false, unless updatable: true or
122 // enforce_default_target_sdk_version: true in which case this defaults to true.
123 EnforceDefaultTargetSdkVersion bool `blueprint:"mutated"`
124
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100125 // Whether this app is considered mainline updatable or not. When set to true, this will enforce
Artur Satayevf40fc852020-04-16 13:43:02 +0100126 // additional rules to make sure an app can safely be updated. Default is false.
127 // Prefer using other specific properties if build behaviour must be changed; avoid using this
128 // flag for anything but neverallow rules (unless the behaviour change is invisible to owners).
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100129 Updatable *bool
Andrei Onea580636b2022-08-17 16:53:46 +0000130
131 // Specifies the file that contains the allowlist for this app.
132 Privapp_allowlist *string `android:"path"`
Inseob Kim34dc4cd2023-11-07 13:37:14 +0900133
134 // If set, create an RRO package which contains only resources having PRODUCT_CHARACTERISTICS
135 // and install the RRO package to /product partition, instead of passing --product argument
136 // to aapt2. Default is false.
137 // Setting this will make this APK identical to all targets, regardless of
138 // PRODUCT_CHARACTERISTICS.
139 Generate_product_characteristics_rro *bool
140
141 ProductCharacteristicsRROPackageName *string `blueprint:"mutated"`
142 ProductCharacteristicsRROManifestModuleName *string `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700143}
144
Jaewoong Jung525443a2019-02-28 15:35:54 -0800145// android_app properties that can be overridden by override_android_app
146type overridableAppProperties struct {
147 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
148 // or an android_app_certificate module name in the form ":module".
149 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700150
Jaewoong Jung1c1b6e62021-03-09 15:02:31 -0800151 // Name of the signing certificate lineage file or filegroup module.
152 Lineage *string `android:"path"`
Liz Kammere2b27f42020-05-07 13:24:05 -0700153
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400154 // For overriding the --rotation-min-sdk-version property of apksig
155 RotationMinSdkVersion *string
156
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700157 // the package name of this app. The package name in the manifest file is used if one was not given.
158 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800159
160 // the logging parent of this app.
161 Logging_parent *string
Liz Kammer9f9fd022020-06-18 19:44:06 +0000162
163 // Whether to rename the package in resources to the override name rather than the base name. Defaults to true.
164 Rename_resources_package *bool
zhidou198f5892022-02-17 02:33:12 +0000165
166 // Names of modules to be overridden. Listed modules can only be other binaries
167 // (in Make or Soong).
168 // This does not completely prevent installation of the overridden binaries, but if both
169 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
170 // from PRODUCT_PACKAGES.
171 Overrides []string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800172}
173
Colin Cross30e076a2015-04-13 13:58:27 -0700174type AndroidApp struct {
Colin Crossa97c5d32018-03-28 14:58:31 -0700175 Library
176 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800177 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700178
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900179 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700180
Colin Crossfabb6082018-02-20 17:22:23 -0800181 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700182
Jaewoong Jung525443a2019-02-28 15:35:54 -0800183 overridableAppProperties overridableAppProperties
184
Colin Cross403cc152020-07-06 14:15:24 -0700185 jniLibs []jniLib
186 installPathForJNISymbols android.Path
187 embeddedJniLibs bool
188 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700189
190 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800191
192 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
193 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800194
Colin Cross70dda7e2019-10-01 22:05:35 -0700195 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700196
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700197 onDeviceDir string
198
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800199 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700200
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900201 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100202
203 android.ApexBundleDepsInfo
Matt Banda8c801262022-04-01 17:48:31 +0000204
205 javaApiUsedByOutputFile android.ModuleOutPath
Andrei Onea580636b2022-08-17 16:53:46 +0000206
207 privAppAllowlist android.OptionalPath
Colin Crosse1731a52017-12-14 11:22:55 -0800208}
209
Martin Stjernholm6d415272020-01-31 17:10:36 +0000210func (a *AndroidApp) IsInstallable() bool {
211 return Bool(a.properties.Installable)
212}
213
Colin Crossab8d1382023-07-14 17:23:41 +0000214func (a *AndroidApp) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
215 return a.aapt.resourcesNodesDepSet
Colin Cross66f78822018-05-02 12:58:28 -0700216}
217
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900218func (a *AndroidApp) OutputFile() android.Path {
219 return a.outputFile
220}
221
Colin Cross503c1d02020-01-28 14:00:53 -0800222func (a *AndroidApp) Certificate() Certificate {
223 return a.certificate
224}
225
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700226func (a *AndroidApp) JniCoverageOutputs() android.Paths {
227 return a.jniCoverageOutputs
228}
229
Andrei Onea580636b2022-08-17 16:53:46 +0000230func (a *AndroidApp) PrivAppAllowlist() android.OptionalPath {
231 return a.privAppAllowlist
232}
233
Colin Crossa97c5d32018-03-28 14:58:31 -0700234var _ AndroidLibraryDependency = (*AndroidApp)(nil)
235
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900236type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800237 Pem, Key android.Path
238 presigned bool
239}
240
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700241var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800242
243func (c Certificate) AndroidMkString() string {
244 if c.presigned {
245 return "PRESIGNED"
246 } else {
247 return c.Pem.String()
248 }
Colin Cross30e076a2015-04-13 13:58:27 -0700249}
250
Colin Cross46c9b8b2017-06-22 16:51:17 -0700251func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
Jiyong Park92315372021-04-02 08:45:46 +0900252 if String(a.appProperties.Stl) == "c++_shared" && !a.SdkVersion(ctx).Specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700253 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
254 }
255
Jiyong Parkf1691d22021-03-29 20:11:58 +0900256 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Jiakai Zhang2665d272024-03-28 11:52:08 +0000257 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
258 a.Module.deps(ctx)
Paul Duffin250e6192019-06-07 10:44:37 +0100259 if sdkDep.hasFrameworkLibs() {
260 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700261 }
Colin Crossa4f08812018-10-02 22:03:40 -0700262
Jiyong Park92315372021-04-02 08:45:46 +0900263 usesSDK := a.SdkVersion(ctx).Specified() && a.SdkVersion(ctx).Kind != android.SdkCorePlatform
Colin Cross3c007702020-05-08 11:20:24 -0700264
265 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
266 ctx.PropertyErrorf("jni_uses_sdk_apis",
267 "can only be set for modules that do not set sdk_version")
268 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
269 ctx.PropertyErrorf("jni_uses_platform_apis",
270 "can only be set for modules that set sdk_version")
271 }
272
Colin Crossa4f08812018-10-02 22:03:40 -0700273 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700274 variation := append(jniTarget.Variations(),
275 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000276
277 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
278 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700279 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
280 // have stable APIs through the VNDK.
281 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
282 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700283 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000284 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
285 }
Colin Crossde78d132020-10-09 18:59:49 -0700286 ctx.AddFarVariationDependencies(variation, jniLibTag, a.appProperties.Jni_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700287 }
Jihoon Kang9049c272024-03-19 21:57:36 +0000288 for _, aconfig_declaration := range a.aaptProperties.Flags_packages {
289 ctx.AddDependency(ctx.Module(), aconfigDeclarationTag, aconfig_declaration)
290 }
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700291}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700292
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700293func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800294 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700295 if cert != "" {
296 ctx.AddDependency(ctx.Module(), certificateTag, cert)
297 }
298
Andrei Onea580636b2022-08-17 16:53:46 +0000299 if a.appProperties.Privapp_allowlist != nil && !Bool(a.appProperties.Privileged) {
Anton Hanssone3f31cf2023-06-03 08:53:47 +0000300 // There are a few uids that are explicitly considered privileged regardless of their
301 // app's location. Bluetooth is one such app. It should arguably be moved to priv-app,
302 // but for now, allow it not to be in priv-app.
303 privilegedBecauseOfUid := ctx.ModuleName() == "Bluetooth"
304 if !privilegedBecauseOfUid {
305 ctx.PropertyErrorf("privapp_allowlist", "privileged must be set in order to use privapp_allowlist (with a few exceptions)")
306 }
Andrei Onea580636b2022-08-17 16:53:46 +0000307 }
308
Colin Crossbd01e2a2018-10-04 15:21:03 -0700309 for _, cert := range a.appProperties.Additional_certificates {
310 cert = android.SrcIsModule(cert)
311 if cert != "" {
312 ctx.AddDependency(ctx.Module(), certificateTag, cert)
313 } else {
314 ctx.PropertyErrorf("additional_certificates",
315 `must be names of android_app_certificate modules in the form ":module"`)
316 }
317 }
Colin Cross30e076a2015-04-13 13:58:27 -0700318}
319
Jeongik Cha538c0d02019-07-11 15:54:27 +0900320func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Alix96ea88452023-08-31 15:48:23 +0000321 applicationId := a.appTestHelperAppProperties.Manifest_values.ApplicationId
322 if applicationId != nil {
323 if a.overridableAppProperties.Package_name != nil {
324 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
325 }
326 a.aapt.manifestValues.applicationId = *applicationId
327 }
Jeongik Cha538c0d02019-07-11 15:54:27 +0900328 a.generateAndroidBuildActions(ctx)
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700329 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
330 TestOnly: true,
331 })
332
Jeongik Cha538c0d02019-07-11 15:54:27 +0900333}
334
Colin Cross46c9b8b2017-06-22 16:51:17 -0700335func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100336 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700337 a.generateAndroidBuildActions(ctx)
Matt Banda8c801262022-04-01 17:48:31 +0000338 a.generateJavaUsedByApex(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700339}
340
Sam Delmerico0e0d96e2023-08-18 22:43:28 +0000341func (a *AndroidApp) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
342 defaultMinSdkVersion := a.Module.MinSdkVersion(ctx)
343 if proptools.Bool(a.appProperties.Updatable) {
344 overrideApiLevel := android.MinSdkVersionFromValue(ctx, ctx.DeviceConfig().ApexGlobalMinSdkVersionOverride())
345 if !overrideApiLevel.IsNone() && overrideApiLevel.CompareTo(defaultMinSdkVersion) > 0 {
346 return overrideApiLevel
347 }
348 }
349 return defaultMinSdkVersion
350}
351
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100352func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100353 if a.Updatable() {
Jiyong Park92315372021-04-02 08:45:46 +0900354 if !a.SdkVersion(ctx).Stable() {
355 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.SdkVersion(ctx))
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100356 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100357 if String(a.deviceProperties.Min_sdk_version) == "" {
358 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
359 }
Jooyung Han749dc692020-04-15 11:03:39 +0900360
Jiyong Park92315372021-04-02 08:45:46 +0900361 if minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx); err == nil {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900362 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
satayevb3fd4112021-12-02 13:59:35 +0000363 android.CheckMinSdkVersion(ctx, minSdkVersion, a.WalkPayloadDeps)
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900364 } else {
365 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
366 }
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000367
368 if !BoolDefault(a.appProperties.Enforce_default_target_sdk_version, true) {
369 ctx.PropertyErrorf("enforce_default_target_sdk_version", "Updatable apps must enforce default target sdk version")
370 }
371 // TODO(b/227460469) after all the modules removes the target sdk version, throw an error if the target sdk version is explicitly set.
372 if a.deviceProperties.Target_sdk_version == nil {
373 a.SetEnforceDefaultTargetSdkVersion(true)
374 }
375 }
376
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100377 a.checkPlatformAPI(ctx)
378 a.checkSdkVersions(ctx)
379}
380
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900381// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
382// This check is enforced for "updatable" APKs (including APK-in-APEX).
Jiyong Park54105c42021-03-31 18:17:53 +0900383func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion android.ApiLevel) {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900384 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
385 ctx.VisitDirectDeps(func(m android.Module) {
386 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
387 return
388 }
389 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900390 // The domain of cc.sdk_version is "current" and <number>
Jiyong Parkf1691d22021-03-29 20:11:58 +0900391 // We can rely on android.SdkSpec to convert it to <number> so that "current" is
392 // handled properly regardless of sdk finalization.
Spandan Das2e8c0442022-05-08 00:39:35 +0000393 jniSdkVersion, err := android.SdkSpecFrom(ctx, dep.MinSdkVersion()).EffectiveVersion(ctx)
Jiyong Park54105c42021-03-31 18:17:53 +0900394 if err != nil || minSdkVersion.LessThan(jniSdkVersion) {
Spandan Das2e8c0442022-05-08 00:39:35 +0000395 ctx.OtherModuleErrorf(dep, "min_sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
396 dep.MinSdkVersion(), minSdkVersion, ctx.ModuleName())
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900397 return
398 }
399
400 })
401}
402
Sasha Smundak6ad77252019-05-01 13:16:22 -0700403// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800404// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700405func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park92315372021-04-02 08:45:46 +0900406 minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800407 if err != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900408 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.MinSdkVersion(ctx), err)
Colin Crosse4246ab2019-02-05 21:55:21 -0800409 }
410
Colin Crossff694a82023-12-13 15:54:49 -0800411 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jiyong Park54105c42021-03-31 18:17:53 +0900412 return (minSdkVersion.FinalOrFutureInt() >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
Colin Cross56a83212020-09-15 18:30:11 -0700413 !apexInfo.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800414}
415
Colin Cross43f08db2018-11-12 10:13:39 -0800416// Returns whether this module should have the dex file stored uncompressed in the APK.
417func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800418 if Bool(a.appProperties.Use_embedded_dex) {
419 return true
420 }
421
Colin Cross53a87f52019-06-25 13:35:30 -0700422 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
423 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900424 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000425 return true
426 }
427
Colin Cross53a87f52019-06-25 13:35:30 -0700428 if ctx.Config().UnbundledBuild() {
429 return false
430 }
431
Spandan Dase21a8d42024-01-23 23:56:29 +0000432 return shouldUncompressDex(ctx, android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName()), &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700433}
434
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700435func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
Colin Crossff694a82023-12-13 15:54:49 -0800436 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700437 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Colin Cross56a83212020-09-15 18:30:11 -0700438 !apexInfo.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700439}
440
Liz Kammer9f9fd022020-06-18 19:44:06 +0000441func generateAaptRenamePackageFlags(packageName string, renameResourcesPackage bool) []string {
442 aaptFlags := []string{"--rename-manifest-package " + packageName}
443 if renameResourcesPackage {
444 // Required to rename the package name in the resources table.
445 aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
446 }
447 return aaptFlags
448}
449
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900450func (a *AndroidApp) OverriddenManifestPackageName() string {
451 return a.overriddenManifestPackageName
452}
453
Liz Kammer9f9fd022020-06-18 19:44:06 +0000454func (a *AndroidApp) renameResourcesPackage() bool {
455 return proptools.BoolDefault(a.overridableAppProperties.Rename_resources_package, true)
456}
457
Jihoon Kang9049c272024-03-19 21:57:36 +0000458func getAconfigFilePaths(ctx android.ModuleContext) (aconfigTextFilePaths android.Paths) {
459 ctx.VisitDirectDepsWithTag(aconfigDeclarationTag, func(dep android.Module) {
460 if provider, ok := android.OtherModuleProvider(ctx, dep, android.AconfigDeclarationsProviderKey); ok {
461 aconfigTextFilePaths = append(aconfigTextFilePaths, provider.IntermediateDumpOutputPath)
462 } else {
463 ctx.ModuleErrorf("Only aconfig_declarations module type is allowed for "+
464 "flags_packages property, but %s is not aconfig_declarations module type",
465 dep.Name(),
466 )
467 }
468 })
469
470 return aconfigTextFilePaths
471}
472
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800473func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900474 usePlatformAPI := proptools.Bool(a.Module.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900475 if ctx.Module().(android.SdkContext).SdkVersion(ctx).Kind == android.SdkModule {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900476 usePlatformAPI = true
477 }
478 a.aapt.usesNonSdkApis = usePlatformAPI
David Brazdild25060a2019-02-18 18:24:16 +0000479
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700480 // Ask manifest_fixer to add or update the application element indicating this app has no code.
481 a.aapt.hasNoCode = !a.hasCode(ctx)
482
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800483 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800484
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800485 // 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 +0900486 autogenerateRRO := proptools.Bool(a.appProperties.Generate_product_characteristics_rro)
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800487 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Inseob Kim10af6ed2024-02-13 12:56:46 +0900488 characteristics := ctx.Config().ProductAAPTCharacteristics()
489 if !autogenerateRRO && !hasProduct && len(characteristics) > 0 && characteristics != "default" {
490 aaptLinkFlags = append(aaptLinkFlags, "--product", characteristics)
Colin Crosse78dcd32018-04-19 15:25:19 -0700491 }
492
Dan Willemsen72be5902018-10-24 20:24:57 -0700493 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
494 // Product AAPT config
495 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800496 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700497 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700498
Dan Willemsen72be5902018-10-24 20:24:57 -0700499 // Product AAPT preferred config
500 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800501 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700502 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700503 }
504
Jiyong Park7f67f482019-01-05 12:57:48 +0900505 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700506 if overridden || a.overridableAppProperties.Package_name != nil {
507 // The product override variable has a priority over the package_name property.
508 if !overridden {
509 manifestPackageName = *a.overridableAppProperties.Package_name
510 }
Liz Kammer9f9fd022020-06-18 19:44:06 +0000511 aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName, a.renameResourcesPackage())...)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900512 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900513 }
514
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800515 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
516
Colin Crosse560c4a2019-03-19 16:03:11 -0700517 a.aapt.splitNames = a.appProperties.Package_splits
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800518 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Alexei Nicoara69cf0f32022-07-27 14:59:18 +0100519 if a.Updatable() {
520 a.aapt.defaultManifestVersion = android.DefaultUpdatableModuleVersion
521 }
Jihoon Kang84b25892023-12-01 22:01:06 +0000522
Rico Winda2fa2632024-03-13 13:09:17 +0100523 // Use non final ids if we are doing optimized shrinking and are using R8.
524 nonFinalIds := Bool(a.dexProperties.Optimize.Optimized_shrink_resources) && a.dexer.effectiveOptimizeEnabled()
Alixf7a10272023-09-27 16:47:56 +0000525 a.aapt.buildActions(ctx,
526 aaptBuildActionOptions{
Jihoon Kang84b25892023-12-01 22:01:06 +0000527 sdkContext: android.SdkContext(a),
528 classLoaderContexts: a.classLoaderContexts,
529 excludedLibs: a.usesLibraryProperties.Exclude_uses_libs,
530 enforceDefaultTargetSdkVersion: a.enforceDefaultTargetSdkVersion(),
Rico Winda2fa2632024-03-13 13:09:17 +0100531 forceNonFinalResourceIDs: nonFinalIds,
Jihoon Kang84b25892023-12-01 22:01:06 +0000532 extraLinkFlags: aaptLinkFlags,
Jihoon Kang9049c272024-03-19 21:57:36 +0000533 aconfigTextFiles: getAconfigFilePaths(ctx),
Alixf7a10272023-09-27 16:47:56 +0000534 },
535 )
Colin Cross30e076a2015-04-13 13:58:27 -0700536
Colin Cross46c9b8b2017-06-22 16:51:17 -0700537 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700538 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800539}
Colin Cross30e076a2015-04-13 13:58:27 -0700540
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800541func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700542 var staticLibProguardFlagFiles android.Paths
543 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -0800544 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -0400545 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.UnconditionallyExportedProguardFlags.ToList()...)
546 if ctx.OtherModuleDependencyTag(m) == staticLibTag {
547 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.ProguardFlagsFiles.ToList()...)
Colin Cross89c31582018-04-30 15:55:11 -0700548 }
549 })
550
551 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
552
Colin Cross312634e2023-11-21 15:13:56 -0800553 a.Module.extraProguardFlagsFiles = append(a.Module.extraProguardFlagsFiles, staticLibProguardFlagFiles...)
Rico Winda2fa2632024-03-13 13:09:17 +0100554 if !Bool(a.dexProperties.Optimize.Optimized_shrink_resources) {
555 // When using the optimized shrinking the R8 enqueuer will traverse the xml files that become
556 // live for code references and (transitively) mark these as live.
557 // In this case we explicitly don't wan't the aapt2 generated keep files (which would keep the now
558 // dead code alive)
559 a.Module.extraProguardFlagsFiles = append(a.Module.extraProguardFlagsFiles, a.proguardOptionsFile)
560 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800561}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800562
Colin Cross403cc152020-07-06 14:15:24 -0700563func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
Colin Cross43f08db2018-11-12 10:13:39 -0800564 var installDir string
565 if ctx.ModuleName() == "framework-res" {
566 // framework-res.apk is installed as system/framework/framework-res.apk
567 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900568 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800569 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800570 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800571 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800572 }
Colin Cross403cc152020-07-06 14:15:24 -0700573
574 return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
575}
576
Rico Wind98e7fa82023-11-27 09:44:03 +0100577func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) (android.Path, android.Path) {
Colin Cross403cc152020-07-06 14:15:24 -0700578 a.dexpreopter.installPath = a.installPath(ctx)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000579 a.dexpreopter.isApp = true
Liz Kammera7a64f32020-07-09 15:16:41 -0700580 if a.dexProperties.Uncompress_dex == nil {
David Srbeckye033cba2020-05-20 22:20:28 +0100581 // If the value was not force-set by the user, use reasonable default based on the module.
Liz Kammera7a64f32020-07-09 15:16:41 -0700582 a.dexProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
David Srbeckye033cba2020-05-20 22:20:28 +0100583 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700584 a.dexpreopter.uncompressedDex = *a.dexProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700585 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100586 a.dexpreopter.classLoaderContexts = a.classLoaderContexts
Colin Cross50ddcc42019-05-16 12:28:22 -0700587 a.dexpreopter.manifestFile = a.mergedManifestFile
Colin Crossfa9bfcd2021-11-10 16:42:38 -0800588 a.dexpreopter.preventInstall = a.appProperties.PreventInstall
Colin Cross50ddcc42019-05-16 12:28:22 -0700589
Rico Wind98e7fa82023-11-27 09:44:03 +0100590 var packageResources = a.exportPackage
591
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800592 if ctx.ModuleName() != "framework-res" {
Rico Winda2fa2632024-03-13 13:09:17 +0100593 if a.dexProperties.resourceShrinkingEnabled() {
Rico Wind98e7fa82023-11-27 09:44:03 +0100594 protoFile := android.PathForModuleOut(ctx, packageResources.Base()+".proto.apk")
595 aapt2Convert(ctx, protoFile, packageResources, "proto")
596 a.dexer.resourcesInput = android.OptionalPathForPath(protoFile)
597 }
598
Colin Cross4eae06d2023-06-20 22:40:02 -0700599 var extraSrcJars android.Paths
600 var extraClasspathJars android.Paths
601 var extraCombinedJars android.Paths
Colin Cross8f1b0332024-01-25 13:39:06 -0800602 if a.useResourceProcessorBusyBox(ctx) {
Colin Cross4eae06d2023-06-20 22:40:02 -0700603 // When building an app with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox has already
604 // created R.class files that provide IDs for resources in busybox/R.jar. Pass that file in the
605 // classpath when compiling everything else, and add it to the final classes jar.
606 extraClasspathJars = android.Paths{a.aapt.rJar}
607 extraCombinedJars = android.Paths{a.aapt.rJar}
608 } else {
609 // When building an app without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
610 // R.java files for the app's package and the packages from all transitive static android_library
611 // dependencies. Compile the srcjar alongside the rest of the sources.
612 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
613 }
614
615 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Rico Winda2fa2632024-03-13 13:09:17 +0100616 if a.dexProperties.resourceShrinkingEnabled() {
Rico Wind98e7fa82023-11-27 09:44:03 +0100617 binaryResources := android.PathForModuleOut(ctx, packageResources.Base()+".binary.out.apk")
618 aapt2Convert(ctx, binaryResources, a.dexer.resourcesOutput.Path(), "binary")
619 packageResources = binaryResources
620 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800621 }
Colin Cross30e076a2015-04-13 13:58:27 -0700622
Rico Wind98e7fa82023-11-27 09:44:03 +0100623 return a.dexJarFile.PathOrNil(), packageResources
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800624}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800625
Sam Delmerico82602492022-06-10 17:05:42 +0000626func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, prebuiltJniPackages android.Paths, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700627 var jniJarFile android.WritablePath
Sam Delmerico82602492022-06-10 17:05:42 +0000628 if len(jniLibs) > 0 || len(prebuiltJniPackages) > 0 {
Colin Cross403cc152020-07-06 14:15:24 -0700629 a.jniLibs = jniLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700630 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700631 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Colin Crossc68db4b2021-11-11 18:59:15 -0800632 a.installPathForJNISymbols = a.installPath(ctx)
Sam Delmerico82602492022-06-10 17:05:42 +0000633 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, prebuiltJniPackages, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700634 for _, jni := range jniLibs {
635 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700636 // Only collect coverage for the first target arch if this is a multilib target.
637 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
638 // data file path collisions since the current coverage file path format doesn't contain
639 // arch-related strings. This is fine for now though; the code coverage team doesn't use
640 // multi-arch targets such as test_suite_* for coverage collections yet.
641 //
642 // Work with the team to come up with a new format that handles multilib modules properly
643 // and change this.
644 if len(ctx.Config().Targets[android.Android]) == 1 ||
Jaewoong Jung642916f2020-10-09 17:25:15 -0700645 ctx.Config().AndroidFirstDeviceTarget.Arch.ArchType == jni.target.Arch.ArchType {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700646 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
647 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700648 }
649 }
Colin Cross403cc152020-07-06 14:15:24 -0700650 a.embeddedJniLibs = true
Colin Crossa4f08812018-10-02 22:03:40 -0700651 }
652 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800653 return jniJarFile
654}
Colin Crossa4f08812018-10-02 22:03:40 -0700655
Colin Cross403cc152020-07-06 14:15:24 -0700656func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
657 var jniSymbols android.RuleBuilderInstalls
658 for _, jniLib := range a.jniLibs {
659 if jniLib.unstrippedFile != nil {
660 jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
661 From: jniLib.unstrippedFile,
662 To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
663 })
664 }
665 }
666 return jniSymbols
667}
668
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700669// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
670// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
Colin Crossbc2c8a72022-09-14 12:45:42 -0700671func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate,
672 ctx android.ModuleContext) (mainCertificate Certificate, allCertificates []Certificate) {
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700673 if android.SrcIsModule(certPropValue) == "" {
674 var mainCert Certificate
675 if certPropValue != "" {
676 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
677 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800678 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
679 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700680 }
681 } else {
682 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800683 mainCert = Certificate{
684 Pem: pem,
685 Key: key,
686 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700687 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700688 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700689 }
690
Colin Crossbc2c8a72022-09-14 12:45:42 -0700691 if len(certificates) > 0 {
692 mainCertificate = certificates[0]
693 } else {
694 // This can be reached with an empty certificate list if AllowMissingDependencies is set
695 // and the certificate property for this module is a module reference to a missing module.
696 if !ctx.Config().AllowMissingDependencies() && len(ctx.GetMissingDependencies()) > 0 {
697 panic("Should only get here if AllowMissingDependencies set and there are missing dependencies")
698 }
699 // Set a certificate to avoid panics later when accessing it.
700 mainCertificate = Certificate{
701 Key: android.PathForModuleOut(ctx, "missing.pk8"),
Colin Crossa54f4b52022-11-21 04:35:53 +0000702 Pem: android.PathForModuleOut(ctx, "missing.x509.pem"),
Colin Crossbc2c8a72022-09-14 12:45:42 -0700703 }
704 }
705
Zyan Wub7550aa2023-05-18 15:46:31 +0800706 if !m.Platform() {
707 certPath := mainCertificate.Pem.String()
708 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
709 if strings.HasPrefix(certPath, systemCertPath) {
710 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
711 allowed := ctx.Config().EnforceSystemCertificateAllowList()
712
713 if enforceSystemCert && !inList(m.Name(), allowed) {
714 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
715 }
716 }
717 }
718
Colin Crossbc2c8a72022-09-14 12:45:42 -0700719 return mainCertificate, certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800720}
721
Jooyung Han39ee1192020-03-23 20:21:11 +0900722func (a *AndroidApp) InstallApkName() string {
723 return a.installApkName
724}
725
Sam Delmerico15809f82023-05-15 17:21:47 -0400726func (a *AndroidApp) createPrivappAllowlist(ctx android.ModuleContext) android.Path {
Andrei Onea580636b2022-08-17 16:53:46 +0000727 if a.appProperties.Privapp_allowlist == nil {
728 return nil
729 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400730
731 isOverrideApp := a.GetOverriddenBy() != ""
732 if !isOverrideApp {
733 // if this is not an override, we don't need to rewrite the existing privapp allowlist
734 return android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist)
735 }
736
Andrei Onea580636b2022-08-17 16:53:46 +0000737 if a.overridableAppProperties.Package_name == nil {
738 ctx.PropertyErrorf("privapp_allowlist", "package_name must be set to use privapp_allowlist")
739 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400740
Andrei Onea580636b2022-08-17 16:53:46 +0000741 packageName := *a.overridableAppProperties.Package_name
742 fileName := "privapp_allowlist_" + packageName + ".xml"
743 outPath := android.PathForModuleOut(ctx, fileName).OutputPath
744 ctx.Build(pctx, android.BuildParams{
745 Rule: modifyAllowlist,
746 Input: android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist),
747 Output: outPath,
748 Args: map[string]string{
749 "packageName": packageName,
750 },
751 })
752 return &outPath
753}
754
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800755func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700756 var apkDeps android.Paths
757
Colin Crossff694a82023-12-13 15:54:49 -0800758 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
759 if !apexInfo.IsForPlatform() {
Colin Cross56a83212020-09-15 18:30:11 -0700760 a.hideApexVariantFromMake = true
761 }
762
Jeongik Cha538c0d02019-07-11 15:54:27 +0900763 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
764 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
765
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000766 // Unlike installApkName, a.stem should respect base module name for override_android_app.
767 // Therefore, use ctx.ModuleName() instead of a.Name().
yangbill2af0b6e2024-03-15 09:29:29 +0000768 a.stem = proptools.StringDefault(a.overridableProperties.Stem, ctx.ModuleName())
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000769
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800770 // Check if the install APK name needs to be overridden.
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000771 // Both android_app and override_android_app module are expected to possess
772 // its module bound apk path. However, override_android_app inherits ctx.ModuleName()
773 // from the base module. Therefore, use a.Name() which represents
774 // the module name for both android_app and override_android_app.
775 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(
yangbill2af0b6e2024-03-15 09:29:29 +0000776 proptools.StringDefault(a.overridableProperties.Stem, a.Name()))
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800777
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700778 if ctx.ModuleName() == "framework-res" {
779 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700780 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900781 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700782 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
783 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800784 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700785 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700786 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700787 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700788 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700789
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100790 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Spandan Das0727ba72024-02-13 16:37:43 +0000791 if a.usesLibrary.shouldDisableDexpreopt {
792 a.dexpreopter.disableDexpreopt()
793 }
Ulya Trafimovich18554242020-11-03 15:55:11 +0000794
Colin Cross61fb62e2022-06-23 10:46:28 -0700795 var noticeAssetPath android.WritablePath
796 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
797 // The rule to create the notice file can't be generated yet, as the final output path
798 // for the apk isn't known yet. Add the path where the notice file will be generated to the
799 // aapt rules now before calling aaptBuildActions, the rule to create the notice file will
800 // be generated later.
801 noticeAssetPath = android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
802 a.aapt.noticeFile = android.OptionalPathForPath(noticeAssetPath)
803 }
804
Harshit Mahajan8f202ad2023-01-09 20:45:55 +0000805 // For apps targeting latest target_sdk_version
806 if Bool(a.appProperties.Enforce_default_target_sdk_version) {
807 a.SetEnforceDefaultTargetSdkVersion(true)
808 }
809
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800810 // Process all building blocks, from AAPT to certificates.
811 a.aaptBuildActions(ctx)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100812 // The decision to enforce <uses-library> checks is made before adding implicit SDK libraries.
813 a.usesLibrary.freezeEnforceUsesLibraries()
814
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100815 // Check that the <uses-library> list is coherent with the manifest.
Colin Cross50ddcc42019-05-16 12:28:22 -0700816 if a.usesLibrary.enforceUsesLibraries() {
Jiakai Zhang2665d272024-03-28 11:52:08 +0000817 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(
818 ctx, a.mergedManifestFile, &a.classLoaderContexts)
Colin Cross50ddcc42019-05-16 12:28:22 -0700819 apkDeps = append(apkDeps, manifestCheckFile)
820 }
821
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800822 a.proguardBuildActions(ctx)
823
Colin Cross014489c2020-06-02 20:09:13 -0700824 a.linter.mergedManifest = a.aapt.mergedManifestFile
825 a.linter.manifest = a.aapt.manifestPath
826 a.linter.resources = a.aapt.resourceFiles
Colin Crossc0efd1d2020-07-03 11:56:24 -0700827 a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
Colin Cross014489c2020-06-02 20:09:13 -0700828
Rico Wind98e7fa82023-11-27 09:44:03 +0100829 dexJarFile, packageResources := a.dexBuildActions(ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800830
Colin Crossbc2c8a72022-09-14 12:45:42 -0700831 jniLibs, prebuiltJniPackages, certificates := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Sam Delmerico82602492022-06-10 17:05:42 +0000832 jniJarFile := a.jniBuildActions(jniLibs, prebuiltJniPackages, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800833
834 if ctx.Failed() {
835 return
836 }
837
Colin Crossbc2c8a72022-09-14 12:45:42 -0700838 a.certificate, certificates = processMainCert(a.ModuleBase, a.getCertString(ctx), certificates, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800839
840 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800841 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700842 v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
843 var v4SignatureFile android.WritablePath = nil
844 if v4SigningRequested {
845 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
846 }
Liz Kammere2b27f42020-05-07 13:24:05 -0700847 var lineageFile android.Path
848 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
849 lineageFile = android.PathForModuleSrc(ctx, lineage)
850 }
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400851 rotationMinSdkVersion := String(a.overridableAppProperties.RotationMinSdkVersion)
852
Rico Wind98e7fa82023-11-27 09:44:03 +0100853 CreateAndSignAppPackage(ctx, packageFile, packageResources, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800854 a.outputFile = packageFile
Songchun Fan17d69e32020-03-24 20:32:24 -0700855 if v4SigningRequested {
856 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
857 }
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800858
Colin Cross61fb62e2022-06-23 10:46:28 -0700859 if a.aapt.noticeFile.Valid() {
860 // Generating the notice file rule has to be here after a.outputFile is known.
Bob Badoureef4c1c2022-05-16 12:20:04 -0700861 noticeFile := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700862 android.BuildNoticeHtmlOutputFromLicenseMetadata(
863 ctx, noticeFile, "", "",
864 []string{
865 a.installDir.String() + "/",
866 android.PathForModuleInstall(ctx).String() + "/",
867 a.outputFile.String(),
868 })
Bob Badoureef4c1c2022-05-16 12:20:04 -0700869 builder := android.NewRuleBuilder(pctx, ctx)
870 builder.Command().Text("cp").
871 Input(noticeFile).
872 Output(noticeAssetPath)
873 builder.Build("notice_dir", "Building notice dir")
Bob Badoureef4c1c2022-05-16 12:20:04 -0700874 }
875
Colin Crosse560c4a2019-03-19 16:03:11 -0700876 for _, split := range a.aapt.splits {
877 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800878 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700879 if v4SigningRequested {
880 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
881 }
Rico Wind98e7fa82023-11-27 09:44:03 +0100882 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Crosse560c4a2019-03-19 16:03:11 -0700883 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
Songchun Fan17d69e32020-03-24 20:32:24 -0700884 if v4SigningRequested {
885 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
886 }
Colin Crosse560c4a2019-03-19 16:03:11 -0700887 }
888
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800889 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700890 bundleFile := android.PathForModuleOut(ctx, "base.zip")
891 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
892 a.bundleFile = bundleFile
893
Andrei Onea580636b2022-08-17 16:53:46 +0000894 allowlist := a.createPrivappAllowlist(ctx)
895 if allowlist != nil {
896 a.privAppAllowlist = android.OptionalPathForPath(allowlist)
897 }
898
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800899 // Install the app package.
Andrei Onea580636b2022-08-17 16:53:46 +0000900 shouldInstallAppPackage := (Bool(a.Module.properties.Installable) || ctx.Host()) && apexInfo.IsForPlatform() && !a.appProperties.PreventInstall
901 if shouldInstallAppPackage {
Sam Delmericob1daccd2023-05-25 14:45:30 -0400902 if a.privAppAllowlist.Valid() {
Anton Hansson0e486a42023-06-01 16:38:35 +0000903 allowlistInstallPath := android.PathForModuleInstall(ctx, "etc", "permissions")
904 allowlistInstallFilename := a.installApkName + ".xml"
905 ctx.InstallFile(allowlistInstallPath, allowlistInstallFilename, a.privAppAllowlist.Path())
Sam Delmericob1daccd2023-05-25 14:45:30 -0400906 }
907
Colin Cross09ad3a62023-11-15 12:29:33 -0800908 var extraInstalledPaths android.InstallPaths
Jiyong Park8ba50f92019-11-13 15:01:01 +0900909 for _, extra := range a.extraOutputFiles {
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700910 installed := ctx.InstallFile(a.installDir, extra.Base(), extra)
911 extraInstalledPaths = append(extraInstalledPaths, installed)
Jiyong Park8ba50f92019-11-13 15:01:01 +0900912 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700913 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile, extraInstalledPaths...)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800914 }
Artur Satayev1111b842020-04-27 19:05:28 +0100915
916 a.buildAppDependencyInfo(ctx)
Spandan Das3490dfd2024-03-11 21:37:25 +0000917
918 providePrebuiltInfo(ctx,
919 prebuiltInfoProps{
920 baseModuleName: a.BaseModuleName(),
921 isPrebuilt: false,
922 },
923 )
Colin Cross30e076a2015-04-13 13:58:27 -0700924}
925
Colin Crossc2d24052020-05-13 11:05:02 -0700926type appDepsInterface interface {
Jiyong Park92315372021-04-02 08:45:46 +0900927 SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000928 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Colin Crossc2d24052020-05-13 11:05:02 -0700929 RequiresStableAPIs(ctx android.BaseModuleContext) bool
930}
931
932func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
933 shouldCollectRecursiveNativeDeps bool,
Sam Delmerico82602492022-06-10 17:05:42 +0000934 checkNativeSdkVersion bool) ([]jniLib, android.Paths, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700935
Colin Crossc2d24052020-05-13 11:05:02 -0700936 if checkNativeSdkVersion {
Jiyong Park92315372021-04-02 08:45:46 +0900937 checkNativeSdkVersion = app.SdkVersion(ctx).Specified() &&
938 app.SdkVersion(ctx).Kind != android.SdkCorePlatform && !app.RequiresStableAPIs(ctx)
Colin Crossc2d24052020-05-13 11:05:02 -0700939 }
Makoto Onuki2ca84272024-02-10 00:15:21 +0000940 jniLib, prebuiltJniPackages := collectJniDeps(ctx, shouldCollectRecursiveNativeDeps,
941 checkNativeSdkVersion, func(dep cc.LinkableInterface) bool {
942 return !dep.IsNdk(ctx.Config()) && !dep.IsStubs()
943 })
944
945 var certificates []Certificate
946
947 ctx.VisitDirectDeps(func(module android.Module) {
948 otherName := ctx.OtherModuleName(module)
949 tag := ctx.OtherModuleDependencyTag(module)
950
951 if tag == certificateTag {
952 if dep, ok := module.(*AndroidAppCertificate); ok {
953 certificates = append(certificates, dep.Certificate)
954 } else {
955 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
956 }
957 }
958 })
959 return jniLib, prebuiltJniPackages, certificates
960}
961
962func collectJniDeps(ctx android.ModuleContext,
963 shouldCollectRecursiveNativeDeps bool,
964 checkNativeSdkVersion bool,
965 filter func(cc.LinkableInterface) bool) ([]jniLib, android.Paths) {
966 var jniLibs []jniLib
967 var prebuiltJniPackages android.Paths
968 seenModulePaths := make(map[string]bool)
Colin Crossc2d24052020-05-13 11:05:02 -0700969
Peter Collingbournead84f972019-12-17 16:46:18 -0800970 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700971 otherName := ctx.OtherModuleName(module)
972 tag := ctx.OtherModuleDependencyTag(module)
973
Colin Crossf0913fb2020-07-29 12:59:39 -0700974 if IsJniDepTag(tag) || cc.IsSharedDepTag(tag) {
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400975 if dep, ok := module.(cc.LinkableInterface); ok {
Makoto Onuki2ca84272024-02-10 00:15:21 +0000976 if filter != nil && !filter(dep) {
Peter Collingbournead84f972019-12-17 16:46:18 -0800977 return false
978 }
979
Colin Crossa4f08812018-10-02 22:03:40 -0700980 lib := dep.OutputFile()
981 if lib.Valid() {
Cole Faust64cb7c92021-09-14 17:32:49 -0700982 path := lib.Path()
983 if seenModulePaths[path.String()] {
984 return false
985 }
986 seenModulePaths[path.String()] = true
987
988 if checkNativeSdkVersion && dep.SdkVersion() == "" {
989 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
990 otherName)
991 }
992
Colin Crossa4f08812018-10-02 22:03:40 -0700993 jniLibs = append(jniLibs, jniLib{
Colin Cross403cc152020-07-06 14:15:24 -0700994 name: ctx.OtherModuleName(module),
995 path: path,
996 target: module.Target(),
997 coverageFile: dep.CoverageOutputFile(),
998 unstrippedFile: dep.UnstrippedOutputFile(),
Jihoon Kangf78a8902022-09-01 22:47:07 +0000999 partition: dep.Partition(),
Colin Crossa4f08812018-10-02 22:03:40 -07001000 })
Colin Crossdd5261c2022-12-19 12:26:43 -08001001 } else if ctx.Config().AllowMissingDependencies() {
1002 ctx.AddMissingDependencies([]string{otherName})
Colin Crossa4f08812018-10-02 22:03:40 -07001003 } else {
1004 ctx.ModuleErrorf("dependency %q missing output file", otherName)
1005 }
1006 } else {
1007 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -07001008 }
Peter Collingbournead84f972019-12-17 16:46:18 -08001009
1010 return shouldCollectRecursiveNativeDeps
1011 }
1012
Colin Cross313aa542023-12-13 13:47:44 -08001013 if info, ok := android.OtherModuleProvider(ctx, module, JniPackageProvider); ok {
Sam Delmerico82602492022-06-10 17:05:42 +00001014 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
1015 }
1016
Peter Collingbournead84f972019-12-17 16:46:18 -08001017 return false
Colin Crossa4f08812018-10-02 22:03:40 -07001018 })
1019
Makoto Onuki2ca84272024-02-10 00:15:21 +00001020 return jniLibs, prebuiltJniPackages
Colin Crossa4f08812018-10-02 22:03:40 -07001021}
1022
Jooyung Han749dc692020-04-15 11:03:39 +09001023func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +01001024 ctx.WalkDeps(func(child, parent android.Module) bool {
1025 isExternal := !a.DepIsInSameApex(ctx, child)
1026 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +09001027 if !do(ctx, parent, am, isExternal) {
1028 return false
1029 }
Artur Satayev1111b842020-04-27 19:05:28 +01001030 }
1031 return !isExternal
1032 })
1033}
1034
1035func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
1036 if ctx.Host() {
1037 return
1038 }
1039
1040 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001041 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +01001042 depName := to.Name()
Artur Satayev533b98c2021-03-11 18:03:42 +00001043
1044 // Skip dependencies that are only available to APEXes; they are developed with updatability
1045 // in mind and don't need manual approval.
1046 if to.(android.ApexModule).NotAvailableForPlatform() {
1047 return true
1048 }
1049
Artur Satayev1111b842020-04-27 19:05:28 +01001050 if info, exist := depsInfo[depName]; exist {
1051 info.From = append(info.From, from.Name())
1052 info.IsExternal = info.IsExternal && externalDep
1053 depsInfo[depName] = info
1054 } else {
1055 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001056 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001057 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001058 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001059 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1060 toMinSdkVersion = v.String()
Artur Satayev1111b842020-04-27 19:05:28 +01001061 }
Jiyong Park92315372021-04-02 08:45:46 +09001062 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1063 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1064 // string
1065 if v := m.MinSdkVersion(); v != "" {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001066 toMinSdkVersion = v
1067 }
Artur Satayev1111b842020-04-27 19:05:28 +01001068 }
1069 depsInfo[depName] = android.ApexModuleDepInfo{
1070 To: depName,
1071 From: []string{from.Name()},
1072 IsExternal: externalDep,
1073 MinSdkVersion: toMinSdkVersion,
1074 }
1075 }
Jooyung Han749dc692020-04-15 11:03:39 +09001076 return true
Artur Satayev1111b842020-04-27 19:05:28 +01001077 })
1078
Jiyong Park92315372021-04-02 08:45:46 +09001079 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depsInfo)
Artur Satayev1111b842020-04-27 19:05:28 +01001080}
1081
Harshit Mahajan5b8b7302022-06-10 11:24:05 +00001082func (a *AndroidApp) enforceDefaultTargetSdkVersion() bool {
1083 return a.appProperties.EnforceDefaultTargetSdkVersion
1084}
1085
1086func (a *AndroidApp) SetEnforceDefaultTargetSdkVersion(val bool) {
1087 a.appProperties.EnforceDefaultTargetSdkVersion = val
1088}
1089
Artur Satayev849f8442020-04-28 14:57:42 +01001090func (a *AndroidApp) Updatable() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001091 return Bool(a.appProperties.Updatable)
Artur Satayev849f8442020-04-28 14:57:42 +01001092}
1093
Spandan Das42e89502022-05-06 22:12:55 +00001094func (a *AndroidApp) SetUpdatable(val bool) {
1095 a.appProperties.Updatable = &val
1096}
1097
Colin Cross0ea8ba82019-06-06 14:33:29 -07001098func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001099 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
1100 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001101 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001102 }
Jaewoong Jung525443a2019-02-28 15:35:54 -08001103 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001104}
1105
Jiyong Park0f80c182020-01-31 02:49:53 +09001106func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1107 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
1108 return true
1109 }
1110 return a.Library.DepIsInSameApex(ctx, dep)
1111}
1112
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001113// For OutputFileProducer interface
1114func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
1115 switch tag {
Jared Duke34b080d2023-03-30 16:40:24 -07001116 // In some instances, it can be useful to reference the aapt-generated flags from another
1117 // target, e.g., system server implements services declared in the framework-res manifest.
1118 case ".aapt.proguardOptionsFile":
1119 return []android.Path{a.proguardOptionsFile}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001120 case ".aapt.srcjar":
Colin Crossf3b7bad2023-08-02 15:49:00 -07001121 if a.aaptSrcJar != nil {
1122 return []android.Path{a.aaptSrcJar}, nil
1123 }
1124 case ".aapt.jar":
1125 if a.rJar != nil {
1126 return []android.Path{a.rJar}, nil
1127 }
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001128 case ".apk":
1129 return []android.Path{a.outputFile}, nil
Anton Hansson092aca42020-08-13 19:37:22 +01001130 case ".export-package.apk":
1131 return []android.Path{a.exportPackage}, nil
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001132 case ".manifest.xml":
1133 return []android.Path{a.aapt.manifestPath}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001134 }
1135 return a.Library.OutputFiles(tag)
1136}
1137
Jiyong Parkf7487312019-10-17 12:54:30 +09001138func (a *AndroidApp) Privileged() bool {
1139 return Bool(a.appProperties.Privileged)
1140}
1141
Colin Crossf5f4ad32024-01-19 15:41:48 -08001142func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.IncomingTransitionContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001143 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001144}
1145
Ivan Lozanod7586b62021-04-01 09:49:36 -04001146func (a *AndroidApp) SetPreventInstall() {
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001147 a.appProperties.PreventInstall = true
1148}
1149
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001150func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
1151 a.appProperties.IsCoverageVariant = coverage
1152}
1153
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001154func (a *AndroidApp) EnableCoverageIfNeeded() {}
1155
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001156var _ cc.Coverage = (*AndroidApp)(nil)
1157
Colin Cross95b53b82023-10-17 13:21:02 -07001158func (a *AndroidApp) IDEInfo(dpInfo *android.IdeInfo) {
1159 a.Library.IDEInfo(dpInfo)
1160 a.aapt.IDEInfo(dpInfo)
1161}
1162
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001163func (a *AndroidApp) productCharacteristicsRROPackageName() string {
1164 return proptools.String(a.appProperties.ProductCharacteristicsRROPackageName)
1165}
1166
1167func (a *AndroidApp) productCharacteristicsRROManifestModuleName() string {
1168 return proptools.String(a.appProperties.ProductCharacteristicsRROManifestModuleName)
1169}
1170
Colin Cross1b16b0e2019-02-12 14:41:32 -08001171// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -07001172func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -07001173 module := &AndroidApp{}
1174
Liz Kammera7a64f32020-07-09 15:16:41 -07001175 module.Module.dexProperties.Optimize.EnabledByDefault = true
1176 module.Module.dexProperties.Optimize.Shrink = proptools.BoolPtr(true)
Jared Dukeaa88b3d2023-08-29 17:07:20 +00001177 module.Module.dexProperties.Optimize.Proguard_compatibility = proptools.BoolPtr(false)
Colin Cross66dbc0b2017-12-28 12:23:20 -08001178
Colin Crossae5caf52018-05-22 11:11:52 -07001179 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001180 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001181 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001182
Colin Crossce6734e2020-06-15 16:09:53 -07001183 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -07001184 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -07001185 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001186 &module.appProperties,
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001187 &module.overridableAppProperties,
1188 &module.Library.sourceProperties)
Colin Cross36242852017-06-23 15:06:31 -07001189
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001190 module.usesLibrary.enforce = true
1191
Colin Crossa4f08812018-10-02 22:03:40 -07001192 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1193 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001194 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001195 android.InitApexModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001196
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001197 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
1198 a := ctx.Module().(*AndroidApp)
1199
1200 characteristics := ctx.Config().ProductAAPTCharacteristics()
1201 if characteristics == "default" || characteristics == "" {
1202 module.appProperties.Generate_product_characteristics_rro = nil
1203 // no need to create RRO
1204 return
1205 }
1206
1207 if !proptools.Bool(module.appProperties.Generate_product_characteristics_rro) {
1208 return
1209 }
1210
1211 rroPackageName := a.Name() + "__" + strings.ReplaceAll(characteristics, ",", "_") + "__auto_generated_characteristics_rro"
1212 rroManifestName := rroPackageName + "_manifest"
1213
1214 a.appProperties.ProductCharacteristicsRROPackageName = proptools.StringPtr(rroPackageName)
1215 a.appProperties.ProductCharacteristicsRROManifestModuleName = proptools.StringPtr(rroManifestName)
1216
1217 rroManifestProperties := struct {
1218 Name *string
1219 Tools []string
1220 Out []string
1221 Srcs []string
1222 Cmd *string
1223 }{
1224 Name: proptools.StringPtr(rroManifestName),
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001225 Tools: []string{"characteristics_rro_generator", "aapt2"},
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001226 Out: []string{"AndroidManifest.xml"},
Inseob Kim5b90d3a2024-02-14 16:55:33 +09001227 Srcs: []string{":" + a.Name() + "{.apk}"},
1228 Cmd: proptools.StringPtr("$(location characteristics_rro_generator) $$($(location aapt2) dump packagename $(in)) $(out)"),
Inseob Kim34dc4cd2023-11-07 13:37:14 +09001229 }
1230 ctx.CreateModule(genrule.GenRuleFactory, &rroManifestProperties)
1231
1232 rroProperties := struct {
1233 Name *string
1234 Filter_product *string
1235 Aaptflags []string
1236 Manifest *string
1237 Resource_dirs []string
1238 }{
1239 Name: proptools.StringPtr(rroPackageName),
1240 Filter_product: proptools.StringPtr(characteristics),
1241 Aaptflags: []string{"--auto-add-overlay"},
1242 Manifest: proptools.StringPtr(":" + rroManifestName),
1243 Resource_dirs: a.aaptProperties.Resource_dirs,
1244 }
1245 ctx.CreateModule(RuntimeResourceOverlayFactory, &rroProperties)
1246 })
1247
Colin Cross36242852017-06-23 15:06:31 -07001248 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001249}
Colin Crossae5caf52018-05-22 11:11:52 -07001250
Alix96ea88452023-08-31 15:48:23 +00001251// A dictionary of values to be overridden in the manifest.
1252type Manifest_values struct {
1253 // Overrides the value of package_name in the manifest
1254 ApplicationId *string
1255}
1256
Colin Crossae5caf52018-05-22 11:11:52 -07001257type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001258 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001259 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001260
Seth Moorec6f4b532023-02-02 13:22:26 -08001261 // If specified, the instrumentation target package name in the manifest is overwritten by it.
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001262 Instrumentation_target_package *string
Seth Moorec6f4b532023-02-02 13:22:26 -08001263
1264 // If specified, the mainline module package name in the test config is overwritten by it.
1265 Mainline_package_name *string
Alix96ea88452023-08-31 15:48:23 +00001266
1267 Manifest_values Manifest_values
Colin Crossae5caf52018-05-22 11:11:52 -07001268}
1269
1270type AndroidTest struct {
1271 AndroidApp
1272
1273 appTestProperties appTestProperties
1274
1275 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001276
Dan Shi95d19422020-08-15 12:24:26 -07001277 testConfig android.Path
1278 extraTestConfigs android.Paths
1279 data android.Paths
Colin Crossae5caf52018-05-22 11:11:52 -07001280}
1281
Jaewoong Jung0949f312019-09-11 10:25:18 -07001282func (a *AndroidTest) InstallInTestcases() bool {
1283 return true
1284}
1285
Spandan Das9f7ae7f2022-07-25 00:34:18 +00001286type androidTestApp interface {
1287 includedInTestSuite(searchPrefix string) bool
1288}
1289
1290func (a *AndroidTest) includedInTestSuite(searchPrefix string) bool {
1291 return android.PrefixInList(a.testProperties.Test_suites, searchPrefix)
1292}
1293
1294func (a *AndroidTestHelperApp) includedInTestSuite(searchPrefix string) bool {
1295 return android.PrefixInList(a.appTestHelperAppProperties.Test_suites, searchPrefix)
1296}
1297
Colin Crossae5caf52018-05-22 11:11:52 -07001298func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001299 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001300 if a.appTestProperties.Instrumentation_target_package != nil {
1301 a.additionalAaptFlags = append(a.additionalAaptFlags,
1302 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1303 } else if a.appTestProperties.Instrumentation_for != nil {
1304 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001305 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1306 if overridden {
1307 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1308 }
1309 }
Alix96ea88452023-08-31 15:48:23 +00001310 applicationId := a.appTestProperties.Manifest_values.ApplicationId
1311 if applicationId != nil {
1312 if a.overridableAppProperties.Package_name != nil {
1313 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
1314 }
1315 a.aapt.manifestValues.applicationId = *applicationId
1316 }
Colin Crossae5caf52018-05-22 11:11:52 -07001317 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001318
easoncylee5bcff5d2020-04-30 14:57:06 +08001319 for _, module := range a.testProperties.Test_mainline_modules {
1320 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1321 }
1322
Jaewoong Jung39982342020-01-14 10:27:18 -08001323 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001324 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001325 a.testConfig = a.FixTestConfig(ctx, testConfig)
Dan Shi95d19422020-08-15 12:24:26 -07001326 a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
Colin Cross8a497952019-03-05 22:25:09 -08001327 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross40213022023-12-13 15:19:49 -08001328 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Ronald Braunsteinfce43162024-02-02 12:37:20 -08001329 android.SetProvider(ctx, tradefed.BaseTestProviderKey, tradefed.BaseTestProviderData{
1330 InstalledFiles: a.data,
1331 OutputFile: a.OutputFile(),
1332 TestConfig: a.testConfig,
1333 HostRequiredModuleNames: a.HostRequiredModuleNames(),
Ronald Braunstein1a6e7c02024-03-14 21:14:39 +00001334 TestSuites: a.testProperties.Test_suites,
1335 IsHost: false,
Ronald Braunsteinfce43162024-02-02 12:37:20 -08001336 })
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001337 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
1338 TestOnly: true,
1339 TopLevelTarget: true,
1340 })
1341
Colin Cross303e21f2018-08-07 16:49:25 -07001342}
1343
Jaewoong Jung39982342020-01-14 10:27:18 -08001344func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1345 if testConfig == nil {
1346 return nil
1347 }
1348
1349 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
Colin Crossf1a035e2020-11-16 17:32:30 -08001350 rule := android.NewRuleBuilder(pctx, ctx)
1351 command := rule.Command().BuiltTool("test_config_fixer").Input(testConfig).Output(fixedConfig)
Jaewoong Jung39982342020-01-14 10:27:18 -08001352 fixNeeded := false
1353
Jooyung Han29e2f6d2022-01-08 12:13:59 +09001354 // 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 -08001355 if ctx.ModuleName() != a.installApkName {
1356 fixNeeded = true
1357 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1358 }
1359
1360 if a.overridableAppProperties.Package_name != nil {
1361 fixNeeded = true
1362 command.FlagWithInput("--manifest ", a.manifestPath).
1363 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1364 }
1365
Seth Moorec6f4b532023-02-02 13:22:26 -08001366 if a.appTestProperties.Mainline_package_name != nil {
1367 fixNeeded = true
1368 command.FlagWithArg("--mainline-package-name ", *a.appTestProperties.Mainline_package_name)
1369 }
1370
Jaewoong Jung39982342020-01-14 10:27:18 -08001371 if fixNeeded {
Colin Crossf1a035e2020-11-16 17:32:30 -08001372 rule.Build("fix_test_config", "fix test config")
Jaewoong Jung39982342020-01-14 10:27:18 -08001373 return fixedConfig
1374 }
1375 return testConfig
1376}
1377
Colin Cross303e21f2018-08-07 16:49:25 -07001378func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001379 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001380}
1381
1382func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1383 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001384 if a.appTestProperties.Instrumentation_for != nil {
1385 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1386 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1387 // use instrumentationForTag instead of libTag.
1388 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1389 }
Colin Crossae5caf52018-05-22 11:11:52 -07001390}
1391
Colin Cross1b16b0e2019-02-12 14:41:32 -08001392// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1393// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001394func AndroidTestFactory() android.Module {
1395 module := &AndroidTest{}
1396
Jared Duke63a3da92022-06-02 19:11:14 +00001397 module.Module.dexProperties.Optimize.EnabledByDefault = false
Colin Cross5067db92018-09-17 16:46:35 -07001398
1399 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001400 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001401 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001402 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001403 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001404 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001405 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001406
Colin Crossce6734e2020-06-15 16:09:53 -07001407 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001408 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001409 &module.aaptProperties,
1410 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001411 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001412 &module.overridableAppProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001413 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001414
Colin Crossa4f08812018-10-02 22:03:40 -07001415 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1416 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001417 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jingwen Chene12c0832023-08-25 09:00:16 +00001418
Colin Crossae5caf52018-05-22 11:11:52 -07001419 return module
1420}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001421
Colin Cross252fc6f2018-10-04 15:22:03 -07001422type appTestHelperAppProperties struct {
1423 // list of compatibility suites (for example "cts", "vts") that the module should be
1424 // installed into.
1425 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001426
1427 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1428 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1429 // explicitly.
1430 Auto_gen_config *bool
Colin Crosscfb0f5e2021-09-24 15:47:17 -07001431
1432 // Install the test into a folder named for the module in all test suites.
1433 Per_testcase_directory *bool
Alix96ea88452023-08-31 15:48:23 +00001434
1435 Manifest_values Manifest_values
Colin Cross252fc6f2018-10-04 15:22:03 -07001436}
1437
1438type AndroidTestHelperApp struct {
1439 AndroidApp
1440
1441 appTestHelperAppProperties appTestHelperAppProperties
1442}
1443
Jaewoong Jung326a9412019-11-21 10:41:00 -08001444func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1445 return true
1446}
1447
Colin Cross1b16b0e2019-02-12 14:41:32 -08001448// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1449// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1450// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001451func AndroidTestHelperAppFactory() android.Module {
1452 module := &AndroidTestHelperApp{}
1453
Jared Duke63a3da92022-06-02 19:11:14 +00001454 // TODO(b/192032291): Disable by default after auditing downstream usage.
Liz Kammera7a64f32020-07-09 15:16:41 -07001455 module.Module.dexProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001456
1457 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001458 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001459 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001460 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001461 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross252fc6f2018-10-04 15:22:03 -07001462
Colin Crossce6734e2020-06-15 16:09:53 -07001463 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001464 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001465 &module.aaptProperties,
1466 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001467 &module.appTestHelperAppProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001468 &module.overridableAppProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001469
1470 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1471 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001472 android.InitApexModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001473 return module
1474}
1475
Colin Crossbd01e2a2018-10-04 15:21:03 -07001476type AndroidAppCertificate struct {
1477 android.ModuleBase
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001478
Colin Crossbd01e2a2018-10-04 15:21:03 -07001479 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001480 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001481}
1482
1483type AndroidAppCertificateProperties struct {
1484 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1485 Certificate *string
1486}
1487
Colin Cross1b16b0e2019-02-12 14:41:32 -08001488// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1489// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001490func AndroidAppCertificateFactory() android.Module {
1491 module := &AndroidAppCertificate{}
1492 module.AddProperties(&module.properties)
1493 android.InitAndroidModule(module)
1494 return module
1495}
1496
Colin Crossbd01e2a2018-10-04 15:21:03 -07001497func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1498 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001499 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001500 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1501 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001502 }
1503}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001504
1505type OverrideAndroidApp struct {
1506 android.ModuleBase
1507 android.OverrideModuleBase
1508}
1509
Sasha Smundak613cbb12020-06-05 10:27:23 -07001510func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001511 // All the overrides happen in the base module.
1512 // TODO(jungjw): Check the base module type.
1513}
1514
1515// override_android_app is used to create an android_app module based on another android_app by overriding
1516// some of its properties.
1517func OverrideAndroidAppModuleFactory() android.Module {
1518 m := &OverrideAndroidApp{}
Jooyung Han01d80d82022-01-08 12:16:32 +09001519 m.AddProperties(
yangbill2af0b6e2024-03-15 09:29:29 +00001520 &OverridableProperties{},
Jooyung Han01d80d82022-01-08 12:16:32 +09001521 &overridableAppProperties{},
1522 )
Jaewoong Jung525443a2019-02-28 15:35:54 -08001523
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001524 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001525 android.InitOverrideModule(m)
1526 return m
1527}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001528
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001529type OverrideAndroidTest struct {
1530 android.ModuleBase
1531 android.OverrideModuleBase
1532}
1533
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001534func (i *OverrideAndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001535 // All the overrides happen in the base module.
1536 // TODO(jungjw): Check the base module type.
Ronald Braunsteincdc66f42024-04-12 11:23:19 -07001537 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
1538 TestOnly: true,
1539 TopLevelTarget: true,
1540 })
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001541}
1542
1543// override_android_test is used to create an android_app module based on another android_test by overriding
1544// some of its properties.
1545func OverrideAndroidTestModuleFactory() android.Module {
1546 m := &OverrideAndroidTest{}
1547 m.AddProperties(&overridableAppProperties{})
1548 m.AddProperties(&appTestProperties{})
1549
1550 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1551 android.InitOverrideModule(m)
1552 return m
1553}
1554
Colin Cross50ddcc42019-05-16 12:28:22 -07001555type UsesLibraryProperties struct {
1556 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1557 Uses_libs []string
1558
1559 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1560 // required=false.
1561 Optional_uses_libs []string
1562
1563 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1564 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1565 Enforce_uses_libs *bool
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001566
Ulya Trafimovich54027b52020-09-09 14:08:23 +01001567 // Optional name of the <uses-library> provided by this module. This is needed for non-SDK
1568 // libraries, because SDK ones are automatically picked up by Soong. The <uses-library> name
1569 // normally is the same as the module name, but there are exceptions.
1570 Provides_uses_lib *string
Paul Duffin06530572022-02-03 17:54:15 +00001571
1572 // A list of shared library names to exclude from the classpath of the APK. Adding a library here
1573 // will prevent it from being used when precompiling the APK and prevent it from being implicitly
1574 // added to the APK's manifest's <uses-library> elements.
1575 //
1576 // Care must be taken when using this as it could result in runtime errors if the APK actually
1577 // uses classes provided by the library and which are not provided in any other way.
1578 //
1579 // This is primarily intended for use by various CTS tests that check the runtime handling of the
1580 // android.test.base shared library (and related libraries) but which depend on some common
1581 // libraries that depend on the android.test.base library. Without this those tests will end up
1582 // with a <uses-library android:name="android.test.base"/> in their manifest which would either
1583 // render the tests worthless (as they would be testing the wrong behavior), or would break the
1584 // test altogether by providing access to classes that the tests were not expecting. Those tests
1585 // provide the android.test.base statically and use jarjar to rename them so they do not collide
1586 // with the classes provided by the android.test.base library.
1587 Exclude_uses_libs []string
Jiakai Zhang2665d272024-03-28 11:52:08 +00001588
1589 // The module names of optional uses-library libraries that are missing from the source tree.
1590 Missing_optional_uses_libs []string `blueprint:"mutated"`
Colin Cross50ddcc42019-05-16 12:28:22 -07001591}
1592
1593// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1594// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1595// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1596// with knowledge of their shared libraries.
1597type usesLibrary struct {
1598 usesLibraryProperties UsesLibraryProperties
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001599
1600 // Whether to enforce verify_uses_library check.
1601 enforce bool
Spandan Das0727ba72024-02-13 16:37:43 +00001602
1603 // Whether dexpreopt should be disabled
1604 shouldDisableDexpreopt bool
Colin Cross50ddcc42019-05-16 12:28:22 -07001605}
1606
Colin Cross4a80a152022-12-21 21:51:52 -08001607func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, addCompatDeps bool) {
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001608 if !ctx.Config().UnbundledBuild() || ctx.Config().UnbundledBuildImage() {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001609 ctx.AddVariationDependencies(nil, usesLibReqTag, u.usesLibraryProperties.Uses_libs...)
Jiakai Zhang2665d272024-03-28 11:52:08 +00001610 presentOptionalUsesLibs := u.presentOptionalUsesLibs(ctx)
1611 ctx.AddVariationDependencies(nil, usesLibOptTag, presentOptionalUsesLibs...)
Colin Cross4a80a152022-12-21 21:51:52 -08001612 // Only add these extra dependencies if the module is an app that depends on framework
1613 // libs. This avoids creating a cyclic dependency:
Paul Duffin250e6192019-06-07 10:44:37 +01001614 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
Colin Cross4a80a152022-12-21 21:51:52 -08001615 if addCompatDeps {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001616 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1617 // class loader context for dex2oat. Add them as a dependency with a special tag.
1618 ctx.AddVariationDependencies(nil, usesLibCompat29ReqTag, dexpreopt.CompatUsesLibs29...)
1619 ctx.AddVariationDependencies(nil, usesLibCompat28OptTag, dexpreopt.OptionalCompatUsesLibs28...)
1620 ctx.AddVariationDependencies(nil, usesLibCompat30OptTag, dexpreopt.OptionalCompatUsesLibs30...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001621 }
Jiakai Zhang2665d272024-03-28 11:52:08 +00001622 _, diff, _ := android.ListSetDifference(u.usesLibraryProperties.Optional_uses_libs, presentOptionalUsesLibs)
1623 u.usesLibraryProperties.Missing_optional_uses_libs = diff
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001624 } else {
1625 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.usesLibraryProperties.Uses_libs...)
1626 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross50ddcc42019-05-16 12:28:22 -07001627 }
1628}
1629
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001630// presentOptionalUsesLibs returns optional_uses_libs after filtering out libraries that don't exist in the source tree.
Colin Cross50ddcc42019-05-16 12:28:22 -07001631func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001632 optionalUsesLibs := android.FilterListPred(u.usesLibraryProperties.Optional_uses_libs, func(s string) bool {
1633 exists := ctx.OtherModuleExists(s)
Jiakai Zhang48203e32023-06-02 23:42:21 +01001634 if !exists && !android.InList(ctx.ModuleName(), ctx.Config().BuildWarningBadOptionalUsesLibsAllowlist()) {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001635 fmt.Printf("Warning: Module '%s' depends on non-existing optional_uses_libs '%s'\n", ctx.ModuleName(), s)
1636 }
1637 return exists
1638 })
Colin Cross50ddcc42019-05-16 12:28:22 -07001639 return optionalUsesLibs
1640}
1641
Ulya Trafimovich24446712021-07-15 14:59:34 +01001642// Returns a map of module names of shared library dependencies to the paths to their dex jars on
1643// host and on device.
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001644func (u *usesLibrary) classLoaderContextForUsesLibDeps(ctx android.ModuleContext) dexpreopt.ClassLoaderContextMap {
1645 clcMap := make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich24446712021-07-15 14:59:34 +01001646
1647 // Skip when UnbundledBuild() is true, but UnbundledBuildImage() is false. With
1648 // UnbundledBuildImage() it is necessary to generate dexpreopt.config for post-dexpreopting.
1649 if ctx.Config().UnbundledBuild() && !ctx.Config().UnbundledBuildImage() {
1650 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001651 }
1652
Ulya Trafimovich24446712021-07-15 14:59:34 +01001653 ctx.VisitDirectDeps(func(m android.Module) {
1654 tag, isUsesLibTag := ctx.OtherModuleDependencyTag(m).(usesLibraryDependencyTag)
1655 if !isUsesLibTag {
1656 return
1657 }
1658
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001659 dep := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(m))
Ulya Trafimovich24446712021-07-15 14:59:34 +01001660
Ulya Trafimovich840efb62021-07-15 14:34:40 +01001661 // Skip stub libraries. A dependency on the implementation library has been added earlier,
1662 // so it will be added to CLC, but the stub shouldn't be. Stub libraries can be distingushed
1663 // from implementation libraries by their name, which is different as it has a suffix.
1664 if comp, ok := m.(SdkLibraryComponentDependency); ok {
1665 if impl := comp.OptionalSdkLibraryImplementation(); impl != nil && *impl != dep {
1666 return
1667 }
1668 }
1669
Spandan Das0727ba72024-02-13 16:37:43 +00001670 // Skip java_sdk_library dependencies that provide stubs, but not an implementation.
1671 // This will be restricted to optional_uses_libs
1672 if sdklib, ok := m.(SdkLibraryDependency); ok {
1673 if tag == usesLibOptTag && sdklib.DexJarBuildPath(ctx).PathOrNil() == nil {
1674 u.shouldDisableDexpreopt = true
1675 return
1676 }
1677 }
1678
Ulya Trafimovich24446712021-07-15 14:59:34 +01001679 if lib, ok := m.(UsesLibraryDependency); ok {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001680 libName := dep
Ulya Trafimovich24446712021-07-15 14:59:34 +01001681 if ulib, ok := m.(ProvidesUsesLib); ok && ulib.ProvidesUsesLib() != nil {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001682 libName = *ulib.ProvidesUsesLib()
Ulya Trafimovich24446712021-07-15 14:59:34 +01001683 }
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001684 clcMap.AddContext(ctx, tag.sdkVersion, libName, tag.optional,
Spandan Das59a4a2b2024-01-09 21:35:56 +00001685 lib.DexJarBuildPath(ctx).PathOrNil(), lib.DexJarInstallPath(),
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001686 lib.ClassLoaderContexts())
Ulya Trafimovich24446712021-07-15 14:59:34 +01001687 } else if ctx.Config().AllowMissingDependencies() {
1688 ctx.AddMissingDependencies([]string{dep})
1689 } else {
1690 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", dep)
1691 }
1692 })
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001693 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001694}
1695
1696// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1697// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1698// unconditionally in the future.
1699func (u *usesLibrary) enforceUsesLibraries() bool {
1700 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1701 len(u.usesLibraryProperties.Optional_uses_libs) > 0
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001702 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, u.enforce || defaultEnforceUsesLibs)
Colin Cross50ddcc42019-05-16 12:28:22 -07001703}
1704
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001705// Freeze the value of `enforce_uses_libs` based on the current values of `uses_libs` and `optional_uses_libs`.
1706func (u *usesLibrary) freezeEnforceUsesLibraries() {
1707 enforce := u.enforceUsesLibraries()
1708 u.usesLibraryProperties.Enforce_uses_libs = &enforce
1709}
1710
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001711// verifyUsesLibraries checks the <uses-library> tags in the manifest against the ones specified
1712// in the `uses_libs`/`optional_uses_libs` properties. The input can be either an XML manifest, or
1713// an APK with the manifest embedded in it (manifest_check will know which one it is by the file
1714// extension: APKs are supposed to end with '.apk').
1715func (u *usesLibrary) verifyUsesLibraries(ctx android.ModuleContext, inputFile android.Path,
Jiakai Zhang2665d272024-03-28 11:52:08 +00001716 outputFile android.WritablePath, classLoaderContexts *dexpreopt.ClassLoaderContextMap) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001717
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001718 statusFile := dexpreopt.UsesLibrariesStatusFile(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001719
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001720 // Disable verify_uses_libraries check if dexpreopt is globally disabled. Without dexpreopt the
1721 // check is not necessary, and although it is good to have, it is difficult to maintain on
1722 // non-linux build platforms where dexpreopt is generally disabled (the check may fail due to
1723 // various unrelated reasons, such as a failure to get manifest from an APK).
Ulya Trafimovich39dd0a42021-03-29 14:57:34 +01001724 global := dexpreopt.GetGlobalConfig(ctx)
Jiakai Zhang23984422023-11-09 16:47:04 +00001725 if global.DisablePreopt || global.OnlyPreoptArtBootImage {
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001726 return inputFile
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001727 }
1728
Colin Crossf1a035e2020-11-16 17:32:30 -08001729 rule := android.NewRuleBuilder(pctx, ctx)
1730 cmd := rule.Command().BuiltTool("manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001731 Flag("--enforce-uses-libraries").
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001732 Input(inputFile).
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001733 FlagWithOutput("--enforce-uses-libraries-status ", statusFile).
Saeid Farivar Asanjanfd27c7c2022-08-08 20:21:26 +00001734 FlagWithInput("--aapt ", ctx.Config().HostToolPath(ctx, "aapt2"))
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001735
1736 if outputFile != nil {
1737 cmd.FlagWithOutput("-o ", outputFile)
1738 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001739
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001740 if dexpreopt.GetGlobalConfig(ctx).RelaxUsesLibraryCheck {
1741 cmd.Flag("--enforce-uses-libraries-relax")
1742 }
1743
Jiakai Zhang2665d272024-03-28 11:52:08 +00001744 requiredUsesLibs, optionalUsesLibs := classLoaderContexts.UsesLibs()
1745 for _, lib := range requiredUsesLibs {
Colin Cross50ddcc42019-05-16 12:28:22 -07001746 cmd.FlagWithArg("--uses-library ", lib)
1747 }
Jiakai Zhang2665d272024-03-28 11:52:08 +00001748 for _, lib := range optionalUsesLibs {
Colin Cross50ddcc42019-05-16 12:28:22 -07001749 cmd.FlagWithArg("--optional-uses-library ", lib)
1750 }
1751
Jiakai Zhang2665d272024-03-28 11:52:08 +00001752 // Also add missing optional uses libs, as the manifest check expects them.
1753 // Note that what we add here are the module names of those missing libs, not library names, while
1754 // the manifest check actually expects library names. However, the case where a library is missing
1755 // and the module name != the library name is too rare for us to handle.
1756 for _, lib := range u.usesLibraryProperties.Missing_optional_uses_libs {
1757 cmd.FlagWithArg("--missing-optional-uses-library ", lib)
1758 }
1759
Colin Crossf1a035e2020-11-16 17:32:30 -08001760 rule.Build("verify_uses_libraries", "verify <uses-library>")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001761 return outputFile
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001762}
Colin Cross50ddcc42019-05-16 12:28:22 -07001763
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001764// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against
1765// the build system and returns the path to a copy of the manifest.
Jiakai Zhang2665d272024-03-28 11:52:08 +00001766func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path,
1767 classLoaderContexts *dexpreopt.ClassLoaderContextMap) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001768 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
Jiakai Zhang2665d272024-03-28 11:52:08 +00001769 return u.verifyUsesLibraries(ctx, manifest, outputFile, classLoaderContexts)
Colin Cross50ddcc42019-05-16 12:28:22 -07001770}
1771
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001772// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the build
1773// system and returns the path to a copy of the APK.
Jiakai Zhang2665d272024-03-28 11:52:08 +00001774func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path,
1775 classLoaderContexts *dexpreopt.ClassLoaderContextMap) {
1776 u.verifyUsesLibraries(ctx, apk, nil, classLoaderContexts) // for APKs manifest_check does not write output file
Colin Cross50ddcc42019-05-16 12:28:22 -07001777}