blob: 0cb72e256251ba4e10f5b71d0945f4fd0239a5f5 [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
Colin Cross50ddcc42019-05-16 12:28:22 -070025 "github.com/google/blueprint"
26 "github.com/google/blueprint/proptools"
27
Colin Cross635c3b02016-05-18 15:37:25 -070028 "android/soong/android"
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -040029 "android/soong/bazel"
Colin Crossa4f08812018-10-02 22:03:40 -070030 "android/soong/cc"
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +010031 "android/soong/dexpreopt"
Romain Jobredeaux9973ace2023-08-30 00:27:09 -040032 "android/soong/genrule"
Colin Cross303e21f2018-08-07 16:49:25 -070033 "android/soong/tradefed"
Spandan Das0e0a8802023-09-20 19:53:30 +000034 "android/soong/ui/metrics/bp2build_metrics_proto"
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"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700133}
134
Jaewoong Jung525443a2019-02-28 15:35:54 -0800135// android_app properties that can be overridden by override_android_app
136type overridableAppProperties struct {
137 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
138 // or an android_app_certificate module name in the form ":module".
139 Certificate *string
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700140
Jaewoong Jung1c1b6e62021-03-09 15:02:31 -0800141 // Name of the signing certificate lineage file or filegroup module.
142 Lineage *string `android:"path"`
Liz Kammere2b27f42020-05-07 13:24:05 -0700143
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400144 // For overriding the --rotation-min-sdk-version property of apksig
145 RotationMinSdkVersion *string
146
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700147 // the package name of this app. The package name in the manifest file is used if one was not given.
148 Package_name *string
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800149
150 // the logging parent of this app.
151 Logging_parent *string
Liz Kammer9f9fd022020-06-18 19:44:06 +0000152
153 // Whether to rename the package in resources to the override name rather than the base name. Defaults to true.
154 Rename_resources_package *bool
zhidou198f5892022-02-17 02:33:12 +0000155
156 // Names of modules to be overridden. Listed modules can only be other binaries
157 // (in Make or Soong).
158 // This does not completely prevent installation of the overridden binaries, but if both
159 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
160 // from PRODUCT_PACKAGES.
161 Overrides []string
Jaewoong Jung525443a2019-02-28 15:35:54 -0800162}
163
Colin Cross30e076a2015-04-13 13:58:27 -0700164type AndroidApp struct {
Romain Jobredeaux1282c422021-10-29 10:52:59 -0400165 android.BazelModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700166 Library
167 aapt
Jaewoong Jung525443a2019-02-28 15:35:54 -0800168 android.OverridableModuleBase
Colin Crossa97c5d32018-03-28 14:58:31 -0700169
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900170 certificate Certificate
Colin Cross30e076a2015-04-13 13:58:27 -0700171
Colin Crossfabb6082018-02-20 17:22:23 -0800172 appProperties appProperties
Colin Crossae5caf52018-05-22 11:11:52 -0700173
Jaewoong Jung525443a2019-02-28 15:35:54 -0800174 overridableAppProperties overridableAppProperties
175
Colin Cross403cc152020-07-06 14:15:24 -0700176 jniLibs []jniLib
177 installPathForJNISymbols android.Path
178 embeddedJniLibs bool
179 jniCoverageOutputs android.Paths
Colin Crossf6237212018-10-29 23:14:58 -0700180
181 bundleFile android.Path
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800182
183 // the install APK name is normally the same as the module name, but can be overridden with PRODUCT_PACKAGE_NAME_OVERRIDES.
184 installApkName string
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800185
Colin Cross70dda7e2019-10-01 22:05:35 -0700186 installDir android.InstallPath
Jaewoong Jung0949f312019-09-11 10:25:18 -0700187
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700188 onDeviceDir string
189
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800190 additionalAaptFlags []string
Jaewoong Jung98772792019-07-01 17:15:13 -0700191
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900192 overriddenManifestPackageName string
Artur Satayev1111b842020-04-27 19:05:28 +0100193
194 android.ApexBundleDepsInfo
Matt Banda8c801262022-04-01 17:48:31 +0000195
196 javaApiUsedByOutputFile android.ModuleOutPath
Andrei Onea580636b2022-08-17 16:53:46 +0000197
198 privAppAllowlist android.OptionalPath
Colin Crosse1731a52017-12-14 11:22:55 -0800199}
200
Martin Stjernholm6d415272020-01-31 17:10:36 +0000201func (a *AndroidApp) IsInstallable() bool {
202 return Bool(a.properties.Installable)
203}
204
Colin Crossab8d1382023-07-14 17:23:41 +0000205func (a *AndroidApp) ResourcesNodeDepSet() *android.DepSet[*resourcesNode] {
206 return a.aapt.resourcesNodesDepSet
Colin Cross66f78822018-05-02 12:58:28 -0700207}
208
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900209func (a *AndroidApp) OutputFile() android.Path {
210 return a.outputFile
211}
212
Colin Cross503c1d02020-01-28 14:00:53 -0800213func (a *AndroidApp) Certificate() Certificate {
214 return a.certificate
215}
216
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700217func (a *AndroidApp) JniCoverageOutputs() android.Paths {
218 return a.jniCoverageOutputs
219}
220
Andrei Onea580636b2022-08-17 16:53:46 +0000221func (a *AndroidApp) PrivAppAllowlist() android.OptionalPath {
222 return a.privAppAllowlist
223}
224
Colin Crossa97c5d32018-03-28 14:58:31 -0700225var _ AndroidLibraryDependency = (*AndroidApp)(nil)
226
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900227type Certificate struct {
Colin Cross503c1d02020-01-28 14:00:53 -0800228 Pem, Key android.Path
229 presigned bool
230}
231
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700232var PresignedCertificate = Certificate{presigned: true}
Colin Cross503c1d02020-01-28 14:00:53 -0800233
234func (c Certificate) AndroidMkString() string {
235 if c.presigned {
236 return "PRESIGNED"
237 } else {
238 return c.Pem.String()
239 }
Colin Cross30e076a2015-04-13 13:58:27 -0700240}
241
Colin Cross46c9b8b2017-06-22 16:51:17 -0700242func (a *AndroidApp) DepsMutator(ctx android.BottomUpMutatorContext) {
243 a.Module.deps(ctx)
Colin Crossa4f08812018-10-02 22:03:40 -0700244
Jiyong Park92315372021-04-02 08:45:46 +0900245 if String(a.appProperties.Stl) == "c++_shared" && !a.SdkVersion(ctx).Specified() {
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700246 ctx.PropertyErrorf("stl", "sdk_version must be set in order to use c++_shared")
247 }
248
Jiyong Parkf1691d22021-03-29 20:11:58 +0900249 sdkDep := decodeSdkDep(ctx, android.SdkContext(a))
Paul Duffin250e6192019-06-07 10:44:37 +0100250 if sdkDep.hasFrameworkLibs() {
251 a.aapt.deps(ctx, sdkDep)
Colin Cross30e076a2015-04-13 13:58:27 -0700252 }
Colin Crossa4f08812018-10-02 22:03:40 -0700253
Jiyong Park92315372021-04-02 08:45:46 +0900254 usesSDK := a.SdkVersion(ctx).Specified() && a.SdkVersion(ctx).Kind != android.SdkCorePlatform
Colin Cross3c007702020-05-08 11:20:24 -0700255
256 if usesSDK && Bool(a.appProperties.Jni_uses_sdk_apis) {
257 ctx.PropertyErrorf("jni_uses_sdk_apis",
258 "can only be set for modules that do not set sdk_version")
259 } else if !usesSDK && Bool(a.appProperties.Jni_uses_platform_apis) {
260 ctx.PropertyErrorf("jni_uses_platform_apis",
261 "can only be set for modules that set sdk_version")
262 }
263
Colin Crossa4f08812018-10-02 22:03:40 -0700264 for _, jniTarget := range ctx.MultiTargets() {
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700265 variation := append(jniTarget.Variations(),
266 blueprint.Variation{Mutator: "link", Variation: "shared"})
Colin Crossc511bc52020-04-07 16:50:32 +0000267
268 // If the app builds against an Android SDK use the SDK variant of JNI dependencies
269 // unless jni_uses_platform_apis is set.
Colin Crossc2d24052020-05-13 11:05:02 -0700270 // Don't require the SDK variant for apps that are shipped on vendor, etc., as they already
271 // have stable APIs through the VNDK.
272 if (usesSDK && !a.RequiresStableAPIs(ctx) &&
273 !Bool(a.appProperties.Jni_uses_platform_apis)) ||
Colin Cross7204cf02020-05-06 17:51:39 -0700274 Bool(a.appProperties.Jni_uses_sdk_apis) {
Colin Crossc511bc52020-04-07 16:50:32 +0000275 variation = append(variation, blueprint.Variation{Mutator: "sdk", Variation: "sdk"})
276 }
Colin Crossde78d132020-10-09 18:59:49 -0700277 ctx.AddFarVariationDependencies(variation, jniLibTag, a.appProperties.Jni_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700278 }
Colin Cross50ddcc42019-05-16 12:28:22 -0700279
Paul Duffin250e6192019-06-07 10:44:37 +0100280 a.usesLibrary.deps(ctx, sdkDep.hasFrameworkLibs())
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700281}
Colin Crossbd01e2a2018-10-04 15:21:03 -0700282
Jaewoong Jungb639a6a2019-05-10 15:16:29 -0700283func (a *AndroidApp) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -0800284 cert := android.SrcIsModule(a.getCertString(ctx))
Colin Crossbd01e2a2018-10-04 15:21:03 -0700285 if cert != "" {
286 ctx.AddDependency(ctx.Module(), certificateTag, cert)
287 }
288
Andrei Onea580636b2022-08-17 16:53:46 +0000289 if a.appProperties.Privapp_allowlist != nil && !Bool(a.appProperties.Privileged) {
Anton Hanssone3f31cf2023-06-03 08:53:47 +0000290 // There are a few uids that are explicitly considered privileged regardless of their
291 // app's location. Bluetooth is one such app. It should arguably be moved to priv-app,
292 // but for now, allow it not to be in priv-app.
293 privilegedBecauseOfUid := ctx.ModuleName() == "Bluetooth"
294 if !privilegedBecauseOfUid {
295 ctx.PropertyErrorf("privapp_allowlist", "privileged must be set in order to use privapp_allowlist (with a few exceptions)")
296 }
Andrei Onea580636b2022-08-17 16:53:46 +0000297 }
298
Colin Crossbd01e2a2018-10-04 15:21:03 -0700299 for _, cert := range a.appProperties.Additional_certificates {
300 cert = android.SrcIsModule(cert)
301 if cert != "" {
302 ctx.AddDependency(ctx.Module(), certificateTag, cert)
303 } else {
304 ctx.PropertyErrorf("additional_certificates",
305 `must be names of android_app_certificate modules in the form ":module"`)
306 }
307 }
Colin Cross30e076a2015-04-13 13:58:27 -0700308}
309
Jeongik Cha538c0d02019-07-11 15:54:27 +0900310func (a *AndroidTestHelperApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
311 a.generateAndroidBuildActions(ctx)
312}
313
Colin Cross46c9b8b2017-06-22 16:51:17 -0700314func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100315 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700316 a.generateAndroidBuildActions(ctx)
Matt Banda8c801262022-04-01 17:48:31 +0000317 a.generateJavaUsedByApex(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700318}
319
Sam Delmerico0e0d96e2023-08-18 22:43:28 +0000320func (a *AndroidApp) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
321 defaultMinSdkVersion := a.Module.MinSdkVersion(ctx)
322 if proptools.Bool(a.appProperties.Updatable) {
323 overrideApiLevel := android.MinSdkVersionFromValue(ctx, ctx.DeviceConfig().ApexGlobalMinSdkVersionOverride())
324 if !overrideApiLevel.IsNone() && overrideApiLevel.CompareTo(defaultMinSdkVersion) > 0 {
325 return overrideApiLevel
326 }
327 }
328 return defaultMinSdkVersion
329}
330
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100331func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100332 if a.Updatable() {
Jiyong Park92315372021-04-02 08:45:46 +0900333 if !a.SdkVersion(ctx).Stable() {
334 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.SdkVersion(ctx))
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100335 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100336 if String(a.deviceProperties.Min_sdk_version) == "" {
337 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
338 }
Jooyung Han749dc692020-04-15 11:03:39 +0900339
Jiyong Park92315372021-04-02 08:45:46 +0900340 if minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx); err == nil {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900341 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
satayevb3fd4112021-12-02 13:59:35 +0000342 android.CheckMinSdkVersion(ctx, minSdkVersion, a.WalkPayloadDeps)
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900343 } else {
344 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
345 }
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000346
347 if !BoolDefault(a.appProperties.Enforce_default_target_sdk_version, true) {
348 ctx.PropertyErrorf("enforce_default_target_sdk_version", "Updatable apps must enforce default target sdk version")
349 }
350 // TODO(b/227460469) after all the modules removes the target sdk version, throw an error if the target sdk version is explicitly set.
351 if a.deviceProperties.Target_sdk_version == nil {
352 a.SetEnforceDefaultTargetSdkVersion(true)
353 }
354 }
355
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100356 a.checkPlatformAPI(ctx)
357 a.checkSdkVersions(ctx)
358}
359
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900360// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
361// This check is enforced for "updatable" APKs (including APK-in-APEX).
Jiyong Park54105c42021-03-31 18:17:53 +0900362func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion android.ApiLevel) {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900363 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
364 ctx.VisitDirectDeps(func(m android.Module) {
365 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
366 return
367 }
368 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900369 // The domain of cc.sdk_version is "current" and <number>
Jiyong Parkf1691d22021-03-29 20:11:58 +0900370 // We can rely on android.SdkSpec to convert it to <number> so that "current" is
371 // handled properly regardless of sdk finalization.
Spandan Das2e8c0442022-05-08 00:39:35 +0000372 jniSdkVersion, err := android.SdkSpecFrom(ctx, dep.MinSdkVersion()).EffectiveVersion(ctx)
Jiyong Park54105c42021-03-31 18:17:53 +0900373 if err != nil || minSdkVersion.LessThan(jniSdkVersion) {
Spandan Das2e8c0442022-05-08 00:39:35 +0000374 ctx.OtherModuleErrorf(dep, "min_sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
375 dep.MinSdkVersion(), minSdkVersion, ctx.ModuleName())
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900376 return
377 }
378
379 })
380}
381
Sasha Smundak6ad77252019-05-01 13:16:22 -0700382// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800383// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700384func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park92315372021-04-02 08:45:46 +0900385 minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800386 if err != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900387 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.MinSdkVersion(ctx), err)
Colin Crosse4246ab2019-02-05 21:55:21 -0800388 }
389
Colin Cross56a83212020-09-15 18:30:11 -0700390 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Jiyong Park54105c42021-03-31 18:17:53 +0900391 return (minSdkVersion.FinalOrFutureInt() >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
Colin Cross56a83212020-09-15 18:30:11 -0700392 !apexInfo.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800393}
394
Colin Cross43f08db2018-11-12 10:13:39 -0800395// Returns whether this module should have the dex file stored uncompressed in the APK.
396func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800397 if Bool(a.appProperties.Use_embedded_dex) {
398 return true
399 }
400
Colin Cross53a87f52019-06-25 13:35:30 -0700401 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
402 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900403 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000404 return true
405 }
406
Colin Cross53a87f52019-06-25 13:35:30 -0700407 if ctx.Config().UnbundledBuild() {
408 return false
409 }
410
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700411 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700412}
413
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700414func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
Colin Cross56a83212020-09-15 18:30:11 -0700415 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700416 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Colin Cross56a83212020-09-15 18:30:11 -0700417 !apexInfo.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700418}
419
Liz Kammer9f9fd022020-06-18 19:44:06 +0000420func generateAaptRenamePackageFlags(packageName string, renameResourcesPackage bool) []string {
421 aaptFlags := []string{"--rename-manifest-package " + packageName}
422 if renameResourcesPackage {
423 // Required to rename the package name in the resources table.
424 aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
425 }
426 return aaptFlags
427}
428
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900429func (a *AndroidApp) OverriddenManifestPackageName() string {
430 return a.overriddenManifestPackageName
431}
432
Liz Kammer9f9fd022020-06-18 19:44:06 +0000433func (a *AndroidApp) renameResourcesPackage() bool {
434 return proptools.BoolDefault(a.overridableAppProperties.Rename_resources_package, true)
435}
436
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800437func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900438 usePlatformAPI := proptools.Bool(a.Module.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900439 if ctx.Module().(android.SdkContext).SdkVersion(ctx).Kind == android.SdkModule {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900440 usePlatformAPI = true
441 }
442 a.aapt.usesNonSdkApis = usePlatformAPI
David Brazdild25060a2019-02-18 18:24:16 +0000443
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700444 // Ask manifest_fixer to add or update the application element indicating this app has no code.
445 a.aapt.hasNoCode = !a.hasCode(ctx)
446
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800447 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800448
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800449 // Add TARGET_AAPT_CHARACTERISTICS values to AAPT link flags if they exist and --product flags were not provided.
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800450 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700451 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800452 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700453 }
454
Dan Willemsen72be5902018-10-24 20:24:57 -0700455 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
456 // Product AAPT config
457 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800458 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700459 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700460
Dan Willemsen72be5902018-10-24 20:24:57 -0700461 // Product AAPT preferred config
462 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800463 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700464 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700465 }
466
Jiyong Park7f67f482019-01-05 12:57:48 +0900467 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700468 if overridden || a.overridableAppProperties.Package_name != nil {
469 // The product override variable has a priority over the package_name property.
470 if !overridden {
471 manifestPackageName = *a.overridableAppProperties.Package_name
472 }
Liz Kammer9f9fd022020-06-18 19:44:06 +0000473 aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName, a.renameResourcesPackage())...)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900474 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900475 }
476
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800477 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
478
Colin Crosse560c4a2019-03-19 16:03:11 -0700479 a.aapt.splitNames = a.appProperties.Package_splits
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800480 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Alexei Nicoara69cf0f32022-07-27 14:59:18 +0100481 if a.Updatable() {
482 a.aapt.defaultManifestVersion = android.DefaultUpdatableModuleVersion
483 }
Alixf7a10272023-09-27 16:47:56 +0000484 a.aapt.buildActions(ctx,
485 aaptBuildActionOptions{
486 android.SdkContext(a),
487 a.classLoaderContexts,
488 a.usesLibraryProperties.Exclude_uses_libs,
489 a.enforceDefaultTargetSdkVersion(),
490 aaptLinkFlags,
491 },
492 )
Colin Cross30e076a2015-04-13 13:58:27 -0700493
Colin Cross46c9b8b2017-06-22 16:51:17 -0700494 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700495 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800496}
Colin Cross30e076a2015-04-13 13:58:27 -0700497
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800498func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700499 var staticLibProguardFlagFiles android.Paths
500 ctx.VisitDirectDeps(func(m android.Module) {
Sam Delmerico95d70942023-08-02 18:00:35 -0400501 depProguardInfo := ctx.OtherModuleProvider(m, ProguardSpecInfoProvider).(ProguardSpecInfo)
502 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.UnconditionallyExportedProguardFlags.ToList()...)
503 if ctx.OtherModuleDependencyTag(m) == staticLibTag {
504 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.ProguardFlagsFiles.ToList()...)
Colin Cross89c31582018-04-30 15:55:11 -0700505 }
506 })
507
508 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
509
510 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
511 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800512}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800513
Colin Cross403cc152020-07-06 14:15:24 -0700514func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
Colin Cross43f08db2018-11-12 10:13:39 -0800515 var installDir string
516 if ctx.ModuleName() == "framework-res" {
517 // framework-res.apk is installed as system/framework/framework-res.apk
518 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900519 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800520 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800521 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800522 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800523 }
Colin Cross403cc152020-07-06 14:15:24 -0700524
525 return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
526}
527
Ulya Trafimovich18554242020-11-03 15:55:11 +0000528func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) android.Path {
Colin Cross403cc152020-07-06 14:15:24 -0700529 a.dexpreopter.installPath = a.installPath(ctx)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000530 a.dexpreopter.isApp = true
Liz Kammera7a64f32020-07-09 15:16:41 -0700531 if a.dexProperties.Uncompress_dex == nil {
David Srbeckye033cba2020-05-20 22:20:28 +0100532 // If the value was not force-set by the user, use reasonable default based on the module.
Liz Kammera7a64f32020-07-09 15:16:41 -0700533 a.dexProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
David Srbeckye033cba2020-05-20 22:20:28 +0100534 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700535 a.dexpreopter.uncompressedDex = *a.dexProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700536 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100537 a.dexpreopter.classLoaderContexts = a.classLoaderContexts
Colin Cross50ddcc42019-05-16 12:28:22 -0700538 a.dexpreopter.manifestFile = a.mergedManifestFile
Colin Crossfa9bfcd2021-11-10 16:42:38 -0800539 a.dexpreopter.preventInstall = a.appProperties.PreventInstall
Colin Cross50ddcc42019-05-16 12:28:22 -0700540
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800541 if ctx.ModuleName() != "framework-res" {
Colin Cross4eae06d2023-06-20 22:40:02 -0700542 var extraSrcJars android.Paths
543 var extraClasspathJars android.Paths
544 var extraCombinedJars android.Paths
545 if a.useResourceProcessorBusyBox() {
546 // When building an app with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox has already
547 // created R.class files that provide IDs for resources in busybox/R.jar. Pass that file in the
548 // classpath when compiling everything else, and add it to the final classes jar.
549 extraClasspathJars = android.Paths{a.aapt.rJar}
550 extraCombinedJars = android.Paths{a.aapt.rJar}
551 } else {
552 // When building an app without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
553 // R.java files for the app's package and the packages from all transitive static android_library
554 // dependencies. Compile the srcjar alongside the rest of the sources.
555 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
556 }
557
558 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800559 }
Colin Cross30e076a2015-04-13 13:58:27 -0700560
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100561 return a.dexJarFile.PathOrNil()
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800562}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800563
Sam Delmerico82602492022-06-10 17:05:42 +0000564func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, prebuiltJniPackages android.Paths, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700565 var jniJarFile android.WritablePath
Sam Delmerico82602492022-06-10 17:05:42 +0000566 if len(jniLibs) > 0 || len(prebuiltJniPackages) > 0 {
Colin Cross403cc152020-07-06 14:15:24 -0700567 a.jniLibs = jniLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700568 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700569 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Colin Crossc68db4b2021-11-11 18:59:15 -0800570 a.installPathForJNISymbols = a.installPath(ctx)
Sam Delmerico82602492022-06-10 17:05:42 +0000571 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, prebuiltJniPackages, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700572 for _, jni := range jniLibs {
573 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700574 // Only collect coverage for the first target arch if this is a multilib target.
575 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
576 // data file path collisions since the current coverage file path format doesn't contain
577 // arch-related strings. This is fine for now though; the code coverage team doesn't use
578 // multi-arch targets such as test_suite_* for coverage collections yet.
579 //
580 // Work with the team to come up with a new format that handles multilib modules properly
581 // and change this.
582 if len(ctx.Config().Targets[android.Android]) == 1 ||
Jaewoong Jung642916f2020-10-09 17:25:15 -0700583 ctx.Config().AndroidFirstDeviceTarget.Arch.ArchType == jni.target.Arch.ArchType {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700584 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
585 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700586 }
587 }
Colin Cross403cc152020-07-06 14:15:24 -0700588 a.embeddedJniLibs = true
Colin Crossa4f08812018-10-02 22:03:40 -0700589 }
590 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800591 return jniJarFile
592}
Colin Crossa4f08812018-10-02 22:03:40 -0700593
Colin Cross403cc152020-07-06 14:15:24 -0700594func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
595 var jniSymbols android.RuleBuilderInstalls
596 for _, jniLib := range a.jniLibs {
597 if jniLib.unstrippedFile != nil {
598 jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
599 From: jniLib.unstrippedFile,
600 To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
601 })
602 }
603 }
604 return jniSymbols
605}
606
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700607// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
608// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
Colin Crossbc2c8a72022-09-14 12:45:42 -0700609func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate,
610 ctx android.ModuleContext) (mainCertificate Certificate, allCertificates []Certificate) {
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700611 if android.SrcIsModule(certPropValue) == "" {
612 var mainCert Certificate
613 if certPropValue != "" {
614 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
615 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800616 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
617 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700618 }
619 } else {
620 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800621 mainCert = Certificate{
622 Pem: pem,
623 Key: key,
624 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700625 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700626 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700627 }
628
Colin Crossbc2c8a72022-09-14 12:45:42 -0700629 if len(certificates) > 0 {
630 mainCertificate = certificates[0]
631 } else {
632 // This can be reached with an empty certificate list if AllowMissingDependencies is set
633 // and the certificate property for this module is a module reference to a missing module.
634 if !ctx.Config().AllowMissingDependencies() && len(ctx.GetMissingDependencies()) > 0 {
635 panic("Should only get here if AllowMissingDependencies set and there are missing dependencies")
636 }
637 // Set a certificate to avoid panics later when accessing it.
638 mainCertificate = Certificate{
639 Key: android.PathForModuleOut(ctx, "missing.pk8"),
Colin Crossa54f4b52022-11-21 04:35:53 +0000640 Pem: android.PathForModuleOut(ctx, "missing.x509.pem"),
Colin Crossbc2c8a72022-09-14 12:45:42 -0700641 }
642 }
643
Zyan Wub7550aa2023-05-18 15:46:31 +0800644 if !m.Platform() {
645 certPath := mainCertificate.Pem.String()
646 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
647 if strings.HasPrefix(certPath, systemCertPath) {
648 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
649 allowed := ctx.Config().EnforceSystemCertificateAllowList()
650
651 if enforceSystemCert && !inList(m.Name(), allowed) {
652 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
653 }
654 }
655 }
656
Colin Crossbc2c8a72022-09-14 12:45:42 -0700657 return mainCertificate, certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800658}
659
Jooyung Han39ee1192020-03-23 20:21:11 +0900660func (a *AndroidApp) InstallApkName() string {
661 return a.installApkName
662}
663
Sam Delmerico15809f82023-05-15 17:21:47 -0400664func (a *AndroidApp) createPrivappAllowlist(ctx android.ModuleContext) android.Path {
Andrei Onea580636b2022-08-17 16:53:46 +0000665 if a.appProperties.Privapp_allowlist == nil {
666 return nil
667 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400668
669 isOverrideApp := a.GetOverriddenBy() != ""
670 if !isOverrideApp {
671 // if this is not an override, we don't need to rewrite the existing privapp allowlist
672 return android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist)
673 }
674
Andrei Onea580636b2022-08-17 16:53:46 +0000675 if a.overridableAppProperties.Package_name == nil {
676 ctx.PropertyErrorf("privapp_allowlist", "package_name must be set to use privapp_allowlist")
677 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400678
Andrei Onea580636b2022-08-17 16:53:46 +0000679 packageName := *a.overridableAppProperties.Package_name
680 fileName := "privapp_allowlist_" + packageName + ".xml"
681 outPath := android.PathForModuleOut(ctx, fileName).OutputPath
682 ctx.Build(pctx, android.BuildParams{
683 Rule: modifyAllowlist,
684 Input: android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist),
685 Output: outPath,
686 Args: map[string]string{
687 "packageName": packageName,
688 },
689 })
690 return &outPath
691}
692
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800693func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700694 var apkDeps android.Paths
695
Colin Cross56a83212020-09-15 18:30:11 -0700696 if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
697 a.hideApexVariantFromMake = true
698 }
699
Jeongik Cha538c0d02019-07-11 15:54:27 +0900700 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
701 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
702
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000703 // Unlike installApkName, a.stem should respect base module name for override_android_app.
704 // Therefore, use ctx.ModuleName() instead of a.Name().
705 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
706
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800707 // Check if the install APK name needs to be overridden.
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000708 // Both android_app and override_android_app module are expected to possess
709 // its module bound apk path. However, override_android_app inherits ctx.ModuleName()
710 // from the base module. Therefore, use a.Name() which represents
711 // the module name for both android_app and override_android_app.
712 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(
713 proptools.StringDefault(a.overridableDeviceProperties.Stem, a.Name()))
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800714
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700715 if ctx.ModuleName() == "framework-res" {
716 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700717 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900718 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700719 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
720 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800721 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700722 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700723 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700724 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700725 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700726
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100727 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000728
Colin Cross61fb62e2022-06-23 10:46:28 -0700729 var noticeAssetPath android.WritablePath
730 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
731 // The rule to create the notice file can't be generated yet, as the final output path
732 // for the apk isn't known yet. Add the path where the notice file will be generated to the
733 // aapt rules now before calling aaptBuildActions, the rule to create the notice file will
734 // be generated later.
735 noticeAssetPath = android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
736 a.aapt.noticeFile = android.OptionalPathForPath(noticeAssetPath)
737 }
738
Harshit Mahajan8f202ad2023-01-09 20:45:55 +0000739 // For apps targeting latest target_sdk_version
740 if Bool(a.appProperties.Enforce_default_target_sdk_version) {
741 a.SetEnforceDefaultTargetSdkVersion(true)
742 }
743
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800744 // Process all building blocks, from AAPT to certificates.
745 a.aaptBuildActions(ctx)
746
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100747 // The decision to enforce <uses-library> checks is made before adding implicit SDK libraries.
748 a.usesLibrary.freezeEnforceUsesLibraries()
749
750 // Add implicit SDK libraries to <uses-library> list.
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100751 requiredUsesLibs, optionalUsesLibs := a.classLoaderContexts.UsesLibs()
752 for _, usesLib := range requiredUsesLibs {
753 a.usesLibrary.addLib(usesLib, false)
754 }
755 for _, usesLib := range optionalUsesLibs {
756 a.usesLibrary.addLib(usesLib, true)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100757 }
758
759 // Check that the <uses-library> list is coherent with the manifest.
Colin Cross50ddcc42019-05-16 12:28:22 -0700760 if a.usesLibrary.enforceUsesLibraries() {
761 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
762 apkDeps = append(apkDeps, manifestCheckFile)
763 }
764
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800765 a.proguardBuildActions(ctx)
766
Colin Cross014489c2020-06-02 20:09:13 -0700767 a.linter.mergedManifest = a.aapt.mergedManifestFile
768 a.linter.manifest = a.aapt.manifestPath
769 a.linter.resources = a.aapt.resourceFiles
Colin Crossc0efd1d2020-07-03 11:56:24 -0700770 a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
Colin Cross014489c2020-06-02 20:09:13 -0700771
Ulya Trafimovich18554242020-11-03 15:55:11 +0000772 dexJarFile := a.dexBuildActions(ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800773
Colin Crossbc2c8a72022-09-14 12:45:42 -0700774 jniLibs, prebuiltJniPackages, certificates := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Sam Delmerico82602492022-06-10 17:05:42 +0000775 jniJarFile := a.jniBuildActions(jniLibs, prebuiltJniPackages, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800776
777 if ctx.Failed() {
778 return
779 }
780
Colin Crossbc2c8a72022-09-14 12:45:42 -0700781 a.certificate, certificates = processMainCert(a.ModuleBase, a.getCertString(ctx), certificates, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800782
783 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800784 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700785 v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
786 var v4SignatureFile android.WritablePath = nil
787 if v4SigningRequested {
788 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
789 }
Liz Kammere2b27f42020-05-07 13:24:05 -0700790 var lineageFile android.Path
791 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
792 lineageFile = android.PathForModuleSrc(ctx, lineage)
793 }
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400794 rotationMinSdkVersion := String(a.overridableAppProperties.RotationMinSdkVersion)
795
Rico Wind351bac92022-09-22 10:41:42 +0200796 CreateAndSignAppPackage(ctx, packageFile, a.exportPackage, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion, Bool(a.dexProperties.Optimize.Shrink_resources))
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800797 a.outputFile = packageFile
Songchun Fan17d69e32020-03-24 20:32:24 -0700798 if v4SigningRequested {
799 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
800 }
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800801
Colin Cross61fb62e2022-06-23 10:46:28 -0700802 if a.aapt.noticeFile.Valid() {
803 // Generating the notice file rule has to be here after a.outputFile is known.
Bob Badoureef4c1c2022-05-16 12:20:04 -0700804 noticeFile := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700805 android.BuildNoticeHtmlOutputFromLicenseMetadata(
806 ctx, noticeFile, "", "",
807 []string{
808 a.installDir.String() + "/",
809 android.PathForModuleInstall(ctx).String() + "/",
810 a.outputFile.String(),
811 })
Bob Badoureef4c1c2022-05-16 12:20:04 -0700812 builder := android.NewRuleBuilder(pctx, ctx)
813 builder.Command().Text("cp").
814 Input(noticeFile).
815 Output(noticeAssetPath)
816 builder.Build("notice_dir", "Building notice dir")
Bob Badoureef4c1c2022-05-16 12:20:04 -0700817 }
818
Colin Crosse560c4a2019-03-19 16:03:11 -0700819 for _, split := range a.aapt.splits {
820 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800821 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700822 if v4SigningRequested {
823 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
824 }
Rico Wind351bac92022-09-22 10:41:42 +0200825 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion, false)
Colin Crosse560c4a2019-03-19 16:03:11 -0700826 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
Songchun Fan17d69e32020-03-24 20:32:24 -0700827 if v4SigningRequested {
828 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
829 }
Colin Crosse560c4a2019-03-19 16:03:11 -0700830 }
831
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800832 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700833 bundleFile := android.PathForModuleOut(ctx, "base.zip")
834 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
835 a.bundleFile = bundleFile
836
Andrei Onea580636b2022-08-17 16:53:46 +0000837 allowlist := a.createPrivappAllowlist(ctx)
838 if allowlist != nil {
839 a.privAppAllowlist = android.OptionalPathForPath(allowlist)
840 }
841
Colin Cross56a83212020-09-15 18:30:11 -0700842 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
843
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800844 // Install the app package.
Andrei Onea580636b2022-08-17 16:53:46 +0000845 shouldInstallAppPackage := (Bool(a.Module.properties.Installable) || ctx.Host()) && apexInfo.IsForPlatform() && !a.appProperties.PreventInstall
846 if shouldInstallAppPackage {
Sam Delmericob1daccd2023-05-25 14:45:30 -0400847 if a.privAppAllowlist.Valid() {
Anton Hansson0e486a42023-06-01 16:38:35 +0000848 allowlistInstallPath := android.PathForModuleInstall(ctx, "etc", "permissions")
849 allowlistInstallFilename := a.installApkName + ".xml"
850 ctx.InstallFile(allowlistInstallPath, allowlistInstallFilename, a.privAppAllowlist.Path())
Sam Delmericob1daccd2023-05-25 14:45:30 -0400851 }
852
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700853 var extraInstalledPaths android.Paths
Jiyong Park8ba50f92019-11-13 15:01:01 +0900854 for _, extra := range a.extraOutputFiles {
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700855 installed := ctx.InstallFile(a.installDir, extra.Base(), extra)
856 extraInstalledPaths = append(extraInstalledPaths, installed)
Jiyong Park8ba50f92019-11-13 15:01:01 +0900857 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700858 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile, extraInstalledPaths...)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800859 }
Artur Satayev1111b842020-04-27 19:05:28 +0100860
861 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700862}
863
Colin Crossc2d24052020-05-13 11:05:02 -0700864type appDepsInterface interface {
Jiyong Park92315372021-04-02 08:45:46 +0900865 SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000866 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Colin Crossc2d24052020-05-13 11:05:02 -0700867 RequiresStableAPIs(ctx android.BaseModuleContext) bool
868}
869
870func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
871 shouldCollectRecursiveNativeDeps bool,
Sam Delmerico82602492022-06-10 17:05:42 +0000872 checkNativeSdkVersion bool) ([]jniLib, android.Paths, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700873
Colin Crossa4f08812018-10-02 22:03:40 -0700874 var jniLibs []jniLib
Sam Delmerico82602492022-06-10 17:05:42 +0000875 var prebuiltJniPackages android.Paths
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900876 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800877 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700878
Colin Crossc2d24052020-05-13 11:05:02 -0700879 if checkNativeSdkVersion {
Jiyong Park92315372021-04-02 08:45:46 +0900880 checkNativeSdkVersion = app.SdkVersion(ctx).Specified() &&
881 app.SdkVersion(ctx).Kind != android.SdkCorePlatform && !app.RequiresStableAPIs(ctx)
Colin Crossc2d24052020-05-13 11:05:02 -0700882 }
883
Peter Collingbournead84f972019-12-17 16:46:18 -0800884 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700885 otherName := ctx.OtherModuleName(module)
886 tag := ctx.OtherModuleDependencyTag(module)
887
Colin Crossf0913fb2020-07-29 12:59:39 -0700888 if IsJniDepTag(tag) || cc.IsSharedDepTag(tag) {
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400889 if dep, ok := module.(cc.LinkableInterface); ok {
Colin Cross95f1ca02020-10-29 20:47:22 -0700890 if dep.IsNdk(ctx.Config()) || dep.IsStubs() {
Peter Collingbournead84f972019-12-17 16:46:18 -0800891 return false
892 }
893
Colin Crossa4f08812018-10-02 22:03:40 -0700894 lib := dep.OutputFile()
895 if lib.Valid() {
Cole Faust64cb7c92021-09-14 17:32:49 -0700896 path := lib.Path()
897 if seenModulePaths[path.String()] {
898 return false
899 }
900 seenModulePaths[path.String()] = true
901
902 if checkNativeSdkVersion && dep.SdkVersion() == "" {
903 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
904 otherName)
905 }
906
Colin Crossa4f08812018-10-02 22:03:40 -0700907 jniLibs = append(jniLibs, jniLib{
Colin Cross403cc152020-07-06 14:15:24 -0700908 name: ctx.OtherModuleName(module),
909 path: path,
910 target: module.Target(),
911 coverageFile: dep.CoverageOutputFile(),
912 unstrippedFile: dep.UnstrippedOutputFile(),
Jihoon Kangf78a8902022-09-01 22:47:07 +0000913 partition: dep.Partition(),
Colin Crossa4f08812018-10-02 22:03:40 -0700914 })
Colin Crossdd5261c2022-12-19 12:26:43 -0800915 } else if ctx.Config().AllowMissingDependencies() {
916 ctx.AddMissingDependencies([]string{otherName})
Colin Crossa4f08812018-10-02 22:03:40 -0700917 } else {
918 ctx.ModuleErrorf("dependency %q missing output file", otherName)
919 }
920 } else {
921 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700922 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800923
924 return shouldCollectRecursiveNativeDeps
925 }
926
Sam Delmerico82602492022-06-10 17:05:42 +0000927 if info, ok := ctx.OtherModuleProvider(module, JniPackageProvider).(JniPackageInfo); ok {
928 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
929 }
930
Peter Collingbournead84f972019-12-17 16:46:18 -0800931 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700932 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900933 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700934 } else {
935 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
936 }
Colin Crossa4f08812018-10-02 22:03:40 -0700937 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800938
939 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700940 })
941
Sam Delmerico82602492022-06-10 17:05:42 +0000942 return jniLibs, prebuiltJniPackages, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700943}
944
Jooyung Han749dc692020-04-15 11:03:39 +0900945func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +0100946 ctx.WalkDeps(func(child, parent android.Module) bool {
947 isExternal := !a.DepIsInSameApex(ctx, child)
948 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +0900949 if !do(ctx, parent, am, isExternal) {
950 return false
951 }
Artur Satayev1111b842020-04-27 19:05:28 +0100952 }
953 return !isExternal
954 })
955}
956
957func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
958 if ctx.Host() {
959 return
960 }
961
962 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +0900963 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +0100964 depName := to.Name()
Artur Satayev533b98c2021-03-11 18:03:42 +0000965
966 // Skip dependencies that are only available to APEXes; they are developed with updatability
967 // in mind and don't need manual approval.
968 if to.(android.ApexModule).NotAvailableForPlatform() {
969 return true
970 }
971
Artur Satayev1111b842020-04-27 19:05:28 +0100972 if info, exist := depsInfo[depName]; exist {
973 info.From = append(info.From, from.Name())
974 info.IsExternal = info.IsExternal && externalDep
975 depsInfo[depName] = info
976 } else {
977 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +0900978 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000979 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +0900980 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000981 if v := m.MinSdkVersion(ctx); !v.IsNone() {
982 toMinSdkVersion = v.String()
Artur Satayev1111b842020-04-27 19:05:28 +0100983 }
Jiyong Park92315372021-04-02 08:45:46 +0900984 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
985 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
986 // string
987 if v := m.MinSdkVersion(); v != "" {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900988 toMinSdkVersion = v
989 }
Artur Satayev1111b842020-04-27 19:05:28 +0100990 }
991 depsInfo[depName] = android.ApexModuleDepInfo{
992 To: depName,
993 From: []string{from.Name()},
994 IsExternal: externalDep,
995 MinSdkVersion: toMinSdkVersion,
996 }
997 }
Jooyung Han749dc692020-04-15 11:03:39 +0900998 return true
Artur Satayev1111b842020-04-27 19:05:28 +0100999 })
1000
Jiyong Park92315372021-04-02 08:45:46 +09001001 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depsInfo)
Artur Satayev1111b842020-04-27 19:05:28 +01001002}
1003
Harshit Mahajan5b8b7302022-06-10 11:24:05 +00001004func (a *AndroidApp) enforceDefaultTargetSdkVersion() bool {
1005 return a.appProperties.EnforceDefaultTargetSdkVersion
1006}
1007
1008func (a *AndroidApp) SetEnforceDefaultTargetSdkVersion(val bool) {
1009 a.appProperties.EnforceDefaultTargetSdkVersion = val
1010}
1011
Artur Satayev849f8442020-04-28 14:57:42 +01001012func (a *AndroidApp) Updatable() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001013 return Bool(a.appProperties.Updatable)
Artur Satayev849f8442020-04-28 14:57:42 +01001014}
1015
Spandan Das42e89502022-05-06 22:12:55 +00001016func (a *AndroidApp) SetUpdatable(val bool) {
1017 a.appProperties.Updatable = &val
1018}
1019
Colin Cross0ea8ba82019-06-06 14:33:29 -07001020func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001021 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
1022 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001023 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001024 }
Jaewoong Jung525443a2019-02-28 15:35:54 -08001025 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001026}
1027
Jiyong Park0f80c182020-01-31 02:49:53 +09001028func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1029 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
1030 return true
1031 }
1032 return a.Library.DepIsInSameApex(ctx, dep)
1033}
1034
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001035// For OutputFileProducer interface
1036func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
1037 switch tag {
Jared Duke34b080d2023-03-30 16:40:24 -07001038 // In some instances, it can be useful to reference the aapt-generated flags from another
1039 // target, e.g., system server implements services declared in the framework-res manifest.
1040 case ".aapt.proguardOptionsFile":
1041 return []android.Path{a.proguardOptionsFile}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001042 case ".aapt.srcjar":
Colin Crossf3b7bad2023-08-02 15:49:00 -07001043 if a.aaptSrcJar != nil {
1044 return []android.Path{a.aaptSrcJar}, nil
1045 }
1046 case ".aapt.jar":
1047 if a.rJar != nil {
1048 return []android.Path{a.rJar}, nil
1049 }
Anton Hansson092aca42020-08-13 19:37:22 +01001050 case ".export-package.apk":
1051 return []android.Path{a.exportPackage}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001052 }
1053 return a.Library.OutputFiles(tag)
1054}
1055
Jiyong Parkf7487312019-10-17 12:54:30 +09001056func (a *AndroidApp) Privileged() bool {
1057 return Bool(a.appProperties.Privileged)
1058}
1059
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001060func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001061 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001062}
1063
Ivan Lozanod7586b62021-04-01 09:49:36 -04001064func (a *AndroidApp) SetPreventInstall() {
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001065 a.appProperties.PreventInstall = true
1066}
1067
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001068func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
1069 a.appProperties.IsCoverageVariant = coverage
1070}
1071
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001072func (a *AndroidApp) EnableCoverageIfNeeded() {}
1073
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001074var _ cc.Coverage = (*AndroidApp)(nil)
1075
Colin Cross95b53b82023-10-17 13:21:02 -07001076func (a *AndroidApp) IDEInfo(dpInfo *android.IdeInfo) {
1077 a.Library.IDEInfo(dpInfo)
1078 a.aapt.IDEInfo(dpInfo)
1079}
1080
Colin Cross1b16b0e2019-02-12 14:41:32 -08001081// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -07001082func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -07001083 module := &AndroidApp{}
1084
Liz Kammera7a64f32020-07-09 15:16:41 -07001085 module.Module.dexProperties.Optimize.EnabledByDefault = true
1086 module.Module.dexProperties.Optimize.Shrink = proptools.BoolPtr(true)
Jared Dukeaa88b3d2023-08-29 17:07:20 +00001087 module.Module.dexProperties.Optimize.Proguard_compatibility = proptools.BoolPtr(false)
Colin Cross66dbc0b2017-12-28 12:23:20 -08001088
Colin Crossae5caf52018-05-22 11:11:52 -07001089 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001090 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001091 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001092
Colin Crossce6734e2020-06-15 16:09:53 -07001093 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -07001094 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -07001095 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001096 &module.appProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001097 &module.overridableAppProperties)
Colin Cross36242852017-06-23 15:06:31 -07001098
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001099 module.usesLibrary.enforce = true
1100
Colin Crossa4f08812018-10-02 22:03:40 -07001101 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1102 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001103 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001104 android.InitApexModule(module)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001105 android.InitBazelModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001106
Colin Cross36242852017-06-23 15:06:31 -07001107 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001108}
Colin Crossae5caf52018-05-22 11:11:52 -07001109
1110type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001111 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001112 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001113
Seth Moorec6f4b532023-02-02 13:22:26 -08001114 // If specified, the instrumentation target package name in the manifest is overwritten by it.
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001115 Instrumentation_target_package *string
Seth Moorec6f4b532023-02-02 13:22:26 -08001116
1117 // If specified, the mainline module package name in the test config is overwritten by it.
1118 Mainline_package_name *string
Colin Crossae5caf52018-05-22 11:11:52 -07001119}
1120
1121type AndroidTest struct {
1122 AndroidApp
1123
1124 appTestProperties appTestProperties
1125
1126 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001127
Dan Shi95d19422020-08-15 12:24:26 -07001128 testConfig android.Path
1129 extraTestConfigs android.Paths
1130 data android.Paths
Jingwen Chene12c0832023-08-25 09:00:16 +00001131
1132 android.BazelModuleBase
Colin Crossae5caf52018-05-22 11:11:52 -07001133}
1134
Jaewoong Jung0949f312019-09-11 10:25:18 -07001135func (a *AndroidTest) InstallInTestcases() bool {
1136 return true
1137}
1138
Spandan Das9f7ae7f2022-07-25 00:34:18 +00001139type androidTestApp interface {
1140 includedInTestSuite(searchPrefix string) bool
1141}
1142
1143func (a *AndroidTest) includedInTestSuite(searchPrefix string) bool {
1144 return android.PrefixInList(a.testProperties.Test_suites, searchPrefix)
1145}
1146
1147func (a *AndroidTestHelperApp) includedInTestSuite(searchPrefix string) bool {
1148 return android.PrefixInList(a.appTestHelperAppProperties.Test_suites, searchPrefix)
1149}
1150
Colin Crossae5caf52018-05-22 11:11:52 -07001151func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001152 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001153 if a.appTestProperties.Instrumentation_target_package != nil {
1154 a.additionalAaptFlags = append(a.additionalAaptFlags,
1155 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1156 } else if a.appTestProperties.Instrumentation_for != nil {
1157 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001158 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1159 if overridden {
1160 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1161 }
1162 }
Colin Crossae5caf52018-05-22 11:11:52 -07001163 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001164
easoncylee5bcff5d2020-04-30 14:57:06 +08001165 for _, module := range a.testProperties.Test_mainline_modules {
1166 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1167 }
1168
Jaewoong Jung39982342020-01-14 10:27:18 -08001169 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001170 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001171 a.testConfig = a.FixTestConfig(ctx, testConfig)
Dan Shi95d19422020-08-15 12:24:26 -07001172 a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
Colin Cross8a497952019-03-05 22:25:09 -08001173 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001174}
1175
Jaewoong Jung39982342020-01-14 10:27:18 -08001176func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1177 if testConfig == nil {
1178 return nil
1179 }
1180
1181 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
Colin Crossf1a035e2020-11-16 17:32:30 -08001182 rule := android.NewRuleBuilder(pctx, ctx)
1183 command := rule.Command().BuiltTool("test_config_fixer").Input(testConfig).Output(fixedConfig)
Jaewoong Jung39982342020-01-14 10:27:18 -08001184 fixNeeded := false
1185
Jooyung Han29e2f6d2022-01-08 12:13:59 +09001186 // 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 -08001187 if ctx.ModuleName() != a.installApkName {
1188 fixNeeded = true
1189 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1190 }
1191
1192 if a.overridableAppProperties.Package_name != nil {
1193 fixNeeded = true
1194 command.FlagWithInput("--manifest ", a.manifestPath).
1195 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1196 }
1197
Seth Moorec6f4b532023-02-02 13:22:26 -08001198 if a.appTestProperties.Mainline_package_name != nil {
1199 fixNeeded = true
1200 command.FlagWithArg("--mainline-package-name ", *a.appTestProperties.Mainline_package_name)
1201 }
1202
Jaewoong Jung39982342020-01-14 10:27:18 -08001203 if fixNeeded {
Colin Crossf1a035e2020-11-16 17:32:30 -08001204 rule.Build("fix_test_config", "fix test config")
Jaewoong Jung39982342020-01-14 10:27:18 -08001205 return fixedConfig
1206 }
1207 return testConfig
1208}
1209
Colin Cross303e21f2018-08-07 16:49:25 -07001210func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001211 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001212}
1213
1214func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1215 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001216 if a.appTestProperties.Instrumentation_for != nil {
1217 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1218 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1219 // use instrumentationForTag instead of libTag.
1220 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1221 }
Colin Crossae5caf52018-05-22 11:11:52 -07001222}
1223
Colin Cross1b16b0e2019-02-12 14:41:32 -08001224// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1225// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001226func AndroidTestFactory() android.Module {
1227 module := &AndroidTest{}
1228
Jared Duke63a3da92022-06-02 19:11:14 +00001229 module.Module.dexProperties.Optimize.EnabledByDefault = false
Colin Cross5067db92018-09-17 16:46:35 -07001230
1231 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001232 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001233 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001234 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001235 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001236 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001237 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001238
Colin Crossce6734e2020-06-15 16:09:53 -07001239 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001240 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001241 &module.aaptProperties,
1242 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001243 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001244 &module.overridableAppProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001245 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001246
Colin Crossa4f08812018-10-02 22:03:40 -07001247 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1248 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001249 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jingwen Chene12c0832023-08-25 09:00:16 +00001250
1251 android.InitBazelModule(module)
Colin Crossae5caf52018-05-22 11:11:52 -07001252 return module
1253}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001254
Colin Cross252fc6f2018-10-04 15:22:03 -07001255type appTestHelperAppProperties struct {
1256 // list of compatibility suites (for example "cts", "vts") that the module should be
1257 // installed into.
1258 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001259
1260 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1261 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1262 // explicitly.
1263 Auto_gen_config *bool
Colin Crosscfb0f5e2021-09-24 15:47:17 -07001264
1265 // Install the test into a folder named for the module in all test suites.
1266 Per_testcase_directory *bool
Colin Cross252fc6f2018-10-04 15:22:03 -07001267}
1268
1269type AndroidTestHelperApp struct {
1270 AndroidApp
1271
1272 appTestHelperAppProperties appTestHelperAppProperties
Jingwen Chen65289992023-09-21 15:15:47 +00001273
1274 android.BazelModuleBase
Colin Cross252fc6f2018-10-04 15:22:03 -07001275}
1276
Jaewoong Jung326a9412019-11-21 10:41:00 -08001277func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1278 return true
1279}
1280
Colin Cross1b16b0e2019-02-12 14:41:32 -08001281// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1282// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1283// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001284func AndroidTestHelperAppFactory() android.Module {
1285 module := &AndroidTestHelperApp{}
1286
Jared Duke63a3da92022-06-02 19:11:14 +00001287 // TODO(b/192032291): Disable by default after auditing downstream usage.
Liz Kammera7a64f32020-07-09 15:16:41 -07001288 module.Module.dexProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001289
1290 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001291 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001292 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001293 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001294 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross252fc6f2018-10-04 15:22:03 -07001295
Colin Crossce6734e2020-06-15 16:09:53 -07001296 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001297 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001298 &module.aaptProperties,
1299 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001300 &module.appTestHelperAppProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001301 &module.overridableAppProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001302
1303 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1304 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001305 android.InitApexModule(module)
Jingwen Chen65289992023-09-21 15:15:47 +00001306 android.InitBazelModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001307 return module
1308}
1309
Colin Crossbd01e2a2018-10-04 15:21:03 -07001310type AndroidAppCertificate struct {
1311 android.ModuleBase
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001312 android.BazelModuleBase
1313
Colin Crossbd01e2a2018-10-04 15:21:03 -07001314 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001315 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001316}
1317
1318type AndroidAppCertificateProperties struct {
1319 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1320 Certificate *string
1321}
1322
Colin Cross1b16b0e2019-02-12 14:41:32 -08001323// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1324// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001325func AndroidAppCertificateFactory() android.Module {
1326 module := &AndroidAppCertificate{}
1327 module.AddProperties(&module.properties)
1328 android.InitAndroidModule(module)
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001329 android.InitBazelModule(module)
Colin Crossbd01e2a2018-10-04 15:21:03 -07001330 return module
1331}
1332
Colin Crossbd01e2a2018-10-04 15:21:03 -07001333func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1334 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001335 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001336 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1337 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001338 }
1339}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001340
1341type OverrideAndroidApp struct {
1342 android.ModuleBase
1343 android.OverrideModuleBase
1344}
1345
Sasha Smundak613cbb12020-06-05 10:27:23 -07001346func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001347 // All the overrides happen in the base module.
1348 // TODO(jungjw): Check the base module type.
1349}
1350
1351// override_android_app is used to create an android_app module based on another android_app by overriding
1352// some of its properties.
1353func OverrideAndroidAppModuleFactory() android.Module {
1354 m := &OverrideAndroidApp{}
Jooyung Han01d80d82022-01-08 12:16:32 +09001355 m.AddProperties(
1356 &OverridableDeviceProperties{},
1357 &overridableAppProperties{},
1358 )
Jaewoong Jung525443a2019-02-28 15:35:54 -08001359
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001360 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001361 android.InitOverrideModule(m)
1362 return m
1363}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001364
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001365type OverrideAndroidTest struct {
1366 android.ModuleBase
1367 android.OverrideModuleBase
1368}
1369
Sasha Smundak613cbb12020-06-05 10:27:23 -07001370func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001371 // All the overrides happen in the base module.
1372 // TODO(jungjw): Check the base module type.
1373}
1374
1375// override_android_test is used to create an android_app module based on another android_test by overriding
1376// some of its properties.
1377func OverrideAndroidTestModuleFactory() android.Module {
1378 m := &OverrideAndroidTest{}
1379 m.AddProperties(&overridableAppProperties{})
1380 m.AddProperties(&appTestProperties{})
1381
1382 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1383 android.InitOverrideModule(m)
1384 return m
1385}
1386
Colin Cross50ddcc42019-05-16 12:28:22 -07001387type UsesLibraryProperties struct {
1388 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1389 Uses_libs []string
1390
1391 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1392 // required=false.
1393 Optional_uses_libs []string
1394
1395 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1396 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1397 Enforce_uses_libs *bool
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001398
Ulya Trafimovich54027b52020-09-09 14:08:23 +01001399 // Optional name of the <uses-library> provided by this module. This is needed for non-SDK
1400 // libraries, because SDK ones are automatically picked up by Soong. The <uses-library> name
1401 // normally is the same as the module name, but there are exceptions.
1402 Provides_uses_lib *string
Paul Duffin06530572022-02-03 17:54:15 +00001403
1404 // A list of shared library names to exclude from the classpath of the APK. Adding a library here
1405 // will prevent it from being used when precompiling the APK and prevent it from being implicitly
1406 // added to the APK's manifest's <uses-library> elements.
1407 //
1408 // Care must be taken when using this as it could result in runtime errors if the APK actually
1409 // uses classes provided by the library and which are not provided in any other way.
1410 //
1411 // This is primarily intended for use by various CTS tests that check the runtime handling of the
1412 // android.test.base shared library (and related libraries) but which depend on some common
1413 // libraries that depend on the android.test.base library. Without this those tests will end up
1414 // with a <uses-library android:name="android.test.base"/> in their manifest which would either
1415 // render the tests worthless (as they would be testing the wrong behavior), or would break the
1416 // test altogether by providing access to classes that the tests were not expecting. Those tests
1417 // provide the android.test.base statically and use jarjar to rename them so they do not collide
1418 // with the classes provided by the android.test.base library.
1419 Exclude_uses_libs []string
Colin Cross50ddcc42019-05-16 12:28:22 -07001420}
1421
1422// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1423// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1424// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1425// with knowledge of their shared libraries.
1426type usesLibrary struct {
1427 usesLibraryProperties UsesLibraryProperties
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001428
1429 // Whether to enforce verify_uses_library check.
1430 enforce bool
Colin Cross50ddcc42019-05-16 12:28:22 -07001431}
1432
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001433func (u *usesLibrary) addLib(lib string, optional bool) {
1434 if !android.InList(lib, u.usesLibraryProperties.Uses_libs) && !android.InList(lib, u.usesLibraryProperties.Optional_uses_libs) {
1435 if optional {
1436 u.usesLibraryProperties.Optional_uses_libs = append(u.usesLibraryProperties.Optional_uses_libs, lib)
1437 } else {
1438 u.usesLibraryProperties.Uses_libs = append(u.usesLibraryProperties.Uses_libs, lib)
1439 }
1440 }
1441}
1442
Colin Cross4a80a152022-12-21 21:51:52 -08001443func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, addCompatDeps bool) {
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001444 if !ctx.Config().UnbundledBuild() || ctx.Config().UnbundledBuildImage() {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001445 ctx.AddVariationDependencies(nil, usesLibReqTag, u.usesLibraryProperties.Uses_libs...)
1446 ctx.AddVariationDependencies(nil, usesLibOptTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross4a80a152022-12-21 21:51:52 -08001447 // Only add these extra dependencies if the module is an app that depends on framework
1448 // libs. This avoids creating a cyclic dependency:
Paul Duffin250e6192019-06-07 10:44:37 +01001449 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
Colin Cross4a80a152022-12-21 21:51:52 -08001450 if addCompatDeps {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001451 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1452 // class loader context for dex2oat. Add them as a dependency with a special tag.
1453 ctx.AddVariationDependencies(nil, usesLibCompat29ReqTag, dexpreopt.CompatUsesLibs29...)
1454 ctx.AddVariationDependencies(nil, usesLibCompat28OptTag, dexpreopt.OptionalCompatUsesLibs28...)
1455 ctx.AddVariationDependencies(nil, usesLibCompat30OptTag, dexpreopt.OptionalCompatUsesLibs30...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001456 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001457 } else {
1458 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.usesLibraryProperties.Uses_libs...)
1459 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross50ddcc42019-05-16 12:28:22 -07001460 }
1461}
1462
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001463// presentOptionalUsesLibs returns optional_uses_libs after filtering out libraries that don't exist in the source tree.
Colin Cross50ddcc42019-05-16 12:28:22 -07001464func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001465 optionalUsesLibs := android.FilterListPred(u.usesLibraryProperties.Optional_uses_libs, func(s string) bool {
1466 exists := ctx.OtherModuleExists(s)
Jiakai Zhang48203e32023-06-02 23:42:21 +01001467 if !exists && !android.InList(ctx.ModuleName(), ctx.Config().BuildWarningBadOptionalUsesLibsAllowlist()) {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001468 fmt.Printf("Warning: Module '%s' depends on non-existing optional_uses_libs '%s'\n", ctx.ModuleName(), s)
1469 }
1470 return exists
1471 })
Colin Cross50ddcc42019-05-16 12:28:22 -07001472 return optionalUsesLibs
1473}
1474
Ulya Trafimovicheea486a2021-02-26 11:38:21 +00001475// Helper function to replace string in a list.
1476func replaceInList(list []string, oldstr, newstr string) {
1477 for i, str := range list {
1478 if str == oldstr {
1479 list[i] = newstr
1480 }
1481 }
1482}
1483
Ulya Trafimovich24446712021-07-15 14:59:34 +01001484// Returns a map of module names of shared library dependencies to the paths to their dex jars on
1485// host and on device.
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001486func (u *usesLibrary) classLoaderContextForUsesLibDeps(ctx android.ModuleContext) dexpreopt.ClassLoaderContextMap {
1487 clcMap := make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich24446712021-07-15 14:59:34 +01001488
1489 // Skip when UnbundledBuild() is true, but UnbundledBuildImage() is false. With
1490 // UnbundledBuildImage() it is necessary to generate dexpreopt.config for post-dexpreopting.
1491 if ctx.Config().UnbundledBuild() && !ctx.Config().UnbundledBuildImage() {
1492 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001493 }
1494
Ulya Trafimovich24446712021-07-15 14:59:34 +01001495 ctx.VisitDirectDeps(func(m android.Module) {
1496 tag, isUsesLibTag := ctx.OtherModuleDependencyTag(m).(usesLibraryDependencyTag)
1497 if !isUsesLibTag {
1498 return
1499 }
1500
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001501 dep := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(m))
Ulya Trafimovich24446712021-07-15 14:59:34 +01001502
Ulya Trafimovich840efb62021-07-15 14:34:40 +01001503 // Skip stub libraries. A dependency on the implementation library has been added earlier,
1504 // so it will be added to CLC, but the stub shouldn't be. Stub libraries can be distingushed
1505 // from implementation libraries by their name, which is different as it has a suffix.
1506 if comp, ok := m.(SdkLibraryComponentDependency); ok {
1507 if impl := comp.OptionalSdkLibraryImplementation(); impl != nil && *impl != dep {
1508 return
1509 }
1510 }
1511
Ulya Trafimovich24446712021-07-15 14:59:34 +01001512 if lib, ok := m.(UsesLibraryDependency); ok {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001513 libName := dep
Ulya Trafimovich24446712021-07-15 14:59:34 +01001514 if ulib, ok := m.(ProvidesUsesLib); ok && ulib.ProvidesUsesLib() != nil {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001515 libName = *ulib.ProvidesUsesLib()
Ulya Trafimovich24446712021-07-15 14:59:34 +01001516 // Replace module name with library name in `uses_libs`/`optional_uses_libs` in
1517 // order to pass verify_uses_libraries check (which compares these properties
1518 // against library names written in the manifest).
1519 replaceInList(u.usesLibraryProperties.Uses_libs, dep, libName)
1520 replaceInList(u.usesLibraryProperties.Optional_uses_libs, dep, libName)
1521 }
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001522 clcMap.AddContext(ctx, tag.sdkVersion, libName, tag.optional,
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001523 lib.DexJarBuildPath().PathOrNil(), lib.DexJarInstallPath(),
1524 lib.ClassLoaderContexts())
Ulya Trafimovich24446712021-07-15 14:59:34 +01001525 } else if ctx.Config().AllowMissingDependencies() {
1526 ctx.AddMissingDependencies([]string{dep})
1527 } else {
1528 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", dep)
1529 }
1530 })
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001531 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001532}
1533
1534// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1535// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1536// unconditionally in the future.
1537func (u *usesLibrary) enforceUsesLibraries() bool {
1538 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1539 len(u.usesLibraryProperties.Optional_uses_libs) > 0
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001540 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, u.enforce || defaultEnforceUsesLibs)
Colin Cross50ddcc42019-05-16 12:28:22 -07001541}
1542
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001543// Freeze the value of `enforce_uses_libs` based on the current values of `uses_libs` and `optional_uses_libs`.
1544func (u *usesLibrary) freezeEnforceUsesLibraries() {
1545 enforce := u.enforceUsesLibraries()
1546 u.usesLibraryProperties.Enforce_uses_libs = &enforce
1547}
1548
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001549// verifyUsesLibraries checks the <uses-library> tags in the manifest against the ones specified
1550// in the `uses_libs`/`optional_uses_libs` properties. The input can be either an XML manifest, or
1551// an APK with the manifest embedded in it (manifest_check will know which one it is by the file
1552// extension: APKs are supposed to end with '.apk').
1553func (u *usesLibrary) verifyUsesLibraries(ctx android.ModuleContext, inputFile android.Path,
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001554 outputFile android.WritablePath) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001555
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001556 statusFile := dexpreopt.UsesLibrariesStatusFile(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001557
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001558 // Disable verify_uses_libraries check if dexpreopt is globally disabled. Without dexpreopt the
1559 // check is not necessary, and although it is good to have, it is difficult to maintain on
1560 // non-linux build platforms where dexpreopt is generally disabled (the check may fail due to
1561 // various unrelated reasons, such as a failure to get manifest from an APK).
Ulya Trafimovich39dd0a42021-03-29 14:57:34 +01001562 global := dexpreopt.GetGlobalConfig(ctx)
1563 if global.DisablePreopt || global.OnlyPreoptBootImageAndSystemServer {
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001564 return inputFile
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001565 }
1566
Colin Crossf1a035e2020-11-16 17:32:30 -08001567 rule := android.NewRuleBuilder(pctx, ctx)
1568 cmd := rule.Command().BuiltTool("manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001569 Flag("--enforce-uses-libraries").
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001570 Input(inputFile).
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001571 FlagWithOutput("--enforce-uses-libraries-status ", statusFile).
Saeid Farivar Asanjanfd27c7c2022-08-08 20:21:26 +00001572 FlagWithInput("--aapt ", ctx.Config().HostToolPath(ctx, "aapt2"))
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001573
1574 if outputFile != nil {
1575 cmd.FlagWithOutput("-o ", outputFile)
1576 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001577
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001578 if dexpreopt.GetGlobalConfig(ctx).RelaxUsesLibraryCheck {
1579 cmd.Flag("--enforce-uses-libraries-relax")
1580 }
1581
Colin Cross50ddcc42019-05-16 12:28:22 -07001582 for _, lib := range u.usesLibraryProperties.Uses_libs {
1583 cmd.FlagWithArg("--uses-library ", lib)
1584 }
1585
1586 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1587 cmd.FlagWithArg("--optional-uses-library ", lib)
1588 }
1589
Colin Crossf1a035e2020-11-16 17:32:30 -08001590 rule.Build("verify_uses_libraries", "verify <uses-library>")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001591 return outputFile
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001592}
Colin Cross50ddcc42019-05-16 12:28:22 -07001593
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001594// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against
1595// the build system and returns the path to a copy of the manifest.
1596func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1597 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001598 return u.verifyUsesLibraries(ctx, manifest, outputFile)
Colin Cross50ddcc42019-05-16 12:28:22 -07001599}
1600
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001601// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the build
1602// system and returns the path to a copy of the APK.
Cole Faust2f1da162023-04-17 15:06:56 -07001603func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001604 u.verifyUsesLibraries(ctx, apk, nil) // for APKs manifest_check does not write output file
Colin Cross50ddcc42019-05-16 12:28:22 -07001605}
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001606
1607// For Bazel / bp2build
1608
1609type bazelAndroidAppCertificateAttributes struct {
1610 Certificate string
1611}
1612
Chris Parsons637458d2023-09-19 20:09:00 +00001613func (m *AndroidAppCertificate) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001614 androidAppCertificateBp2Build(ctx, m)
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001615}
1616
Chris Parsons637458d2023-09-19 20:09:00 +00001617func androidAppCertificateBp2Build(ctx android.Bp2buildMutatorContext, module *AndroidAppCertificate) {
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001618 var certificate string
1619 if module.properties.Certificate != nil {
1620 certificate = *module.properties.Certificate
1621 }
1622
1623 attrs := &bazelAndroidAppCertificateAttributes{
1624 Certificate: certificate,
1625 }
1626
1627 props := bazel.BazelTargetModuleProperties{
1628 Rule_class: "android_app_certificate",
Alixa381cd12023-05-10 14:49:38 +00001629 Bzl_load_location: "//build/bazel/rules/android:android_app_certificate.bzl",
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001630 }
1631
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +00001632 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name()}, attrs)
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001633}
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001634
Alixe5085eb2023-01-31 19:38:41 +00001635type manifestValueAttribute struct {
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001636 MinSdkVersion *string
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001637 TargetSdkVersion *string
Alixe5085eb2023-01-31 19:38:41 +00001638}
1639
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001640type bazelAndroidAppAttributes struct {
Sam Delmericoc0161432022-02-25 21:34:51 +00001641 *javaCommonAttributes
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001642 *bazelAapt
Sam Delmericoc0161432022-02-25 21:34:51 +00001643 Deps bazel.LabelListAttribute
Sam Delmerico9dfb1392022-02-10 21:11:59 +00001644 Custom_package *string
Jingwen Chen6817bbb2022-10-14 09:56:07 +00001645 Certificate bazel.LabelAttribute
1646 Certificate_name bazel.StringAttribute
Alixe5085eb2023-01-31 19:38:41 +00001647 Manifest_values *manifestValueAttribute
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001648 Optimize *bool
1649 Proguard_specs bazel.LabelListAttribute
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001650 Updatable *bool
Jingwen Chenbea58092022-09-29 16:56:02 +00001651}
1652
Alixee51bd62023-08-29 16:01:46 +00001653func (b bazelAapt) ConvertJavaResources(ctx android.Bp2buildMutatorContext, javaAttrs *javaCommonAttributes) bool {
1654 // TODO (b/300470246) bp2build support for java_resources & java_resource_dirs in android rules
1655 hasJavaResources := !javaAttrs.javaResourcesAttributes.Resources.IsEmpty()
1656 if hasJavaResources {
1657 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED, "(b/300470246) java resources in android_* module")
1658 }
1659 return hasJavaResources
1660}
1661
Chris Parsons637458d2023-09-19 20:09:00 +00001662func convertWithBp2build(ctx android.Bp2buildMutatorContext, a *AndroidApp) (bool, android.CommonAttributes, *bazelAndroidAppAttributes) {
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001663 aapt, supported := a.convertAaptAttrsWithBp2Build(ctx)
1664 if !supported {
Jingwen Chene12c0832023-08-25 09:00:16 +00001665 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001666 }
Spandan Das0e0a8802023-09-20 19:53:30 +00001667 if a.appProperties.Jni_uses_platform_apis != nil {
1668 ctx.MarkBp2buildUnconvertible(
1669 bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED,
1670 "TODO - b/299360988: Add bp2build support for jni_uses_platform_apis",
1671 )
1672 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1673 }
1674 if a.appProperties.Jni_uses_sdk_apis != nil {
1675 ctx.MarkBp2buildUnconvertible(
1676 bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED,
1677 "TODO - b/299360988: Add bp2build support for jni_uses_sdk_apis",
1678 )
1679 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1680 }
1681
Jingwen Chen6817bbb2022-10-14 09:56:07 +00001682 certificate, certificateName := android.BazelStringOrLabelFromProp(ctx, a.overridableAppProperties.Certificate)
1683
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001684 manifestValues := &manifestValueAttribute{
1685 MinSdkVersion: a.deviceProperties.Min_sdk_version,
1686 TargetSdkVersion: a.deviceProperties.Target_sdk_version,
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001687 }
1688
Alix0856f9e2023-01-20 22:15:30 +00001689 appAttrs := &bazelAndroidAppAttributes{
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001690 // TODO(b/209576404): handle package name override by product variable PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
Alix0856f9e2023-01-20 22:15:30 +00001691 Custom_package: a.overridableAppProperties.Package_name,
1692 Certificate: certificate,
1693 Certificate_name: certificateName,
Alixe5085eb2023-01-31 19:38:41 +00001694 Manifest_values: manifestValues,
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001695 Updatable: a.appProperties.Updatable,
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001696 }
Sam Delmerico9dfb1392022-02-10 21:11:59 +00001697
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001698 // As framework-res has no sources, no deps in the Bazel sense, and java compilation, dexing and optimization is skipped by
1699 // Soong specifically for it, return early here before any of the conversion work for the above is attempted.
1700 if ctx.ModuleName() == "framework-res" {
1701 appAttrs.bazelAapt = aapt
1702 return true, android.CommonAttributes{Name: a.Name(), SkipData: proptools.BoolPtr(true)}, appAttrs
1703 }
1704
Jingwen Chen65229202023-09-20 13:34:16 +00001705 // Optimization is..
1706 // - enabled by default for android_app, android_test_helper_app
1707 // - disabled by default for android_test
1708 //
1709 // TODO(b/192032291): Disable android_test_helper_app optimization by
1710 // default after auditing downstream usage.
Jingwen Chen256c3892023-09-26 05:51:40 +00001711 if a.dexProperties.Optimize.EnabledByDefault != a.dexer.effectiveOptimizeEnabled() {
1712 // Property is explicitly defined by default from default, so emit the Bazel attribute.
1713 appAttrs.Optimize = proptools.BoolPtr(a.dexer.effectiveOptimizeEnabled())
Jingwen Chen65229202023-09-20 13:34:16 +00001714 }
Jingwen Chen65229202023-09-20 13:34:16 +00001715
Jingwen Chen256c3892023-09-26 05:51:40 +00001716 if a.dexer.effectiveOptimizeEnabled() {
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001717 handCraftedFlags := ""
1718 if Bool(a.dexProperties.Optimize.Ignore_warnings) {
1719 handCraftedFlags += "-ignorewarning "
1720 }
1721 if !Bool(a.dexProperties.Optimize.Shrink) {
1722 handCraftedFlags += "-dontshrink "
1723 }
1724 if !Bool(a.dexProperties.Optimize.Optimize) {
1725 handCraftedFlags += "-dontoptimize "
1726 }
1727 if !Bool(a.dexProperties.Optimize.Obfuscate) {
1728 handCraftedFlags += "-dontobfuscate "
1729 }
1730 appAttrs.Proguard_specs = bazel.MakeLabelListAttribute(android.BazelLabelForModuleSrc(ctx, a.dexProperties.Optimize.Proguard_flags_files))
1731 if handCraftedFlags != "" {
1732 generatedFlagFileRuleName := a.Name() + "_proguard_flags"
1733 ctx.CreateBazelTargetModule(bazel.BazelTargetModuleProperties{
1734 Rule_class: "genrule",
1735 }, android.CommonAttributes{
1736 Name: generatedFlagFileRuleName,
1737 SkipData: proptools.BoolPtr(true),
1738 }, &genrule.BazelGenruleAttributes{
1739 Outs: []string{a.Name() + "_proguard.flags"},
1740 Cmd: bazel.StringAttribute{
1741 Value: proptools.StringPtr("echo " + handCraftedFlags + "> $(OUTS)"),
1742 },
1743 })
1744 appAttrs.Proguard_specs.Add(bazel.MakeLabelAttribute(":" + generatedFlagFileRuleName))
1745 }
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001746 }
1747
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001748 commonAttrs, bp2BuildInfo, supported := a.convertLibraryAttrsBp2Build(ctx)
1749 if !supported {
Jingwen Chene12c0832023-08-25 09:00:16 +00001750 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001751 }
Alixee51bd62023-08-29 16:01:46 +00001752 if hasJavaResources := aapt.ConvertJavaResources(ctx, commonAttrs); hasJavaResources {
1753 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1754 }
1755
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001756 depLabels := bp2BuildInfo.DepLabels
1757
1758 deps := depLabels.Deps
1759 deps.Append(depLabels.StaticDeps)
1760
Romain Jobredeaux947dfa72023-06-12 15:40:35 -04001761 var jniDeps bazel.LabelListAttribute
1762 archVariantProps := a.GetArchVariantProperties(ctx, &appProperties{})
1763 for axis, configToProps := range archVariantProps {
1764 for config, _props := range configToProps {
1765 if archProps, ok := _props.(*appProperties); ok {
1766 archJniLibs := android.BazelLabelForModuleDeps(
1767 ctx,
1768 android.LastUniqueStrings(android.CopyOf(archProps.Jni_libs)))
1769 jniDeps.SetSelectValue(axis, config, archJniLibs)
1770 }
1771 }
1772 }
1773 deps.Append(jniDeps)
1774
Alix75db7842023-03-06 22:08:49 +00001775 if !bp2BuildInfo.hasKotlin {
Alix0856f9e2023-01-20 22:15:30 +00001776 appAttrs.javaCommonAttributes = commonAttrs
1777 appAttrs.bazelAapt = aapt
1778 appAttrs.Deps = deps
Alix0856f9e2023-01-20 22:15:30 +00001779 } else {
1780 ktName := a.Name() + "_kt"
Alix0856f9e2023-01-20 22:15:30 +00001781 ctx.CreateBazelTargetModule(
Alix32540022023-03-16 21:06:13 +00001782 AndroidLibraryBazelTargetModuleProperties(),
Alix0856f9e2023-01-20 22:15:30 +00001783 android.CommonAttributes{Name: ktName},
1784 &bazelAndroidLibrary{
1785 javaLibraryAttributes: &javaLibraryAttributes{
1786 javaCommonAttributes: commonAttrs,
1787 Deps: deps,
1788 },
1789 bazelAapt: aapt,
1790 },
1791 )
1792
1793 appAttrs.bazelAapt = &bazelAapt{Manifest: aapt.Manifest}
1794 appAttrs.Deps = bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + ktName})
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001795 appAttrs.javaCommonAttributes = &javaCommonAttributes{
1796 Sdk_version: commonAttrs.Sdk_version,
1797 }
Alix0856f9e2023-01-20 22:15:30 +00001798 }
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001799
Jingwen Chene12c0832023-08-25 09:00:16 +00001800 return true, android.CommonAttributes{Name: a.Name(), SkipData: proptools.BoolPtr(true)}, appAttrs
1801}
1802
1803// ConvertWithBp2build is used to convert android_app to Bazel.
Chris Parsons637458d2023-09-19 20:09:00 +00001804func (a *AndroidApp) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jingwen Chene12c0832023-08-25 09:00:16 +00001805 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, a); ok {
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001806 var props bazel.BazelTargetModuleProperties
1807 if ctx.ModuleName() == "framework-res" {
1808 props = bazel.BazelTargetModuleProperties{
1809 Rule_class: "framework_resources",
1810 Bzl_load_location: "//build/bazel/rules/android:framework_resources.bzl",
1811 }
1812 } else {
1813 props = bazel.BazelTargetModuleProperties{
1814 Rule_class: "android_binary",
1815 Bzl_load_location: "//build/bazel/rules/android:android_binary.bzl",
1816 }
Jingwen Chene12c0832023-08-25 09:00:16 +00001817 }
Jingwen Chene12c0832023-08-25 09:00:16 +00001818 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1819 }
1820
1821}
1822
1823// ConvertWithBp2build is used to convert android_test to Bazel.
Chris Parsons637458d2023-09-19 20:09:00 +00001824func (at *AndroidTest) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jingwen Chene12c0832023-08-25 09:00:16 +00001825 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, &at.AndroidApp); ok {
1826 props := bazel.BazelTargetModuleProperties{
1827 Rule_class: "android_test",
1828 Bzl_load_location: "//build/bazel/rules/android:android_test.bzl",
1829 }
1830
1831 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1832 }
Alix733110e2023-02-06 14:53:10 +00001833
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001834}
Jingwen Chen65289992023-09-21 15:15:47 +00001835
1836func (atha *AndroidTestHelperApp) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
1837 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, &atha.AndroidApp); ok {
1838 // an android_test_helper_app is an android_binary with testonly = True
1839 commonAttrs.Testonly = proptools.BoolPtr(true)
1840
Jingwen Chen65229202023-09-20 13:34:16 +00001841 // android_test_helper_app sets default values differently to android_app,
Jingwen Chen65289992023-09-21 15:15:47 +00001842 // https://cs.android.com/android/platform/superproject/main/+/main:build/soong/java/app.go;l=1273-1279;drc=e12c083198403ec694af6c625aed11327eb2bf7f
1843 //
1844 // installable: true (settable prop)
1845 // use_embedded_native_libs: true (settable prop)
1846 // lint.test: true (settable prop)
Jingwen Chen65289992023-09-21 15:15:47 +00001847 // AlwaysPackageNativeLibs: true (blueprint mutated prop)
1848 // dexpreopt isTest: true (not prop)
1849
1850 props := bazel.BazelTargetModuleProperties{
1851 Rule_class: "android_binary",
1852 Bzl_load_location: "//build/bazel/rules/android:android_binary.bzl",
1853 }
1854
1855 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1856 }
1857}