blob: 6350a19245b050f102a7c71f2d8b133aad6a4d8f [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) {
Alix96ea88452023-08-31 15:48:23 +0000311 applicationId := a.appTestHelperAppProperties.Manifest_values.ApplicationId
312 if applicationId != nil {
313 if a.overridableAppProperties.Package_name != nil {
314 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
315 }
316 a.aapt.manifestValues.applicationId = *applicationId
317 }
Jeongik Cha538c0d02019-07-11 15:54:27 +0900318 a.generateAndroidBuildActions(ctx)
319}
320
Colin Cross46c9b8b2017-06-22 16:51:17 -0700321func (a *AndroidApp) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100322 a.checkAppSdkVersions(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700323 a.generateAndroidBuildActions(ctx)
Matt Banda8c801262022-04-01 17:48:31 +0000324 a.generateJavaUsedByApex(ctx)
Colin Crossae5caf52018-05-22 11:11:52 -0700325}
326
Sam Delmerico0e0d96e2023-08-18 22:43:28 +0000327func (a *AndroidApp) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
328 defaultMinSdkVersion := a.Module.MinSdkVersion(ctx)
329 if proptools.Bool(a.appProperties.Updatable) {
330 overrideApiLevel := android.MinSdkVersionFromValue(ctx, ctx.DeviceConfig().ApexGlobalMinSdkVersionOverride())
331 if !overrideApiLevel.IsNone() && overrideApiLevel.CompareTo(defaultMinSdkVersion) > 0 {
332 return overrideApiLevel
333 }
334 }
335 return defaultMinSdkVersion
336}
337
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100338func (a *AndroidApp) checkAppSdkVersions(ctx android.ModuleContext) {
Artur Satayev849f8442020-04-28 14:57:42 +0100339 if a.Updatable() {
Jiyong Park92315372021-04-02 08:45:46 +0900340 if !a.SdkVersion(ctx).Stable() {
341 ctx.PropertyErrorf("sdk_version", "Updatable apps must use stable SDKs, found %v", a.SdkVersion(ctx))
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100342 }
Artur Satayevf40fc852020-04-16 13:43:02 +0100343 if String(a.deviceProperties.Min_sdk_version) == "" {
344 ctx.PropertyErrorf("updatable", "updatable apps must set min_sdk_version.")
345 }
Jooyung Han749dc692020-04-15 11:03:39 +0900346
Jiyong Park92315372021-04-02 08:45:46 +0900347 if minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx); err == nil {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900348 a.checkJniLibsSdkVersion(ctx, minSdkVersion)
satayevb3fd4112021-12-02 13:59:35 +0000349 android.CheckMinSdkVersion(ctx, minSdkVersion, a.WalkPayloadDeps)
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900350 } else {
351 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
352 }
Harshit Mahajan5b8b7302022-06-10 11:24:05 +0000353
354 if !BoolDefault(a.appProperties.Enforce_default_target_sdk_version, true) {
355 ctx.PropertyErrorf("enforce_default_target_sdk_version", "Updatable apps must enforce default target sdk version")
356 }
357 // TODO(b/227460469) after all the modules removes the target sdk version, throw an error if the target sdk version is explicitly set.
358 if a.deviceProperties.Target_sdk_version == nil {
359 a.SetEnforceDefaultTargetSdkVersion(true)
360 }
361 }
362
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100363 a.checkPlatformAPI(ctx)
364 a.checkSdkVersions(ctx)
365}
366
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900367// If an updatable APK sets min_sdk_version, min_sdk_vesion of JNI libs should match with it.
368// This check is enforced for "updatable" APKs (including APK-in-APEX).
Jiyong Park54105c42021-03-31 18:17:53 +0900369func (a *AndroidApp) checkJniLibsSdkVersion(ctx android.ModuleContext, minSdkVersion android.ApiLevel) {
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900370 // It's enough to check direct JNI deps' sdk_version because all transitive deps from JNI deps are checked in cc.checkLinkType()
371 ctx.VisitDirectDeps(func(m android.Module) {
372 if !IsJniDepTag(ctx.OtherModuleDependencyTag(m)) {
373 return
374 }
375 dep, _ := m.(*cc.Module)
Jooyung Han652d5b32020-05-20 17:12:13 +0900376 // The domain of cc.sdk_version is "current" and <number>
Jiyong Parkf1691d22021-03-29 20:11:58 +0900377 // We can rely on android.SdkSpec to convert it to <number> so that "current" is
378 // handled properly regardless of sdk finalization.
Spandan Das2e8c0442022-05-08 00:39:35 +0000379 jniSdkVersion, err := android.SdkSpecFrom(ctx, dep.MinSdkVersion()).EffectiveVersion(ctx)
Jiyong Park54105c42021-03-31 18:17:53 +0900380 if err != nil || minSdkVersion.LessThan(jniSdkVersion) {
Spandan Das2e8c0442022-05-08 00:39:35 +0000381 ctx.OtherModuleErrorf(dep, "min_sdk_version(%v) is higher than min_sdk_version(%v) of the containing android_app(%v)",
382 dep.MinSdkVersion(), minSdkVersion, ctx.ModuleName())
Jooyung Hanbbc3fb72020-04-29 14:01:06 +0900383 return
384 }
385
386 })
387}
388
Sasha Smundak6ad77252019-05-01 13:16:22 -0700389// Returns true if the native libraries should be stored in the APK uncompressed and the
Colin Crosse4246ab2019-02-05 21:55:21 -0800390// extractNativeLibs application flag should be set to false in the manifest.
Sasha Smundak6ad77252019-05-01 13:16:22 -0700391func (a *AndroidApp) useEmbeddedNativeLibs(ctx android.ModuleContext) bool {
Jiyong Park92315372021-04-02 08:45:46 +0900392 minSdkVersion, err := a.MinSdkVersion(ctx).EffectiveVersion(ctx)
Colin Crosse4246ab2019-02-05 21:55:21 -0800393 if err != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900394 ctx.PropertyErrorf("min_sdk_version", "invalid value %q: %s", a.MinSdkVersion(ctx), err)
Colin Crosse4246ab2019-02-05 21:55:21 -0800395 }
396
Colin Cross56a83212020-09-15 18:30:11 -0700397 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Jiyong Park54105c42021-03-31 18:17:53 +0900398 return (minSdkVersion.FinalOrFutureInt() >= 23 && Bool(a.appProperties.Use_embedded_native_libs)) ||
Colin Cross56a83212020-09-15 18:30:11 -0700399 !apexInfo.IsForPlatform()
Colin Crosse4246ab2019-02-05 21:55:21 -0800400}
401
Colin Cross43f08db2018-11-12 10:13:39 -0800402// Returns whether this module should have the dex file stored uncompressed in the APK.
403func (a *AndroidApp) shouldUncompressDex(ctx android.ModuleContext) bool {
Colin Cross46abdad2019-02-07 13:07:08 -0800404 if Bool(a.appProperties.Use_embedded_dex) {
405 return true
406 }
407
Colin Cross53a87f52019-06-25 13:35:30 -0700408 // Uncompress dex in APKs of privileged apps (even for unbundled builds, they may
409 // be preinstalled as prebuilts).
Jiyong Parkf7487312019-10-17 12:54:30 +0900410 if ctx.Config().UncompressPrivAppDex() && a.Privileged() {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000411 return true
412 }
413
Colin Cross53a87f52019-06-25 13:35:30 -0700414 if ctx.Config().UnbundledBuild() {
415 return false
416 }
417
Jaewoong Jungacf18d72019-05-02 14:55:29 -0700418 return shouldUncompressDex(ctx, &a.dexpreopter)
Colin Cross5a0dcd52018-10-05 14:20:06 -0700419}
420
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700421func (a *AndroidApp) shouldEmbedJnis(ctx android.BaseModuleContext) bool {
Colin Cross56a83212020-09-15 18:30:11 -0700422 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700423 return ctx.Config().UnbundledBuild() || Bool(a.appProperties.Use_embedded_native_libs) ||
Colin Cross56a83212020-09-15 18:30:11 -0700424 !apexInfo.IsForPlatform() || a.appProperties.AlwaysPackageNativeLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700425}
426
Liz Kammer9f9fd022020-06-18 19:44:06 +0000427func generateAaptRenamePackageFlags(packageName string, renameResourcesPackage bool) []string {
428 aaptFlags := []string{"--rename-manifest-package " + packageName}
429 if renameResourcesPackage {
430 // Required to rename the package name in the resources table.
431 aaptFlags = append(aaptFlags, "--rename-resources-package "+packageName)
432 }
433 return aaptFlags
434}
435
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900436func (a *AndroidApp) OverriddenManifestPackageName() string {
437 return a.overriddenManifestPackageName
438}
439
Liz Kammer9f9fd022020-06-18 19:44:06 +0000440func (a *AndroidApp) renameResourcesPackage() bool {
441 return proptools.BoolDefault(a.overridableAppProperties.Rename_resources_package, true)
442}
443
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800444func (a *AndroidApp) aaptBuildActions(ctx android.ModuleContext) {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900445 usePlatformAPI := proptools.Bool(a.Module.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900446 if ctx.Module().(android.SdkContext).SdkVersion(ctx).Kind == android.SdkModule {
Lorenzo Colittifa9b3f32021-03-30 10:38:26 +0900447 usePlatformAPI = true
448 }
449 a.aapt.usesNonSdkApis = usePlatformAPI
David Brazdild25060a2019-02-18 18:24:16 +0000450
Jaewoong Jungc27ab662019-05-30 15:51:14 -0700451 // Ask manifest_fixer to add or update the application element indicating this app has no code.
452 a.aapt.hasNoCode = !a.hasCode(ctx)
453
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800454 aaptLinkFlags := []string{}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800455
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800456 // 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 -0800457 hasProduct := android.PrefixInList(a.aaptProperties.Aaptflags, "--product")
Colin Crosse78dcd32018-04-19 15:25:19 -0700458 if !hasProduct && len(ctx.Config().ProductAAPTCharacteristics()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800459 aaptLinkFlags = append(aaptLinkFlags, "--product", ctx.Config().ProductAAPTCharacteristics())
Colin Crosse78dcd32018-04-19 15:25:19 -0700460 }
461
Dan Willemsen72be5902018-10-24 20:24:57 -0700462 if !Bool(a.aaptProperties.Aapt_include_all_resources) {
463 // Product AAPT config
464 for _, aaptConfig := range ctx.Config().ProductAAPTConfig() {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800465 aaptLinkFlags = append(aaptLinkFlags, "-c", aaptConfig)
Dan Willemsen72be5902018-10-24 20:24:57 -0700466 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700467
Dan Willemsen72be5902018-10-24 20:24:57 -0700468 // Product AAPT preferred config
469 if len(ctx.Config().ProductAAPTPreferredConfig()) > 0 {
Jaewoong Jungde4c02f2019-01-22 11:19:56 -0800470 aaptLinkFlags = append(aaptLinkFlags, "--preferred-density", ctx.Config().ProductAAPTPreferredConfig())
Dan Willemsen72be5902018-10-24 20:24:57 -0700471 }
Colin Crosse78dcd32018-04-19 15:25:19 -0700472 }
473
Jiyong Park7f67f482019-01-05 12:57:48 +0900474 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jaewoong Jung6f373f62019-03-13 10:13:24 -0700475 if overridden || a.overridableAppProperties.Package_name != nil {
476 // The product override variable has a priority over the package_name property.
477 if !overridden {
478 manifestPackageName = *a.overridableAppProperties.Package_name
479 }
Liz Kammer9f9fd022020-06-18 19:44:06 +0000480 aaptLinkFlags = append(aaptLinkFlags, generateAaptRenamePackageFlags(manifestPackageName, a.renameResourcesPackage())...)
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900481 a.overriddenManifestPackageName = manifestPackageName
Jiyong Park7f67f482019-01-05 12:57:48 +0900482 }
483
Jaewoong Jung4102e5d2019-02-27 16:26:28 -0800484 aaptLinkFlags = append(aaptLinkFlags, a.additionalAaptFlags...)
485
Colin Crosse560c4a2019-03-19 16:03:11 -0700486 a.aapt.splitNames = a.appProperties.Package_splits
Baligh Uddin5b16dfb2020-02-11 17:27:19 -0800487 a.aapt.LoggingParent = String(a.overridableAppProperties.Logging_parent)
Alexei Nicoara69cf0f32022-07-27 14:59:18 +0100488 if a.Updatable() {
489 a.aapt.defaultManifestVersion = android.DefaultUpdatableModuleVersion
490 }
Alixf7a10272023-09-27 16:47:56 +0000491 a.aapt.buildActions(ctx,
492 aaptBuildActionOptions{
493 android.SdkContext(a),
494 a.classLoaderContexts,
495 a.usesLibraryProperties.Exclude_uses_libs,
496 a.enforceDefaultTargetSdkVersion(),
497 aaptLinkFlags,
498 },
499 )
Colin Cross30e076a2015-04-13 13:58:27 -0700500
Colin Cross46c9b8b2017-06-22 16:51:17 -0700501 // apps manifests are handled by aapt, don't let Module see them
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700502 a.properties.Manifest = nil
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800503}
Colin Cross30e076a2015-04-13 13:58:27 -0700504
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800505func (a *AndroidApp) proguardBuildActions(ctx android.ModuleContext) {
Colin Cross89c31582018-04-30 15:55:11 -0700506 var staticLibProguardFlagFiles android.Paths
507 ctx.VisitDirectDeps(func(m android.Module) {
Sam Delmerico95d70942023-08-02 18:00:35 -0400508 depProguardInfo := ctx.OtherModuleProvider(m, ProguardSpecInfoProvider).(ProguardSpecInfo)
509 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.UnconditionallyExportedProguardFlags.ToList()...)
510 if ctx.OtherModuleDependencyTag(m) == staticLibTag {
511 staticLibProguardFlagFiles = append(staticLibProguardFlagFiles, depProguardInfo.ProguardFlagsFiles.ToList()...)
Colin Cross89c31582018-04-30 15:55:11 -0700512 }
513 })
514
515 staticLibProguardFlagFiles = android.FirstUniquePaths(staticLibProguardFlagFiles)
516
517 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, staticLibProguardFlagFiles...)
518 a.Module.extraProguardFlagFiles = append(a.Module.extraProguardFlagFiles, a.proguardOptionsFile)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800519}
Colin Cross66dbc0b2017-12-28 12:23:20 -0800520
Colin Cross403cc152020-07-06 14:15:24 -0700521func (a *AndroidApp) installPath(ctx android.ModuleContext) android.InstallPath {
Colin Cross43f08db2018-11-12 10:13:39 -0800522 var installDir string
523 if ctx.ModuleName() == "framework-res" {
524 // framework-res.apk is installed as system/framework/framework-res.apk
525 installDir = "framework"
Jiyong Parkf7487312019-10-17 12:54:30 +0900526 } else if a.Privileged() {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800527 installDir = filepath.Join("priv-app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800528 } else {
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800529 installDir = filepath.Join("app", a.installApkName)
Colin Cross43f08db2018-11-12 10:13:39 -0800530 }
Colin Cross403cc152020-07-06 14:15:24 -0700531
532 return android.PathForModuleInstall(ctx, installDir, a.installApkName+".apk")
533}
534
Rico Windb56fe282023-11-01 07:17:19 +0100535func (a *AndroidApp) dexBuildActions(ctx android.ModuleContext) (android.Path, android.Path) {
Colin Cross403cc152020-07-06 14:15:24 -0700536 a.dexpreopter.installPath = a.installPath(ctx)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000537 a.dexpreopter.isApp = true
Liz Kammera7a64f32020-07-09 15:16:41 -0700538 if a.dexProperties.Uncompress_dex == nil {
David Srbeckye033cba2020-05-20 22:20:28 +0100539 // If the value was not force-set by the user, use reasonable default based on the module.
Liz Kammera7a64f32020-07-09 15:16:41 -0700540 a.dexProperties.Uncompress_dex = proptools.BoolPtr(a.shouldUncompressDex(ctx))
David Srbeckye033cba2020-05-20 22:20:28 +0100541 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700542 a.dexpreopter.uncompressedDex = *a.dexProperties.Uncompress_dex
Colin Cross50ddcc42019-05-16 12:28:22 -0700543 a.dexpreopter.enforceUsesLibs = a.usesLibrary.enforceUsesLibraries()
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100544 a.dexpreopter.classLoaderContexts = a.classLoaderContexts
Colin Cross50ddcc42019-05-16 12:28:22 -0700545 a.dexpreopter.manifestFile = a.mergedManifestFile
Colin Crossfa9bfcd2021-11-10 16:42:38 -0800546 a.dexpreopter.preventInstall = a.appProperties.PreventInstall
Colin Cross50ddcc42019-05-16 12:28:22 -0700547
Rico Windb56fe282023-11-01 07:17:19 +0100548 var packageResources = a.exportPackage
549
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800550 if ctx.ModuleName() != "framework-res" {
Rico Windb56fe282023-11-01 07:17:19 +0100551 if Bool(a.dexProperties.Optimize.Shrink_resources) {
552 protoFile := android.PathForModuleOut(ctx, packageResources.Base()+".proto.apk")
553 aapt2Convert(ctx, protoFile, packageResources, "proto")
554 a.dexer.resourcesInput = android.OptionalPathForPath(protoFile)
555 }
556
Colin Cross4eae06d2023-06-20 22:40:02 -0700557 var extraSrcJars android.Paths
558 var extraClasspathJars android.Paths
559 var extraCombinedJars android.Paths
560 if a.useResourceProcessorBusyBox() {
561 // When building an app with ResourceProcessorBusyBox enabled ResourceProcessorBusyBox has already
562 // created R.class files that provide IDs for resources in busybox/R.jar. Pass that file in the
563 // classpath when compiling everything else, and add it to the final classes jar.
564 extraClasspathJars = android.Paths{a.aapt.rJar}
565 extraCombinedJars = android.Paths{a.aapt.rJar}
566 } else {
567 // When building an app without ResourceProcessorBusyBox the aapt2 rule creates R.srcjar containing
568 // R.java files for the app's package and the packages from all transitive static android_library
569 // dependencies. Compile the srcjar alongside the rest of the sources.
570 extraSrcJars = android.Paths{a.aapt.aaptSrcJar}
571 }
572
573 a.Module.compile(ctx, extraSrcJars, extraClasspathJars, extraCombinedJars)
Rico Windb56fe282023-11-01 07:17:19 +0100574 if Bool(a.dexProperties.Optimize.Shrink_resources) {
575 binaryResources := android.PathForModuleOut(ctx, packageResources.Base()+".binary.out.apk")
576 aapt2Convert(ctx, binaryResources, a.dexer.resourcesOutput.Path(), "binary")
577 packageResources = binaryResources
578 }
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800579 }
Colin Cross30e076a2015-04-13 13:58:27 -0700580
Rico Windb56fe282023-11-01 07:17:19 +0100581 return a.dexJarFile.PathOrNil(), packageResources
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800582}
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800583
Sam Delmerico82602492022-06-10 17:05:42 +0000584func (a *AndroidApp) jniBuildActions(jniLibs []jniLib, prebuiltJniPackages android.Paths, ctx android.ModuleContext) android.WritablePath {
Colin Crossa4f08812018-10-02 22:03:40 -0700585 var jniJarFile android.WritablePath
Sam Delmerico82602492022-06-10 17:05:42 +0000586 if len(jniLibs) > 0 || len(prebuiltJniPackages) > 0 {
Colin Cross403cc152020-07-06 14:15:24 -0700587 a.jniLibs = jniLibs
Jaewoong Jungbc625cd2019-05-06 15:48:44 -0700588 if a.shouldEmbedJnis(ctx) {
Colin Crossa4f08812018-10-02 22:03:40 -0700589 jniJarFile = android.PathForModuleOut(ctx, "jnilibs.zip")
Colin Crossc68db4b2021-11-11 18:59:15 -0800590 a.installPathForJNISymbols = a.installPath(ctx)
Sam Delmerico82602492022-06-10 17:05:42 +0000591 TransformJniLibsToJar(ctx, jniJarFile, jniLibs, prebuiltJniPackages, a.useEmbeddedNativeLibs(ctx))
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700592 for _, jni := range jniLibs {
593 if jni.coverageFile.Valid() {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700594 // Only collect coverage for the first target arch if this is a multilib target.
595 // TODO(jungjw): Ideally, we want to collect both reports, but that would cause coverage
596 // data file path collisions since the current coverage file path format doesn't contain
597 // arch-related strings. This is fine for now though; the code coverage team doesn't use
598 // multi-arch targets such as test_suite_* for coverage collections yet.
599 //
600 // Work with the team to come up with a new format that handles multilib modules properly
601 // and change this.
602 if len(ctx.Config().Targets[android.Android]) == 1 ||
Jaewoong Jung642916f2020-10-09 17:25:15 -0700603 ctx.Config().AndroidFirstDeviceTarget.Arch.ArchType == jni.target.Arch.ArchType {
Jaewoong Jung46984ee2020-04-07 13:07:55 -0700604 a.jniCoverageOutputs = append(a.jniCoverageOutputs, jni.coverageFile.Path())
605 }
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700606 }
607 }
Colin Cross403cc152020-07-06 14:15:24 -0700608 a.embeddedJniLibs = true
Colin Crossa4f08812018-10-02 22:03:40 -0700609 }
610 }
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800611 return jniJarFile
612}
Colin Crossa4f08812018-10-02 22:03:40 -0700613
Colin Cross403cc152020-07-06 14:15:24 -0700614func (a *AndroidApp) JNISymbolsInstalls(installPath string) android.RuleBuilderInstalls {
615 var jniSymbols android.RuleBuilderInstalls
616 for _, jniLib := range a.jniLibs {
617 if jniLib.unstrippedFile != nil {
618 jniSymbols = append(jniSymbols, android.RuleBuilderInstall{
619 From: jniLib.unstrippedFile,
620 To: filepath.Join(installPath, targetToJniDir(jniLib.target), jniLib.unstrippedFile.Base()),
621 })
622 }
623 }
624 return jniSymbols
625}
626
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700627// Reads and prepends a main cert from the default cert dir if it hasn't been set already, i.e. it
628// isn't a cert module reference. Also checks and enforces system cert restriction if applicable.
Colin Crossbc2c8a72022-09-14 12:45:42 -0700629func processMainCert(m android.ModuleBase, certPropValue string, certificates []Certificate,
630 ctx android.ModuleContext) (mainCertificate Certificate, allCertificates []Certificate) {
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700631 if android.SrcIsModule(certPropValue) == "" {
632 var mainCert Certificate
633 if certPropValue != "" {
634 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
635 mainCert = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -0800636 Pem: defaultDir.Join(ctx, certPropValue+".x509.pem"),
637 Key: defaultDir.Join(ctx, certPropValue+".pk8"),
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700638 }
639 } else {
640 pem, key := ctx.Config().DefaultAppCertificate(ctx)
Colin Cross503c1d02020-01-28 14:00:53 -0800641 mainCert = Certificate{
642 Pem: pem,
643 Key: key,
644 }
Colin Crossbd01e2a2018-10-04 15:21:03 -0700645 }
Jaewoong Jungccbb3932019-04-15 09:48:31 -0700646 certificates = append([]Certificate{mainCert}, certificates...)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700647 }
648
Colin Crossbc2c8a72022-09-14 12:45:42 -0700649 if len(certificates) > 0 {
650 mainCertificate = certificates[0]
651 } else {
652 // This can be reached with an empty certificate list if AllowMissingDependencies is set
653 // and the certificate property for this module is a module reference to a missing module.
654 if !ctx.Config().AllowMissingDependencies() && len(ctx.GetMissingDependencies()) > 0 {
655 panic("Should only get here if AllowMissingDependencies set and there are missing dependencies")
656 }
657 // Set a certificate to avoid panics later when accessing it.
658 mainCertificate = Certificate{
659 Key: android.PathForModuleOut(ctx, "missing.pk8"),
Colin Crossa54f4b52022-11-21 04:35:53 +0000660 Pem: android.PathForModuleOut(ctx, "missing.x509.pem"),
Colin Crossbc2c8a72022-09-14 12:45:42 -0700661 }
662 }
663
Zyan Wub7550aa2023-05-18 15:46:31 +0800664 if !m.Platform() {
665 certPath := mainCertificate.Pem.String()
666 systemCertPath := ctx.Config().DefaultAppCertificateDir(ctx).String()
667 if strings.HasPrefix(certPath, systemCertPath) {
668 enforceSystemCert := ctx.Config().EnforceSystemCertificate()
669 allowed := ctx.Config().EnforceSystemCertificateAllowList()
670
671 if enforceSystemCert && !inList(m.Name(), allowed) {
672 ctx.PropertyErrorf("certificate", "The module in product partition cannot be signed with certificate in system.")
673 }
674 }
675 }
676
Colin Crossbc2c8a72022-09-14 12:45:42 -0700677 return mainCertificate, certificates
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800678}
679
Jooyung Han39ee1192020-03-23 20:21:11 +0900680func (a *AndroidApp) InstallApkName() string {
681 return a.installApkName
682}
683
Sam Delmerico15809f82023-05-15 17:21:47 -0400684func (a *AndroidApp) createPrivappAllowlist(ctx android.ModuleContext) android.Path {
Andrei Onea580636b2022-08-17 16:53:46 +0000685 if a.appProperties.Privapp_allowlist == nil {
686 return nil
687 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400688
689 isOverrideApp := a.GetOverriddenBy() != ""
690 if !isOverrideApp {
691 // if this is not an override, we don't need to rewrite the existing privapp allowlist
692 return android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist)
693 }
694
Andrei Onea580636b2022-08-17 16:53:46 +0000695 if a.overridableAppProperties.Package_name == nil {
696 ctx.PropertyErrorf("privapp_allowlist", "package_name must be set to use privapp_allowlist")
697 }
Sam Delmerico15809f82023-05-15 17:21:47 -0400698
Andrei Onea580636b2022-08-17 16:53:46 +0000699 packageName := *a.overridableAppProperties.Package_name
700 fileName := "privapp_allowlist_" + packageName + ".xml"
701 outPath := android.PathForModuleOut(ctx, fileName).OutputPath
702 ctx.Build(pctx, android.BuildParams{
703 Rule: modifyAllowlist,
704 Input: android.PathForModuleSrc(ctx, *a.appProperties.Privapp_allowlist),
705 Output: outPath,
706 Args: map[string]string{
707 "packageName": packageName,
708 },
709 })
710 return &outPath
711}
712
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800713func (a *AndroidApp) generateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross50ddcc42019-05-16 12:28:22 -0700714 var apkDeps android.Paths
715
Colin Cross56a83212020-09-15 18:30:11 -0700716 if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
717 a.hideApexVariantFromMake = true
718 }
719
Jeongik Cha538c0d02019-07-11 15:54:27 +0900720 a.aapt.useEmbeddedNativeLibs = a.useEmbeddedNativeLibs(ctx)
721 a.aapt.useEmbeddedDex = Bool(a.appProperties.Use_embedded_dex)
722
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000723 // Unlike installApkName, a.stem should respect base module name for override_android_app.
724 // Therefore, use ctx.ModuleName() instead of a.Name().
725 a.stem = proptools.StringDefault(a.overridableDeviceProperties.Stem, ctx.ModuleName())
726
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800727 // Check if the install APK name needs to be overridden.
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000728 // Both android_app and override_android_app module are expected to possess
729 // its module bound apk path. However, override_android_app inherits ctx.ModuleName()
730 // from the base module. Therefore, use a.Name() which represents
731 // the module name for both android_app and override_android_app.
732 a.installApkName = ctx.DeviceConfig().OverridePackageNameFor(
733 proptools.StringDefault(a.overridableDeviceProperties.Stem, a.Name()))
Jaewoong Jung9d22a912019-01-23 16:27:47 -0800734
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700735 if ctx.ModuleName() == "framework-res" {
736 // framework-res.apk is installed as system/framework/framework-res.apk
Jaewoong Jung0949f312019-09-11 10:25:18 -0700737 a.installDir = android.PathForModuleInstall(ctx, "framework")
Jiyong Parkf7487312019-10-17 12:54:30 +0900738 } else if a.Privileged() {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700739 a.installDir = android.PathForModuleInstall(ctx, "priv-app", a.installApkName)
740 } else if ctx.InstallInTestcases() {
Jaewoong Jung326a9412019-11-21 10:41:00 -0800741 a.installDir = android.PathForModuleInstall(ctx, a.installApkName, ctx.DeviceConfig().DeviceArch())
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700742 } else {
Jaewoong Jung0949f312019-09-11 10:25:18 -0700743 a.installDir = android.PathForModuleInstall(ctx, "app", a.installApkName)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700744 }
Jaewoong Jung7dd4ae22019-09-27 17:13:15 -0700745 a.onDeviceDir = android.InstallPathToOnDevicePath(ctx, a.installDir)
Jaewoong Jung5b425e22019-06-17 17:40:56 -0700746
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100747 a.classLoaderContexts = a.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
Ulya Trafimovich18554242020-11-03 15:55:11 +0000748
Colin Cross61fb62e2022-06-23 10:46:28 -0700749 var noticeAssetPath android.WritablePath
750 if Bool(a.appProperties.Embed_notices) || ctx.Config().IsEnvTrue("ALWAYS_EMBED_NOTICES") {
751 // The rule to create the notice file can't be generated yet, as the final output path
752 // for the apk isn't known yet. Add the path where the notice file will be generated to the
753 // aapt rules now before calling aaptBuildActions, the rule to create the notice file will
754 // be generated later.
755 noticeAssetPath = android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
756 a.aapt.noticeFile = android.OptionalPathForPath(noticeAssetPath)
757 }
758
Harshit Mahajan8f202ad2023-01-09 20:45:55 +0000759 // For apps targeting latest target_sdk_version
760 if Bool(a.appProperties.Enforce_default_target_sdk_version) {
761 a.SetEnforceDefaultTargetSdkVersion(true)
762 }
763
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800764 // Process all building blocks, from AAPT to certificates.
765 a.aaptBuildActions(ctx)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100766 // The decision to enforce <uses-library> checks is made before adding implicit SDK libraries.
767 a.usesLibrary.freezeEnforceUsesLibraries()
768
769 // Add implicit SDK libraries to <uses-library> list.
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100770 requiredUsesLibs, optionalUsesLibs := a.classLoaderContexts.UsesLibs()
771 for _, usesLib := range requiredUsesLibs {
772 a.usesLibrary.addLib(usesLib, false)
773 }
774 for _, usesLib := range optionalUsesLibs {
775 a.usesLibrary.addLib(usesLib, true)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100776 }
777
778 // Check that the <uses-library> list is coherent with the manifest.
Colin Cross50ddcc42019-05-16 12:28:22 -0700779 if a.usesLibrary.enforceUsesLibraries() {
780 manifestCheckFile := a.usesLibrary.verifyUsesLibrariesManifest(ctx, a.mergedManifestFile)
781 apkDeps = append(apkDeps, manifestCheckFile)
782 }
783
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800784 a.proguardBuildActions(ctx)
785
Colin Cross014489c2020-06-02 20:09:13 -0700786 a.linter.mergedManifest = a.aapt.mergedManifestFile
787 a.linter.manifest = a.aapt.manifestPath
788 a.linter.resources = a.aapt.resourceFiles
Colin Crossc0efd1d2020-07-03 11:56:24 -0700789 a.linter.buildModuleReportZip = ctx.Config().UnbundledBuildApps()
Colin Cross014489c2020-06-02 20:09:13 -0700790
Rico Windb56fe282023-11-01 07:17:19 +0100791 dexJarFile, packageResources := a.dexBuildActions(ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800792
Colin Crossbc2c8a72022-09-14 12:45:42 -0700793 jniLibs, prebuiltJniPackages, certificates := collectAppDeps(ctx, a, a.shouldEmbedJnis(ctx), !Bool(a.appProperties.Jni_uses_platform_apis))
Sam Delmerico82602492022-06-10 17:05:42 +0000794 jniJarFile := a.jniBuildActions(jniLibs, prebuiltJniPackages, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800795
796 if ctx.Failed() {
797 return
798 }
799
Colin Crossbc2c8a72022-09-14 12:45:42 -0700800 a.certificate, certificates = processMainCert(a.ModuleBase, a.getCertString(ctx), certificates, ctx)
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800801
802 // Build a final signed app package.
Jaewoong Jung5a498812019-11-07 14:14:38 -0800803 packageFile := android.PathForModuleOut(ctx, a.installApkName+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700804 v4SigningRequested := Bool(a.Module.deviceProperties.V4_signature)
805 var v4SignatureFile android.WritablePath = nil
806 if v4SigningRequested {
807 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+".apk.idsig")
808 }
Liz Kammere2b27f42020-05-07 13:24:05 -0700809 var lineageFile android.Path
810 if lineage := String(a.overridableAppProperties.Lineage); lineage != "" {
811 lineageFile = android.PathForModuleSrc(ctx, lineage)
812 }
Rupert Shuttleworth8eab8692021-11-03 10:39:39 -0400813 rotationMinSdkVersion := String(a.overridableAppProperties.RotationMinSdkVersion)
814
Rico Windb56fe282023-11-01 07:17:19 +0100815 CreateAndSignAppPackage(ctx, packageFile, packageResources, jniJarFile, dexJarFile, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800816 a.outputFile = packageFile
Songchun Fan17d69e32020-03-24 20:32:24 -0700817 if v4SigningRequested {
818 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
819 }
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800820
Colin Cross61fb62e2022-06-23 10:46:28 -0700821 if a.aapt.noticeFile.Valid() {
822 // Generating the notice file rule has to be here after a.outputFile is known.
Bob Badoureef4c1c2022-05-16 12:20:04 -0700823 noticeFile := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700824 android.BuildNoticeHtmlOutputFromLicenseMetadata(
825 ctx, noticeFile, "", "",
826 []string{
827 a.installDir.String() + "/",
828 android.PathForModuleInstall(ctx).String() + "/",
829 a.outputFile.String(),
830 })
Bob Badoureef4c1c2022-05-16 12:20:04 -0700831 builder := android.NewRuleBuilder(pctx, ctx)
832 builder.Command().Text("cp").
833 Input(noticeFile).
834 Output(noticeAssetPath)
835 builder.Build("notice_dir", "Building notice dir")
Bob Badoureef4c1c2022-05-16 12:20:04 -0700836 }
837
Colin Crosse560c4a2019-03-19 16:03:11 -0700838 for _, split := range a.aapt.splits {
839 // Sign the split APKs
Jaewoong Jung5a498812019-11-07 14:14:38 -0800840 packageFile := android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk")
Songchun Fan17d69e32020-03-24 20:32:24 -0700841 if v4SigningRequested {
842 v4SignatureFile = android.PathForModuleOut(ctx, a.installApkName+"_"+split.suffix+".apk.idsig")
843 }
Rico Windb56fe282023-11-01 07:17:19 +0100844 CreateAndSignAppPackage(ctx, packageFile, split.path, nil, nil, certificates, apkDeps, v4SignatureFile, lineageFile, rotationMinSdkVersion)
Colin Crosse560c4a2019-03-19 16:03:11 -0700845 a.extraOutputFiles = append(a.extraOutputFiles, packageFile)
Songchun Fan17d69e32020-03-24 20:32:24 -0700846 if v4SigningRequested {
847 a.extraOutputFiles = append(a.extraOutputFiles, v4SignatureFile)
848 }
Colin Crosse560c4a2019-03-19 16:03:11 -0700849 }
850
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800851 // Build an app bundle.
Colin Crossf6237212018-10-29 23:14:58 -0700852 bundleFile := android.PathForModuleOut(ctx, "base.zip")
853 BuildBundleModule(ctx, bundleFile, a.exportPackage, jniJarFile, dexJarFile)
854 a.bundleFile = bundleFile
855
Andrei Onea580636b2022-08-17 16:53:46 +0000856 allowlist := a.createPrivappAllowlist(ctx)
857 if allowlist != nil {
858 a.privAppAllowlist = android.OptionalPathForPath(allowlist)
859 }
860
Colin Cross56a83212020-09-15 18:30:11 -0700861 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
862
Jaewoong Jung590b1ae2019-01-22 16:40:58 -0800863 // Install the app package.
Andrei Onea580636b2022-08-17 16:53:46 +0000864 shouldInstallAppPackage := (Bool(a.Module.properties.Installable) || ctx.Host()) && apexInfo.IsForPlatform() && !a.appProperties.PreventInstall
865 if shouldInstallAppPackage {
Sam Delmericob1daccd2023-05-25 14:45:30 -0400866 if a.privAppAllowlist.Valid() {
Anton Hansson0e486a42023-06-01 16:38:35 +0000867 allowlistInstallPath := android.PathForModuleInstall(ctx, "etc", "permissions")
868 allowlistInstallFilename := a.installApkName + ".xml"
869 ctx.InstallFile(allowlistInstallPath, allowlistInstallFilename, a.privAppAllowlist.Path())
Sam Delmericob1daccd2023-05-25 14:45:30 -0400870 }
871
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700872 var extraInstalledPaths android.Paths
Jiyong Park8ba50f92019-11-13 15:01:01 +0900873 for _, extra := range a.extraOutputFiles {
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700874 installed := ctx.InstallFile(a.installDir, extra.Base(), extra)
875 extraInstalledPaths = append(extraInstalledPaths, installed)
Jiyong Park8ba50f92019-11-13 15:01:01 +0900876 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700877 ctx.InstallFile(a.installDir, a.outputFile.Base(), a.outputFile, extraInstalledPaths...)
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800878 }
Artur Satayev1111b842020-04-27 19:05:28 +0100879
880 a.buildAppDependencyInfo(ctx)
Colin Cross30e076a2015-04-13 13:58:27 -0700881}
882
Colin Crossc2d24052020-05-13 11:05:02 -0700883type appDepsInterface interface {
Jiyong Park92315372021-04-02 08:45:46 +0900884 SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000885 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Colin Crossc2d24052020-05-13 11:05:02 -0700886 RequiresStableAPIs(ctx android.BaseModuleContext) bool
887}
888
889func collectAppDeps(ctx android.ModuleContext, app appDepsInterface,
890 shouldCollectRecursiveNativeDeps bool,
Sam Delmerico82602492022-06-10 17:05:42 +0000891 checkNativeSdkVersion bool) ([]jniLib, android.Paths, []Certificate) {
Colin Crossc2d24052020-05-13 11:05:02 -0700892
Colin Crossa4f08812018-10-02 22:03:40 -0700893 var jniLibs []jniLib
Sam Delmerico82602492022-06-10 17:05:42 +0000894 var prebuiltJniPackages android.Paths
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900895 var certificates []Certificate
Peter Collingbournead84f972019-12-17 16:46:18 -0800896 seenModulePaths := make(map[string]bool)
Colin Crossa4f08812018-10-02 22:03:40 -0700897
Colin Crossc2d24052020-05-13 11:05:02 -0700898 if checkNativeSdkVersion {
Jiyong Park92315372021-04-02 08:45:46 +0900899 checkNativeSdkVersion = app.SdkVersion(ctx).Specified() &&
900 app.SdkVersion(ctx).Kind != android.SdkCorePlatform && !app.RequiresStableAPIs(ctx)
Colin Crossc2d24052020-05-13 11:05:02 -0700901 }
902
Peter Collingbournead84f972019-12-17 16:46:18 -0800903 ctx.WalkDeps(func(module android.Module, parent android.Module) bool {
Colin Crossa4f08812018-10-02 22:03:40 -0700904 otherName := ctx.OtherModuleName(module)
905 tag := ctx.OtherModuleDependencyTag(module)
906
Colin Crossf0913fb2020-07-29 12:59:39 -0700907 if IsJniDepTag(tag) || cc.IsSharedDepTag(tag) {
Ivan Lozano7f67c2a2022-06-27 16:00:26 -0400908 if dep, ok := module.(cc.LinkableInterface); ok {
Colin Cross95f1ca02020-10-29 20:47:22 -0700909 if dep.IsNdk(ctx.Config()) || dep.IsStubs() {
Peter Collingbournead84f972019-12-17 16:46:18 -0800910 return false
911 }
912
Colin Crossa4f08812018-10-02 22:03:40 -0700913 lib := dep.OutputFile()
914 if lib.Valid() {
Cole Faust64cb7c92021-09-14 17:32:49 -0700915 path := lib.Path()
916 if seenModulePaths[path.String()] {
917 return false
918 }
919 seenModulePaths[path.String()] = true
920
921 if checkNativeSdkVersion && dep.SdkVersion() == "" {
922 ctx.PropertyErrorf("jni_libs", "JNI dependency %q uses platform APIs, but this module does not",
923 otherName)
924 }
925
Colin Crossa4f08812018-10-02 22:03:40 -0700926 jniLibs = append(jniLibs, jniLib{
Colin Cross403cc152020-07-06 14:15:24 -0700927 name: ctx.OtherModuleName(module),
928 path: path,
929 target: module.Target(),
930 coverageFile: dep.CoverageOutputFile(),
931 unstrippedFile: dep.UnstrippedOutputFile(),
Jihoon Kangf78a8902022-09-01 22:47:07 +0000932 partition: dep.Partition(),
Colin Crossa4f08812018-10-02 22:03:40 -0700933 })
Colin Crossdd5261c2022-12-19 12:26:43 -0800934 } else if ctx.Config().AllowMissingDependencies() {
935 ctx.AddMissingDependencies([]string{otherName})
Colin Crossa4f08812018-10-02 22:03:40 -0700936 } else {
937 ctx.ModuleErrorf("dependency %q missing output file", otherName)
938 }
939 } else {
940 ctx.ModuleErrorf("jni_libs dependency %q must be a cc library", otherName)
Colin Crossa4f08812018-10-02 22:03:40 -0700941 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800942
943 return shouldCollectRecursiveNativeDeps
944 }
945
Sam Delmerico82602492022-06-10 17:05:42 +0000946 if info, ok := ctx.OtherModuleProvider(module, JniPackageProvider).(JniPackageInfo); ok {
947 prebuiltJniPackages = append(prebuiltJniPackages, info.JniPackages...)
948 }
949
Peter Collingbournead84f972019-12-17 16:46:18 -0800950 if tag == certificateTag {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700951 if dep, ok := module.(*AndroidAppCertificate); ok {
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900952 certificates = append(certificates, dep.Certificate)
Colin Crossbd01e2a2018-10-04 15:21:03 -0700953 } else {
954 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", otherName)
955 }
Colin Crossa4f08812018-10-02 22:03:40 -0700956 }
Peter Collingbournead84f972019-12-17 16:46:18 -0800957
958 return false
Colin Crossa4f08812018-10-02 22:03:40 -0700959 })
960
Sam Delmerico82602492022-06-10 17:05:42 +0000961 return jniLibs, prebuiltJniPackages, certificates
Colin Crossa4f08812018-10-02 22:03:40 -0700962}
963
Jooyung Han749dc692020-04-15 11:03:39 +0900964func (a *AndroidApp) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Artur Satayev1111b842020-04-27 19:05:28 +0100965 ctx.WalkDeps(func(child, parent android.Module) bool {
966 isExternal := !a.DepIsInSameApex(ctx, child)
967 if am, ok := child.(android.ApexModule); ok {
Jooyung Han749dc692020-04-15 11:03:39 +0900968 if !do(ctx, parent, am, isExternal) {
969 return false
970 }
Artur Satayev1111b842020-04-27 19:05:28 +0100971 }
972 return !isExternal
973 })
974}
975
976func (a *AndroidApp) buildAppDependencyInfo(ctx android.ModuleContext) {
977 if ctx.Host() {
978 return
979 }
980
981 depsInfo := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +0900982 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev1111b842020-04-27 19:05:28 +0100983 depName := to.Name()
Artur Satayev533b98c2021-03-11 18:03:42 +0000984
985 // Skip dependencies that are only available to APEXes; they are developed with updatability
986 // in mind and don't need manual approval.
987 if to.(android.ApexModule).NotAvailableForPlatform() {
988 return true
989 }
990
Artur Satayev1111b842020-04-27 19:05:28 +0100991 if info, exist := depsInfo[depName]; exist {
992 info.From = append(info.From, from.Name())
993 info.IsExternal = info.IsExternal && externalDep
994 depsInfo[depName] = info
995 } else {
996 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +0900997 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000998 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +0900999 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001000 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1001 toMinSdkVersion = v.String()
Artur Satayev1111b842020-04-27 19:05:28 +01001002 }
Jiyong Park92315372021-04-02 08:45:46 +09001003 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1004 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1005 // string
1006 if v := m.MinSdkVersion(); v != "" {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001007 toMinSdkVersion = v
1008 }
Artur Satayev1111b842020-04-27 19:05:28 +01001009 }
1010 depsInfo[depName] = android.ApexModuleDepInfo{
1011 To: depName,
1012 From: []string{from.Name()},
1013 IsExternal: externalDep,
1014 MinSdkVersion: toMinSdkVersion,
1015 }
1016 }
Jooyung Han749dc692020-04-15 11:03:39 +09001017 return true
Artur Satayev1111b842020-04-27 19:05:28 +01001018 })
1019
Jiyong Park92315372021-04-02 08:45:46 +09001020 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depsInfo)
Artur Satayev1111b842020-04-27 19:05:28 +01001021}
1022
Harshit Mahajan5b8b7302022-06-10 11:24:05 +00001023func (a *AndroidApp) enforceDefaultTargetSdkVersion() bool {
1024 return a.appProperties.EnforceDefaultTargetSdkVersion
1025}
1026
1027func (a *AndroidApp) SetEnforceDefaultTargetSdkVersion(val bool) {
1028 a.appProperties.EnforceDefaultTargetSdkVersion = val
1029}
1030
Artur Satayev849f8442020-04-28 14:57:42 +01001031func (a *AndroidApp) Updatable() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001032 return Bool(a.appProperties.Updatable)
Artur Satayev849f8442020-04-28 14:57:42 +01001033}
1034
Spandan Das42e89502022-05-06 22:12:55 +00001035func (a *AndroidApp) SetUpdatable(val bool) {
1036 a.appProperties.Updatable = &val
1037}
1038
Colin Cross0ea8ba82019-06-06 14:33:29 -07001039func (a *AndroidApp) getCertString(ctx android.BaseModuleContext) string {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001040 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(ctx.ModuleName())
1041 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001042 return ":" + certificate
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001043 }
Jaewoong Jung525443a2019-02-28 15:35:54 -08001044 return String(a.overridableAppProperties.Certificate)
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001045}
1046
Jiyong Park0f80c182020-01-31 02:49:53 +09001047func (a *AndroidApp) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1048 if IsJniDepTag(ctx.OtherModuleDependencyTag(dep)) {
1049 return true
1050 }
1051 return a.Library.DepIsInSameApex(ctx, dep)
1052}
1053
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001054// For OutputFileProducer interface
1055func (a *AndroidApp) OutputFiles(tag string) (android.Paths, error) {
1056 switch tag {
Jared Duke34b080d2023-03-30 16:40:24 -07001057 // In some instances, it can be useful to reference the aapt-generated flags from another
1058 // target, e.g., system server implements services declared in the framework-res manifest.
1059 case ".aapt.proguardOptionsFile":
1060 return []android.Path{a.proguardOptionsFile}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001061 case ".aapt.srcjar":
Colin Crossf3b7bad2023-08-02 15:49:00 -07001062 if a.aaptSrcJar != nil {
1063 return []android.Path{a.aaptSrcJar}, nil
1064 }
1065 case ".aapt.jar":
1066 if a.rJar != nil {
1067 return []android.Path{a.rJar}, nil
1068 }
Anton Hansson092aca42020-08-13 19:37:22 +01001069 case ".export-package.apk":
1070 return []android.Path{a.exportPackage}, nil
Jiyong Parkb7c639e2019-08-19 14:56:02 +09001071 }
1072 return a.Library.OutputFiles(tag)
1073}
1074
Jiyong Parkf7487312019-10-17 12:54:30 +09001075func (a *AndroidApp) Privileged() bool {
1076 return Bool(a.appProperties.Privileged)
1077}
1078
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001079func (a *AndroidApp) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001080 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001081}
1082
Ivan Lozanod7586b62021-04-01 09:49:36 -04001083func (a *AndroidApp) SetPreventInstall() {
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001084 a.appProperties.PreventInstall = true
1085}
1086
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001087func (a *AndroidApp) MarkAsCoverageVariant(coverage bool) {
1088 a.appProperties.IsCoverageVariant = coverage
1089}
1090
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001091func (a *AndroidApp) EnableCoverageIfNeeded() {}
1092
Jaewoong Jung87a33e72020-03-26 14:01:48 -07001093var _ cc.Coverage = (*AndroidApp)(nil)
1094
Colin Cross95b53b82023-10-17 13:21:02 -07001095func (a *AndroidApp) IDEInfo(dpInfo *android.IdeInfo) {
1096 a.Library.IDEInfo(dpInfo)
1097 a.aapt.IDEInfo(dpInfo)
1098}
1099
Colin Cross1b16b0e2019-02-12 14:41:32 -08001100// android_app compiles sources and Android resources into an Android application package `.apk` file.
Colin Cross36242852017-06-23 15:06:31 -07001101func AndroidAppFactory() android.Module {
Colin Cross30e076a2015-04-13 13:58:27 -07001102 module := &AndroidApp{}
1103
Liz Kammera7a64f32020-07-09 15:16:41 -07001104 module.Module.dexProperties.Optimize.EnabledByDefault = true
1105 module.Module.dexProperties.Optimize.Shrink = proptools.BoolPtr(true)
Jared Dukeaa88b3d2023-08-29 17:07:20 +00001106 module.Module.dexProperties.Optimize.Proguard_compatibility = proptools.BoolPtr(false)
Colin Cross66dbc0b2017-12-28 12:23:20 -08001107
Colin Crossae5caf52018-05-22 11:11:52 -07001108 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001109 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001110 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001111
Colin Crossce6734e2020-06-15 16:09:53 -07001112 module.addHostAndDeviceProperties()
Colin Cross36242852017-06-23 15:06:31 -07001113 module.AddProperties(
Colin Crossa97c5d32018-03-28 14:58:31 -07001114 &module.aaptProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001115 &module.appProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001116 &module.overridableAppProperties)
Colin Cross36242852017-06-23 15:06:31 -07001117
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001118 module.usesLibrary.enforce = true
1119
Colin Crossa4f08812018-10-02 22:03:40 -07001120 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1121 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001122 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jiyong Park52cd06f2019-11-11 10:14:32 +09001123 android.InitApexModule(module)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001124 android.InitBazelModule(module)
Colin Crossa4f08812018-10-02 22:03:40 -07001125
Colin Cross36242852017-06-23 15:06:31 -07001126 return module
Colin Cross30e076a2015-04-13 13:58:27 -07001127}
Colin Crossae5caf52018-05-22 11:11:52 -07001128
Alix96ea88452023-08-31 15:48:23 +00001129// A dictionary of values to be overridden in the manifest.
1130type Manifest_values struct {
1131 // Overrides the value of package_name in the manifest
1132 ApplicationId *string
1133}
1134
Colin Crossae5caf52018-05-22 11:11:52 -07001135type appTestProperties struct {
Liz Kammer6b0c5522020-04-28 16:10:55 -07001136 // The name of the android_app module that the tests will run against.
Colin Crossae5caf52018-05-22 11:11:52 -07001137 Instrumentation_for *string
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001138
Seth Moorec6f4b532023-02-02 13:22:26 -08001139 // If specified, the instrumentation target package name in the manifest is overwritten by it.
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001140 Instrumentation_target_package *string
Seth Moorec6f4b532023-02-02 13:22:26 -08001141
1142 // If specified, the mainline module package name in the test config is overwritten by it.
1143 Mainline_package_name *string
Alix96ea88452023-08-31 15:48:23 +00001144
1145 Manifest_values Manifest_values
Colin Crossae5caf52018-05-22 11:11:52 -07001146}
1147
1148type AndroidTest struct {
1149 AndroidApp
1150
1151 appTestProperties appTestProperties
1152
1153 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001154
Dan Shi95d19422020-08-15 12:24:26 -07001155 testConfig android.Path
1156 extraTestConfigs android.Paths
1157 data android.Paths
Jingwen Chene12c0832023-08-25 09:00:16 +00001158
1159 android.BazelModuleBase
Colin Crossae5caf52018-05-22 11:11:52 -07001160}
1161
Jaewoong Jung0949f312019-09-11 10:25:18 -07001162func (a *AndroidTest) InstallInTestcases() bool {
1163 return true
1164}
1165
Spandan Das9f7ae7f2022-07-25 00:34:18 +00001166type androidTestApp interface {
1167 includedInTestSuite(searchPrefix string) bool
1168}
1169
1170func (a *AndroidTest) includedInTestSuite(searchPrefix string) bool {
1171 return android.PrefixInList(a.testProperties.Test_suites, searchPrefix)
1172}
1173
1174func (a *AndroidTestHelperApp) includedInTestSuite(searchPrefix string) bool {
1175 return android.PrefixInList(a.appTestHelperAppProperties.Test_suites, searchPrefix)
1176}
1177
Colin Crossae5caf52018-05-22 11:11:52 -07001178func (a *AndroidTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
easoncylee5bcff5d2020-04-30 14:57:06 +08001179 var configs []tradefed.Config
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001180 if a.appTestProperties.Instrumentation_target_package != nil {
1181 a.additionalAaptFlags = append(a.additionalAaptFlags,
1182 "--rename-instrumentation-target-package "+*a.appTestProperties.Instrumentation_target_package)
1183 } else if a.appTestProperties.Instrumentation_for != nil {
1184 // Check if the instrumentation target package is overridden.
Jaewoong Jung4102e5d2019-02-27 16:26:28 -08001185 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(*a.appTestProperties.Instrumentation_for)
1186 if overridden {
1187 a.additionalAaptFlags = append(a.additionalAaptFlags, "--rename-instrumentation-target-package "+manifestPackageName)
1188 }
1189 }
Alix96ea88452023-08-31 15:48:23 +00001190 applicationId := a.appTestProperties.Manifest_values.ApplicationId
1191 if applicationId != nil {
1192 if a.overridableAppProperties.Package_name != nil {
1193 ctx.PropertyErrorf("manifest_values.applicationId", "property is not supported when property package_name is set.")
1194 }
1195 a.aapt.manifestValues.applicationId = *applicationId
1196 }
Colin Crossae5caf52018-05-22 11:11:52 -07001197 a.generateAndroidBuildActions(ctx)
Colin Cross303e21f2018-08-07 16:49:25 -07001198
easoncylee5bcff5d2020-04-30 14:57:06 +08001199 for _, module := range a.testProperties.Test_mainline_modules {
1200 configs = append(configs, tradefed.Option{Name: "config-descriptor:metadata", Key: "mainline-param", Value: module})
1201 }
1202
Jaewoong Jung39982342020-01-14 10:27:18 -08001203 testConfig := tradefed.AutoGenInstrumentationTestConfig(ctx, a.testProperties.Test_config,
easoncylee5bcff5d2020-04-30 14:57:06 +08001204 a.testProperties.Test_config_template, a.manifestPath, a.testProperties.Test_suites, a.testProperties.Auto_gen_config, configs)
Jaewoong Jung39982342020-01-14 10:27:18 -08001205 a.testConfig = a.FixTestConfig(ctx, testConfig)
Dan Shi95d19422020-08-15 12:24:26 -07001206 a.extraTestConfigs = android.PathsForModuleSrc(ctx, a.testProperties.Test_options.Extra_test_configs)
Colin Cross8a497952019-03-05 22:25:09 -08001207 a.data = android.PathsForModuleSrc(ctx, a.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001208}
1209
Jaewoong Jung39982342020-01-14 10:27:18 -08001210func (a *AndroidTest) FixTestConfig(ctx android.ModuleContext, testConfig android.Path) android.Path {
1211 if testConfig == nil {
1212 return nil
1213 }
1214
1215 fixedConfig := android.PathForModuleOut(ctx, "test_config_fixer", "AndroidTest.xml")
Colin Crossf1a035e2020-11-16 17:32:30 -08001216 rule := android.NewRuleBuilder(pctx, ctx)
1217 command := rule.Command().BuiltTool("test_config_fixer").Input(testConfig).Output(fixedConfig)
Jaewoong Jung39982342020-01-14 10:27:18 -08001218 fixNeeded := false
1219
Jooyung Han29e2f6d2022-01-08 12:13:59 +09001220 // 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 -08001221 if ctx.ModuleName() != a.installApkName {
1222 fixNeeded = true
1223 command.FlagWithArg("--test-file-name ", a.installApkName+".apk")
1224 }
1225
1226 if a.overridableAppProperties.Package_name != nil {
1227 fixNeeded = true
1228 command.FlagWithInput("--manifest ", a.manifestPath).
1229 FlagWithArg("--package-name ", *a.overridableAppProperties.Package_name)
1230 }
1231
Seth Moorec6f4b532023-02-02 13:22:26 -08001232 if a.appTestProperties.Mainline_package_name != nil {
1233 fixNeeded = true
1234 command.FlagWithArg("--mainline-package-name ", *a.appTestProperties.Mainline_package_name)
1235 }
1236
Jaewoong Jung39982342020-01-14 10:27:18 -08001237 if fixNeeded {
Colin Crossf1a035e2020-11-16 17:32:30 -08001238 rule.Build("fix_test_config", "fix test config")
Jaewoong Jung39982342020-01-14 10:27:18 -08001239 return fixedConfig
1240 }
1241 return testConfig
1242}
1243
Colin Cross303e21f2018-08-07 16:49:25 -07001244func (a *AndroidTest) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross303e21f2018-08-07 16:49:25 -07001245 a.AndroidApp.DepsMutator(ctx)
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001246}
1247
1248func (a *AndroidTest) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1249 a.AndroidApp.OverridablePropertiesDepsMutator(ctx)
Colin Cross4b964c02018-10-15 16:18:06 -07001250 if a.appTestProperties.Instrumentation_for != nil {
1251 // The android_app dependency listed in instrumentation_for needs to be added to the classpath for javac,
1252 // but not added to the aapt2 link includes like a normal android_app or android_library dependency, so
1253 // use instrumentationForTag instead of libTag.
1254 ctx.AddVariationDependencies(nil, instrumentationForTag, String(a.appTestProperties.Instrumentation_for))
1255 }
Colin Crossae5caf52018-05-22 11:11:52 -07001256}
1257
Colin Cross1b16b0e2019-02-12 14:41:32 -08001258// android_test compiles test sources and Android resources into an Android application package `.apk` file and
1259// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
Colin Crossae5caf52018-05-22 11:11:52 -07001260func AndroidTestFactory() android.Module {
1261 module := &AndroidTest{}
1262
Jared Duke63a3da92022-06-02 19:11:14 +00001263 module.Module.dexProperties.Optimize.EnabledByDefault = false
Colin Cross5067db92018-09-17 16:46:35 -07001264
1265 module.Module.properties.Instrument = true
Paul Duffin0038a8d2022-05-03 00:28:40 +00001266 module.Module.properties.Supports_static_instrumentation = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001267 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001268 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001269 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001270 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001271 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Crossae5caf52018-05-22 11:11:52 -07001272
Colin Crossce6734e2020-06-15 16:09:53 -07001273 module.addHostAndDeviceProperties()
Colin Crossae5caf52018-05-22 11:11:52 -07001274 module.AddProperties(
Colin Crossae5caf52018-05-22 11:11:52 -07001275 &module.aaptProperties,
1276 &module.appProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001277 &module.appTestProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001278 &module.overridableAppProperties,
Dan Willemsenf5531d22018-07-16 17:21:19 -07001279 &module.testProperties)
Colin Crossae5caf52018-05-22 11:11:52 -07001280
Colin Crossa4f08812018-10-02 22:03:40 -07001281 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1282 android.InitDefaultableModule(module)
zhidou198f5892022-02-17 02:33:12 +00001283 android.InitOverridableModule(module, &module.overridableAppProperties.Overrides)
Jingwen Chene12c0832023-08-25 09:00:16 +00001284
1285 android.InitBazelModule(module)
Colin Crossae5caf52018-05-22 11:11:52 -07001286 return module
1287}
Colin Crossbd01e2a2018-10-04 15:21:03 -07001288
Colin Cross252fc6f2018-10-04 15:22:03 -07001289type appTestHelperAppProperties struct {
1290 // list of compatibility suites (for example "cts", "vts") that the module should be
1291 // installed into.
1292 Test_suites []string `android:"arch_variant"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07001293
1294 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
1295 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
1296 // explicitly.
1297 Auto_gen_config *bool
Colin Crosscfb0f5e2021-09-24 15:47:17 -07001298
1299 // Install the test into a folder named for the module in all test suites.
1300 Per_testcase_directory *bool
Alix96ea88452023-08-31 15:48:23 +00001301
1302 Manifest_values Manifest_values
Colin Cross252fc6f2018-10-04 15:22:03 -07001303}
1304
1305type AndroidTestHelperApp struct {
1306 AndroidApp
1307
1308 appTestHelperAppProperties appTestHelperAppProperties
Jingwen Chen65289992023-09-21 15:15:47 +00001309
1310 android.BazelModuleBase
Colin Cross252fc6f2018-10-04 15:22:03 -07001311}
1312
Jaewoong Jung326a9412019-11-21 10:41:00 -08001313func (a *AndroidTestHelperApp) InstallInTestcases() bool {
1314 return true
1315}
1316
Colin Cross1b16b0e2019-02-12 14:41:32 -08001317// android_test_helper_app compiles sources and Android resources into an Android application package `.apk` file that
1318// will be used by tests, but does not produce an `AndroidTest.xml` file so the module will not be run directly as a
1319// test.
Colin Cross252fc6f2018-10-04 15:22:03 -07001320func AndroidTestHelperAppFactory() android.Module {
1321 module := &AndroidTestHelperApp{}
1322
Jared Duke63a3da92022-06-02 19:11:14 +00001323 // TODO(b/192032291): Disable by default after auditing downstream usage.
Liz Kammera7a64f32020-07-09 15:16:41 -07001324 module.Module.dexProperties.Optimize.EnabledByDefault = true
Colin Cross252fc6f2018-10-04 15:22:03 -07001325
1326 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse4246ab2019-02-05 21:55:21 -08001327 module.appProperties.Use_embedded_native_libs = proptools.BoolPtr(true)
Colin Cross47fa9d32019-03-26 10:51:39 -07001328 module.appProperties.AlwaysPackageNativeLibs = true
Colin Cross43f08db2018-11-12 10:13:39 -08001329 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001330 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross252fc6f2018-10-04 15:22:03 -07001331
Colin Crossce6734e2020-06-15 16:09:53 -07001332 module.addHostAndDeviceProperties()
Colin Cross252fc6f2018-10-04 15:22:03 -07001333 module.AddProperties(
Colin Cross252fc6f2018-10-04 15:22:03 -07001334 &module.aaptProperties,
1335 &module.appProperties,
Jaewoong Jung525443a2019-02-28 15:35:54 -08001336 &module.appTestHelperAppProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001337 &module.overridableAppProperties)
Colin Cross252fc6f2018-10-04 15:22:03 -07001338
1339 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon)
1340 android.InitDefaultableModule(module)
Anton Hansson3d2b6b42020-01-10 15:06:01 +00001341 android.InitApexModule(module)
Jingwen Chen65289992023-09-21 15:15:47 +00001342 android.InitBazelModule(module)
Colin Cross252fc6f2018-10-04 15:22:03 -07001343 return module
1344}
1345
Colin Crossbd01e2a2018-10-04 15:21:03 -07001346type AndroidAppCertificate struct {
1347 android.ModuleBase
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001348 android.BazelModuleBase
1349
Colin Crossbd01e2a2018-10-04 15:21:03 -07001350 properties AndroidAppCertificateProperties
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001351 Certificate Certificate
Colin Crossbd01e2a2018-10-04 15:21:03 -07001352}
1353
1354type AndroidAppCertificateProperties struct {
1355 // Name of the certificate files. Extensions .x509.pem and .pk8 will be added to the name.
1356 Certificate *string
1357}
1358
Colin Cross1b16b0e2019-02-12 14:41:32 -08001359// android_app_certificate modules can be referenced by the certificates property of android_app modules to select
1360// the signing key.
Colin Crossbd01e2a2018-10-04 15:21:03 -07001361func AndroidAppCertificateFactory() android.Module {
1362 module := &AndroidAppCertificate{}
1363 module.AddProperties(&module.properties)
1364 android.InitAndroidModule(module)
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04001365 android.InitBazelModule(module)
Colin Crossbd01e2a2018-10-04 15:21:03 -07001366 return module
1367}
1368
Colin Crossbd01e2a2018-10-04 15:21:03 -07001369func (c *AndroidAppCertificate) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1370 cert := String(c.properties.Certificate)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001371 c.Certificate = Certificate{
Colin Cross503c1d02020-01-28 14:00:53 -08001372 Pem: android.PathForModuleSrc(ctx, cert+".x509.pem"),
1373 Key: android.PathForModuleSrc(ctx, cert+".pk8"),
Colin Crossbd01e2a2018-10-04 15:21:03 -07001374 }
1375}
Jaewoong Jung525443a2019-02-28 15:35:54 -08001376
1377type OverrideAndroidApp struct {
1378 android.ModuleBase
1379 android.OverrideModuleBase
1380}
1381
Sasha Smundak613cbb12020-06-05 10:27:23 -07001382func (i *OverrideAndroidApp) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung525443a2019-02-28 15:35:54 -08001383 // All the overrides happen in the base module.
1384 // TODO(jungjw): Check the base module type.
1385}
1386
1387// override_android_app is used to create an android_app module based on another android_app by overriding
1388// some of its properties.
1389func OverrideAndroidAppModuleFactory() android.Module {
1390 m := &OverrideAndroidApp{}
Jooyung Han01d80d82022-01-08 12:16:32 +09001391 m.AddProperties(
1392 &OverridableDeviceProperties{},
1393 &overridableAppProperties{},
1394 )
Jaewoong Jung525443a2019-02-28 15:35:54 -08001395
Jaewoong Jungb639a6a2019-05-10 15:16:29 -07001396 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
Jaewoong Jung525443a2019-02-28 15:35:54 -08001397 android.InitOverrideModule(m)
1398 return m
1399}
Jaewoong Jungccbb3932019-04-15 09:48:31 -07001400
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001401type OverrideAndroidTest struct {
1402 android.ModuleBase
1403 android.OverrideModuleBase
1404}
1405
Sasha Smundak613cbb12020-06-05 10:27:23 -07001406func (i *OverrideAndroidTest) GenerateAndroidBuildActions(_ android.ModuleContext) {
Jaewoong Jung26dedd32019-06-06 08:45:58 -07001407 // All the overrides happen in the base module.
1408 // TODO(jungjw): Check the base module type.
1409}
1410
1411// override_android_test is used to create an android_app module based on another android_test by overriding
1412// some of its properties.
1413func OverrideAndroidTestModuleFactory() android.Module {
1414 m := &OverrideAndroidTest{}
1415 m.AddProperties(&overridableAppProperties{})
1416 m.AddProperties(&appTestProperties{})
1417
1418 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1419 android.InitOverrideModule(m)
1420 return m
1421}
1422
Colin Cross50ddcc42019-05-16 12:28:22 -07001423type UsesLibraryProperties struct {
1424 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file.
1425 Uses_libs []string
1426
1427 // A list of shared library modules that will be listed in uses-library tags in the AndroidManifest.xml file with
1428 // required=false.
1429 Optional_uses_libs []string
1430
1431 // If true, the list of uses_libs and optional_uses_libs modules must match the AndroidManifest.xml file. Defaults
1432 // to true if either uses_libs or optional_uses_libs is set. Will unconditionally default to true in the future.
1433 Enforce_uses_libs *bool
Ulya Trafimovich21a73752020-09-01 17:33:48 +01001434
Ulya Trafimovich54027b52020-09-09 14:08:23 +01001435 // Optional name of the <uses-library> provided by this module. This is needed for non-SDK
1436 // libraries, because SDK ones are automatically picked up by Soong. The <uses-library> name
1437 // normally is the same as the module name, but there are exceptions.
1438 Provides_uses_lib *string
Paul Duffin06530572022-02-03 17:54:15 +00001439
1440 // A list of shared library names to exclude from the classpath of the APK. Adding a library here
1441 // will prevent it from being used when precompiling the APK and prevent it from being implicitly
1442 // added to the APK's manifest's <uses-library> elements.
1443 //
1444 // Care must be taken when using this as it could result in runtime errors if the APK actually
1445 // uses classes provided by the library and which are not provided in any other way.
1446 //
1447 // This is primarily intended for use by various CTS tests that check the runtime handling of the
1448 // android.test.base shared library (and related libraries) but which depend on some common
1449 // libraries that depend on the android.test.base library. Without this those tests will end up
1450 // with a <uses-library android:name="android.test.base"/> in their manifest which would either
1451 // render the tests worthless (as they would be testing the wrong behavior), or would break the
1452 // test altogether by providing access to classes that the tests were not expecting. Those tests
1453 // provide the android.test.base statically and use jarjar to rename them so they do not collide
1454 // with the classes provided by the android.test.base library.
1455 Exclude_uses_libs []string
Colin Cross50ddcc42019-05-16 12:28:22 -07001456}
1457
1458// usesLibrary provides properties and helper functions for AndroidApp and AndroidAppImport to verify that the
1459// <uses-library> tags that end up in the manifest of an APK match the ones known to the build system through the
1460// uses_libs and optional_uses_libs properties. The build system's values are used by dexpreopt to preopt apps
1461// with knowledge of their shared libraries.
1462type usesLibrary struct {
1463 usesLibraryProperties UsesLibraryProperties
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001464
1465 // Whether to enforce verify_uses_library check.
1466 enforce bool
Colin Cross50ddcc42019-05-16 12:28:22 -07001467}
1468
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001469func (u *usesLibrary) addLib(lib string, optional bool) {
1470 if !android.InList(lib, u.usesLibraryProperties.Uses_libs) && !android.InList(lib, u.usesLibraryProperties.Optional_uses_libs) {
1471 if optional {
1472 u.usesLibraryProperties.Optional_uses_libs = append(u.usesLibraryProperties.Optional_uses_libs, lib)
1473 } else {
1474 u.usesLibraryProperties.Uses_libs = append(u.usesLibraryProperties.Uses_libs, lib)
1475 }
1476 }
1477}
1478
Colin Cross4a80a152022-12-21 21:51:52 -08001479func (u *usesLibrary) deps(ctx android.BottomUpMutatorContext, addCompatDeps bool) {
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001480 if !ctx.Config().UnbundledBuild() || ctx.Config().UnbundledBuildImage() {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001481 ctx.AddVariationDependencies(nil, usesLibReqTag, u.usesLibraryProperties.Uses_libs...)
1482 ctx.AddVariationDependencies(nil, usesLibOptTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross4a80a152022-12-21 21:51:52 -08001483 // Only add these extra dependencies if the module is an app that depends on framework
1484 // libs. This avoids creating a cyclic dependency:
Paul Duffin250e6192019-06-07 10:44:37 +01001485 // e.g. framework-res -> org.apache.http.legacy -> ... -> framework-res.
Colin Cross4a80a152022-12-21 21:51:52 -08001486 if addCompatDeps {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001487 // Dexpreopt needs paths to the dex jars of these libraries in order to construct
1488 // class loader context for dex2oat. Add them as a dependency with a special tag.
1489 ctx.AddVariationDependencies(nil, usesLibCompat29ReqTag, dexpreopt.CompatUsesLibs29...)
1490 ctx.AddVariationDependencies(nil, usesLibCompat28OptTag, dexpreopt.OptionalCompatUsesLibs28...)
1491 ctx.AddVariationDependencies(nil, usesLibCompat30OptTag, dexpreopt.OptionalCompatUsesLibs30...)
Colin Cross3245b2c2019-06-07 13:18:09 -07001492 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001493 } else {
1494 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.usesLibraryProperties.Uses_libs...)
1495 ctx.AddVariationDependencies(nil, r8LibraryJarTag, u.presentOptionalUsesLibs(ctx)...)
Colin Cross50ddcc42019-05-16 12:28:22 -07001496 }
1497}
1498
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001499// presentOptionalUsesLibs returns optional_uses_libs after filtering out libraries that don't exist in the source tree.
Colin Cross50ddcc42019-05-16 12:28:22 -07001500func (u *usesLibrary) presentOptionalUsesLibs(ctx android.BaseModuleContext) []string {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001501 optionalUsesLibs := android.FilterListPred(u.usesLibraryProperties.Optional_uses_libs, func(s string) bool {
1502 exists := ctx.OtherModuleExists(s)
Jiakai Zhang48203e32023-06-02 23:42:21 +01001503 if !exists && !android.InList(ctx.ModuleName(), ctx.Config().BuildWarningBadOptionalUsesLibsAllowlist()) {
Jiakai Zhang4f65a032023-06-01 15:16:58 +01001504 fmt.Printf("Warning: Module '%s' depends on non-existing optional_uses_libs '%s'\n", ctx.ModuleName(), s)
1505 }
1506 return exists
1507 })
Colin Cross50ddcc42019-05-16 12:28:22 -07001508 return optionalUsesLibs
1509}
1510
Ulya Trafimovicheea486a2021-02-26 11:38:21 +00001511// Helper function to replace string in a list.
1512func replaceInList(list []string, oldstr, newstr string) {
1513 for i, str := range list {
1514 if str == oldstr {
1515 list[i] = newstr
1516 }
1517 }
1518}
1519
Ulya Trafimovich24446712021-07-15 14:59:34 +01001520// Returns a map of module names of shared library dependencies to the paths to their dex jars on
1521// host and on device.
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001522func (u *usesLibrary) classLoaderContextForUsesLibDeps(ctx android.ModuleContext) dexpreopt.ClassLoaderContextMap {
1523 clcMap := make(dexpreopt.ClassLoaderContextMap)
Ulya Trafimovich24446712021-07-15 14:59:34 +01001524
1525 // Skip when UnbundledBuild() is true, but UnbundledBuildImage() is false. With
1526 // UnbundledBuildImage() it is necessary to generate dexpreopt.config for post-dexpreopting.
1527 if ctx.Config().UnbundledBuild() && !ctx.Config().UnbundledBuildImage() {
1528 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001529 }
1530
Ulya Trafimovich24446712021-07-15 14:59:34 +01001531 ctx.VisitDirectDeps(func(m android.Module) {
1532 tag, isUsesLibTag := ctx.OtherModuleDependencyTag(m).(usesLibraryDependencyTag)
1533 if !isUsesLibTag {
1534 return
1535 }
1536
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001537 dep := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(m))
Ulya Trafimovich24446712021-07-15 14:59:34 +01001538
Ulya Trafimovich840efb62021-07-15 14:34:40 +01001539 // Skip stub libraries. A dependency on the implementation library has been added earlier,
1540 // so it will be added to CLC, but the stub shouldn't be. Stub libraries can be distingushed
1541 // from implementation libraries by their name, which is different as it has a suffix.
1542 if comp, ok := m.(SdkLibraryComponentDependency); ok {
1543 if impl := comp.OptionalSdkLibraryImplementation(); impl != nil && *impl != dep {
1544 return
1545 }
1546 }
1547
Ulya Trafimovich24446712021-07-15 14:59:34 +01001548 if lib, ok := m.(UsesLibraryDependency); ok {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001549 libName := dep
Ulya Trafimovich24446712021-07-15 14:59:34 +01001550 if ulib, ok := m.(ProvidesUsesLib); ok && ulib.ProvidesUsesLib() != nil {
Ulya Trafimoviche14f80b2021-07-15 15:05:48 +01001551 libName = *ulib.ProvidesUsesLib()
Ulya Trafimovich24446712021-07-15 14:59:34 +01001552 // Replace module name with library name in `uses_libs`/`optional_uses_libs` in
1553 // order to pass verify_uses_libraries check (which compares these properties
1554 // against library names written in the manifest).
1555 replaceInList(u.usesLibraryProperties.Uses_libs, dep, libName)
1556 replaceInList(u.usesLibraryProperties.Optional_uses_libs, dep, libName)
1557 }
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01001558 clcMap.AddContext(ctx, tag.sdkVersion, libName, tag.optional,
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001559 lib.DexJarBuildPath().PathOrNil(), lib.DexJarInstallPath(),
1560 lib.ClassLoaderContexts())
Ulya Trafimovich24446712021-07-15 14:59:34 +01001561 } else if ctx.Config().AllowMissingDependencies() {
1562 ctx.AddMissingDependencies([]string{dep})
1563 } else {
1564 ctx.ModuleErrorf("module %q in uses_libs or optional_uses_libs must be a java library", dep)
1565 }
1566 })
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +00001567 return clcMap
Colin Cross50ddcc42019-05-16 12:28:22 -07001568}
1569
1570// enforceUsesLibraries returns true of <uses-library> tags should be checked against uses_libs and optional_uses_libs
1571// properties. Defaults to true if either of uses_libs or optional_uses_libs is specified. Will default to true
1572// unconditionally in the future.
1573func (u *usesLibrary) enforceUsesLibraries() bool {
1574 defaultEnforceUsesLibs := len(u.usesLibraryProperties.Uses_libs) > 0 ||
1575 len(u.usesLibraryProperties.Optional_uses_libs) > 0
Ulya Trafimovich22890c42021-01-05 12:04:17 +00001576 return BoolDefault(u.usesLibraryProperties.Enforce_uses_libs, u.enforce || defaultEnforceUsesLibs)
Colin Cross50ddcc42019-05-16 12:28:22 -07001577}
1578
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +01001579// Freeze the value of `enforce_uses_libs` based on the current values of `uses_libs` and `optional_uses_libs`.
1580func (u *usesLibrary) freezeEnforceUsesLibraries() {
1581 enforce := u.enforceUsesLibraries()
1582 u.usesLibraryProperties.Enforce_uses_libs = &enforce
1583}
1584
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001585// verifyUsesLibraries checks the <uses-library> tags in the manifest against the ones specified
1586// in the `uses_libs`/`optional_uses_libs` properties. The input can be either an XML manifest, or
1587// an APK with the manifest embedded in it (manifest_check will know which one it is by the file
1588// extension: APKs are supposed to end with '.apk').
1589func (u *usesLibrary) verifyUsesLibraries(ctx android.ModuleContext, inputFile android.Path,
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001590 outputFile android.WritablePath) android.Path {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001591
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001592 statusFile := dexpreopt.UsesLibrariesStatusFile(ctx)
Colin Cross50ddcc42019-05-16 12:28:22 -07001593
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001594 // Disable verify_uses_libraries check if dexpreopt is globally disabled. Without dexpreopt the
1595 // check is not necessary, and although it is good to have, it is difficult to maintain on
1596 // non-linux build platforms where dexpreopt is generally disabled (the check may fail due to
1597 // various unrelated reasons, such as a failure to get manifest from an APK).
Ulya Trafimovich39dd0a42021-03-29 14:57:34 +01001598 global := dexpreopt.GetGlobalConfig(ctx)
1599 if global.DisablePreopt || global.OnlyPreoptBootImageAndSystemServer {
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001600 return inputFile
Ulya Trafimovich6e55ef12021-03-04 12:37:50 +00001601 }
1602
Colin Crossf1a035e2020-11-16 17:32:30 -08001603 rule := android.NewRuleBuilder(pctx, ctx)
1604 cmd := rule.Command().BuiltTool("manifest_check").
Colin Cross50ddcc42019-05-16 12:28:22 -07001605 Flag("--enforce-uses-libraries").
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001606 Input(inputFile).
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001607 FlagWithOutput("--enforce-uses-libraries-status ", statusFile).
Saeid Farivar Asanjanfd27c7c2022-08-08 20:21:26 +00001608 FlagWithInput("--aapt ", ctx.Config().HostToolPath(ctx, "aapt2"))
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001609
1610 if outputFile != nil {
1611 cmd.FlagWithOutput("-o ", outputFile)
1612 }
Colin Cross50ddcc42019-05-16 12:28:22 -07001613
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +00001614 if dexpreopt.GetGlobalConfig(ctx).RelaxUsesLibraryCheck {
1615 cmd.Flag("--enforce-uses-libraries-relax")
1616 }
1617
Colin Cross50ddcc42019-05-16 12:28:22 -07001618 for _, lib := range u.usesLibraryProperties.Uses_libs {
1619 cmd.FlagWithArg("--uses-library ", lib)
1620 }
1621
1622 for _, lib := range u.usesLibraryProperties.Optional_uses_libs {
1623 cmd.FlagWithArg("--optional-uses-library ", lib)
1624 }
1625
Colin Crossf1a035e2020-11-16 17:32:30 -08001626 rule.Build("verify_uses_libraries", "verify <uses-library>")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001627 return outputFile
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001628}
Colin Cross50ddcc42019-05-16 12:28:22 -07001629
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001630// verifyUsesLibrariesManifest checks the <uses-library> tags in an AndroidManifest.xml against
1631// the build system and returns the path to a copy of the manifest.
1632func (u *usesLibrary) verifyUsesLibrariesManifest(ctx android.ModuleContext, manifest android.Path) android.Path {
1633 outputFile := android.PathForModuleOut(ctx, "manifest_check", "AndroidManifest.xml")
Ulya Trafimovicha76d6602021-03-16 15:34:50 +00001634 return u.verifyUsesLibraries(ctx, manifest, outputFile)
Colin Cross50ddcc42019-05-16 12:28:22 -07001635}
1636
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001637// verifyUsesLibrariesAPK checks the <uses-library> tags in the manifest of an APK against the build
1638// system and returns the path to a copy of the APK.
Cole Faust2f1da162023-04-17 15:06:56 -07001639func (u *usesLibrary) verifyUsesLibrariesAPK(ctx android.ModuleContext, apk android.Path) {
Ulya Trafimovich0aba2522021-03-03 16:38:37 +00001640 u.verifyUsesLibraries(ctx, apk, nil) // for APKs manifest_check does not write output file
Colin Cross50ddcc42019-05-16 12:28:22 -07001641}
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001642
1643// For Bazel / bp2build
1644
1645type bazelAndroidAppCertificateAttributes struct {
1646 Certificate string
1647}
1648
Chris Parsons637458d2023-09-19 20:09:00 +00001649func (m *AndroidAppCertificate) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001650 androidAppCertificateBp2Build(ctx, m)
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001651}
1652
Chris Parsons637458d2023-09-19 20:09:00 +00001653func androidAppCertificateBp2Build(ctx android.Bp2buildMutatorContext, module *AndroidAppCertificate) {
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001654 var certificate string
1655 if module.properties.Certificate != nil {
1656 certificate = *module.properties.Certificate
1657 }
1658
1659 attrs := &bazelAndroidAppCertificateAttributes{
1660 Certificate: certificate,
1661 }
1662
1663 props := bazel.BazelTargetModuleProperties{
1664 Rule_class: "android_app_certificate",
Alixa381cd12023-05-10 14:49:38 +00001665 Bzl_load_location: "//build/bazel/rules/android:android_app_certificate.bzl",
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001666 }
1667
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +00001668 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name()}, attrs)
Rupert Shuttleworth5c4881c2021-07-28 06:21:31 -04001669}
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001670
Alixe5085eb2023-01-31 19:38:41 +00001671type manifestValueAttribute struct {
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001672 MinSdkVersion *string
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001673 TargetSdkVersion *string
Alixe5085eb2023-01-31 19:38:41 +00001674}
1675
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001676type bazelAndroidAppAttributes struct {
Sam Delmericoc0161432022-02-25 21:34:51 +00001677 *javaCommonAttributes
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05001678 *bazelAapt
Sam Delmericoc0161432022-02-25 21:34:51 +00001679 Deps bazel.LabelListAttribute
Sam Delmerico9dfb1392022-02-10 21:11:59 +00001680 Custom_package *string
Jingwen Chen6817bbb2022-10-14 09:56:07 +00001681 Certificate bazel.LabelAttribute
1682 Certificate_name bazel.StringAttribute
Alixe5085eb2023-01-31 19:38:41 +00001683 Manifest_values *manifestValueAttribute
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001684 Optimize *bool
1685 Proguard_specs bazel.LabelListAttribute
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001686 Updatable *bool
Jingwen Chenbea58092022-09-29 16:56:02 +00001687}
1688
Alixee51bd62023-08-29 16:01:46 +00001689func (b bazelAapt) ConvertJavaResources(ctx android.Bp2buildMutatorContext, javaAttrs *javaCommonAttributes) bool {
1690 // TODO (b/300470246) bp2build support for java_resources & java_resource_dirs in android rules
1691 hasJavaResources := !javaAttrs.javaResourcesAttributes.Resources.IsEmpty()
1692 if hasJavaResources {
1693 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED, "(b/300470246) java resources in android_* module")
1694 }
1695 return hasJavaResources
1696}
1697
Chris Parsons637458d2023-09-19 20:09:00 +00001698func convertWithBp2build(ctx android.Bp2buildMutatorContext, a *AndroidApp) (bool, android.CommonAttributes, *bazelAndroidAppAttributes) {
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001699 aapt, supported := a.convertAaptAttrsWithBp2Build(ctx)
1700 if !supported {
Jingwen Chene12c0832023-08-25 09:00:16 +00001701 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
Romain Jobredeaux7a71e072023-08-16 17:39:12 -04001702 }
Spandan Das0e0a8802023-09-20 19:53:30 +00001703 if a.appProperties.Jni_uses_platform_apis != nil {
1704 ctx.MarkBp2buildUnconvertible(
1705 bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED,
1706 "TODO - b/299360988: Add bp2build support for jni_uses_platform_apis",
1707 )
1708 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1709 }
1710 if a.appProperties.Jni_uses_sdk_apis != nil {
1711 ctx.MarkBp2buildUnconvertible(
1712 bp2build_metrics_proto.UnconvertedReasonType_UNSUPPORTED,
1713 "TODO - b/299360988: Add bp2build support for jni_uses_sdk_apis",
1714 )
1715 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1716 }
1717
Jingwen Chen6817bbb2022-10-14 09:56:07 +00001718 certificate, certificateName := android.BazelStringOrLabelFromProp(ctx, a.overridableAppProperties.Certificate)
1719
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001720 manifestValues := &manifestValueAttribute{
1721 MinSdkVersion: a.deviceProperties.Min_sdk_version,
1722 TargetSdkVersion: a.deviceProperties.Target_sdk_version,
Romain Jobredeaux496660d2023-07-10 11:50:00 -04001723 }
1724
Alix0856f9e2023-01-20 22:15:30 +00001725 appAttrs := &bazelAndroidAppAttributes{
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001726 // TODO(b/209576404): handle package name override by product variable PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
Alix0856f9e2023-01-20 22:15:30 +00001727 Custom_package: a.overridableAppProperties.Package_name,
1728 Certificate: certificate,
1729 Certificate_name: certificateName,
Alixe5085eb2023-01-31 19:38:41 +00001730 Manifest_values: manifestValues,
Romain Jobredeaux3132f842023-09-15 10:06:16 -04001731 Updatable: a.appProperties.Updatable,
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001732 }
Sam Delmerico9dfb1392022-02-10 21:11:59 +00001733
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001734 // As framework-res has no sources, no deps in the Bazel sense, and java compilation, dexing and optimization is skipped by
1735 // Soong specifically for it, return early here before any of the conversion work for the above is attempted.
1736 if ctx.ModuleName() == "framework-res" {
1737 appAttrs.bazelAapt = aapt
1738 return true, android.CommonAttributes{Name: a.Name(), SkipData: proptools.BoolPtr(true)}, appAttrs
1739 }
1740
Jingwen Chen65229202023-09-20 13:34:16 +00001741 // Optimization is..
1742 // - enabled by default for android_app, android_test_helper_app
1743 // - disabled by default for android_test
1744 //
1745 // TODO(b/192032291): Disable android_test_helper_app optimization by
1746 // default after auditing downstream usage.
Jingwen Chen256c3892023-09-26 05:51:40 +00001747 if a.dexProperties.Optimize.EnabledByDefault != a.dexer.effectiveOptimizeEnabled() {
1748 // Property is explicitly defined by default from default, so emit the Bazel attribute.
1749 appAttrs.Optimize = proptools.BoolPtr(a.dexer.effectiveOptimizeEnabled())
Jingwen Chen65229202023-09-20 13:34:16 +00001750 }
Jingwen Chen65229202023-09-20 13:34:16 +00001751
Jingwen Chen256c3892023-09-26 05:51:40 +00001752 if a.dexer.effectiveOptimizeEnabled() {
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001753 handCraftedFlags := ""
1754 if Bool(a.dexProperties.Optimize.Ignore_warnings) {
1755 handCraftedFlags += "-ignorewarning "
1756 }
1757 if !Bool(a.dexProperties.Optimize.Shrink) {
1758 handCraftedFlags += "-dontshrink "
1759 }
1760 if !Bool(a.dexProperties.Optimize.Optimize) {
1761 handCraftedFlags += "-dontoptimize "
1762 }
1763 if !Bool(a.dexProperties.Optimize.Obfuscate) {
1764 handCraftedFlags += "-dontobfuscate "
1765 }
1766 appAttrs.Proguard_specs = bazel.MakeLabelListAttribute(android.BazelLabelForModuleSrc(ctx, a.dexProperties.Optimize.Proguard_flags_files))
1767 if handCraftedFlags != "" {
1768 generatedFlagFileRuleName := a.Name() + "_proguard_flags"
1769 ctx.CreateBazelTargetModule(bazel.BazelTargetModuleProperties{
1770 Rule_class: "genrule",
1771 }, android.CommonAttributes{
1772 Name: generatedFlagFileRuleName,
1773 SkipData: proptools.BoolPtr(true),
1774 }, &genrule.BazelGenruleAttributes{
1775 Outs: []string{a.Name() + "_proguard.flags"},
1776 Cmd: bazel.StringAttribute{
1777 Value: proptools.StringPtr("echo " + handCraftedFlags + "> $(OUTS)"),
1778 },
1779 })
1780 appAttrs.Proguard_specs.Add(bazel.MakeLabelAttribute(":" + generatedFlagFileRuleName))
1781 }
Romain Jobredeaux9973ace2023-08-30 00:27:09 -04001782 }
1783
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001784 commonAttrs, bp2BuildInfo, supported := a.convertLibraryAttrsBp2Build(ctx)
1785 if !supported {
Jingwen Chene12c0832023-08-25 09:00:16 +00001786 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001787 }
Alixee51bd62023-08-29 16:01:46 +00001788 if hasJavaResources := aapt.ConvertJavaResources(ctx, commonAttrs); hasJavaResources {
1789 return false, android.CommonAttributes{}, &bazelAndroidAppAttributes{}
1790 }
1791
Romain Jobredeauxd2cc5032023-09-11 16:37:50 -04001792 depLabels := bp2BuildInfo.DepLabels
1793
1794 deps := depLabels.Deps
1795 deps.Append(depLabels.StaticDeps)
1796
Romain Jobredeaux947dfa72023-06-12 15:40:35 -04001797 var jniDeps bazel.LabelListAttribute
1798 archVariantProps := a.GetArchVariantProperties(ctx, &appProperties{})
1799 for axis, configToProps := range archVariantProps {
1800 for config, _props := range configToProps {
1801 if archProps, ok := _props.(*appProperties); ok {
1802 archJniLibs := android.BazelLabelForModuleDeps(
1803 ctx,
1804 android.LastUniqueStrings(android.CopyOf(archProps.Jni_libs)))
1805 jniDeps.SetSelectValue(axis, config, archJniLibs)
1806 }
1807 }
1808 }
1809 deps.Append(jniDeps)
1810
Alix75db7842023-03-06 22:08:49 +00001811 if !bp2BuildInfo.hasKotlin {
Alix0856f9e2023-01-20 22:15:30 +00001812 appAttrs.javaCommonAttributes = commonAttrs
1813 appAttrs.bazelAapt = aapt
1814 appAttrs.Deps = deps
Alix0856f9e2023-01-20 22:15:30 +00001815 } else {
1816 ktName := a.Name() + "_kt"
Alix0856f9e2023-01-20 22:15:30 +00001817 ctx.CreateBazelTargetModule(
Alix32540022023-03-16 21:06:13 +00001818 AndroidLibraryBazelTargetModuleProperties(),
Alix0856f9e2023-01-20 22:15:30 +00001819 android.CommonAttributes{Name: ktName},
1820 &bazelAndroidLibrary{
1821 javaLibraryAttributes: &javaLibraryAttributes{
1822 javaCommonAttributes: commonAttrs,
1823 Deps: deps,
1824 },
1825 bazelAapt: aapt,
1826 },
1827 )
1828
1829 appAttrs.bazelAapt = &bazelAapt{Manifest: aapt.Manifest}
1830 appAttrs.Deps = bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + ktName})
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05001831 appAttrs.javaCommonAttributes = &javaCommonAttributes{
1832 Sdk_version: commonAttrs.Sdk_version,
1833 }
Alix0856f9e2023-01-20 22:15:30 +00001834 }
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001835
Jingwen Chene12c0832023-08-25 09:00:16 +00001836 return true, android.CommonAttributes{Name: a.Name(), SkipData: proptools.BoolPtr(true)}, appAttrs
1837}
1838
1839// ConvertWithBp2build is used to convert android_app to Bazel.
Chris Parsons637458d2023-09-19 20:09:00 +00001840func (a *AndroidApp) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jingwen Chene12c0832023-08-25 09:00:16 +00001841 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, a); ok {
Romain Jobredeaux9c06ef32023-08-21 18:05:29 -04001842 var props bazel.BazelTargetModuleProperties
1843 if ctx.ModuleName() == "framework-res" {
1844 props = bazel.BazelTargetModuleProperties{
1845 Rule_class: "framework_resources",
1846 Bzl_load_location: "//build/bazel/rules/android:framework_resources.bzl",
1847 }
1848 } else {
1849 props = bazel.BazelTargetModuleProperties{
1850 Rule_class: "android_binary",
1851 Bzl_load_location: "//build/bazel/rules/android:android_binary.bzl",
1852 }
Jingwen Chene12c0832023-08-25 09:00:16 +00001853 }
Jingwen Chene12c0832023-08-25 09:00:16 +00001854 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1855 }
1856
1857}
1858
1859// ConvertWithBp2build is used to convert android_test to Bazel.
Chris Parsons637458d2023-09-19 20:09:00 +00001860func (at *AndroidTest) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
Jingwen Chene12c0832023-08-25 09:00:16 +00001861 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, &at.AndroidApp); ok {
1862 props := bazel.BazelTargetModuleProperties{
1863 Rule_class: "android_test",
1864 Bzl_load_location: "//build/bazel/rules/android:android_test.bzl",
1865 }
1866
1867 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1868 }
Alix733110e2023-02-06 14:53:10 +00001869
Romain Jobredeaux1282c422021-10-29 10:52:59 -04001870}
Jingwen Chen65289992023-09-21 15:15:47 +00001871
1872func (atha *AndroidTestHelperApp) ConvertWithBp2build(ctx android.Bp2buildMutatorContext) {
1873 if ok, commonAttrs, appAttrs := convertWithBp2build(ctx, &atha.AndroidApp); ok {
1874 // an android_test_helper_app is an android_binary with testonly = True
1875 commonAttrs.Testonly = proptools.BoolPtr(true)
1876
Jingwen Chen65229202023-09-20 13:34:16 +00001877 // android_test_helper_app sets default values differently to android_app,
Jingwen Chen65289992023-09-21 15:15:47 +00001878 // https://cs.android.com/android/platform/superproject/main/+/main:build/soong/java/app.go;l=1273-1279;drc=e12c083198403ec694af6c625aed11327eb2bf7f
1879 //
1880 // installable: true (settable prop)
1881 // use_embedded_native_libs: true (settable prop)
1882 // lint.test: true (settable prop)
Jingwen Chen65289992023-09-21 15:15:47 +00001883 // AlwaysPackageNativeLibs: true (blueprint mutated prop)
1884 // dexpreopt isTest: true (not prop)
1885
1886 props := bazel.BazelTargetModuleProperties{
1887 Rule_class: "android_binary",
1888 Bzl_load_location: "//build/bazel/rules/android:android_binary.bzl",
1889 }
1890
1891 ctx.CreateBazelTargetModule(props, commonAttrs, appAttrs)
1892 }
1893}